Multivendor Marketplace for Shopify: Multi-vendor API

• Admin can add multiple users and generate API credentials to let them access Multi-vendor API for version 2.
• Admin can assign permissions to users for various resources such as Products, Orders & Account Info.
• From the Seller Listing section, admin can generate API credentials for the sellers.
• Sellers will get the access token & refresh token from their respective “My Account” sections.
• After that, the seller will get access to the Multi-vendor API for the permitted fields.

Multi-vendor API Doc will be provided to the admin in the app.

API Doc includes all the URLs listed in POST, GET, PUT & DELETE method.

POST Method of the API is where developers can interface with other API or system to get the desired outcome. It is more often utilized to create new resources.

GET Method of API is to read or retrieve a representation of a resource or information.

PUT Method of the API is where developers can interface with other API or system to get the desired outcome. It is more often utilized to update existing resources.

DELETE Method of API is to delete resources from the database.

Base URL: https://mvmapi.webkul.com

As soon as you enable the Multi-vendor API feature app, the Multi-vendor API menu gets reflected in the side menu of the admin panel.

Clicking this button, You will be redirected to the API Credentials section. Just click the “Add User” button & fill the details to add users & assign permissions to them.

Clicking the Add User button, you need to fill the User details such as User name, user email, and password.

Now, click the Continue button to set the resource permission for the API. Click the checkboxes to assign permission to the users for various resources.

Now, click the Save button to save the settings.

This way, you can add user & assign certain permissions to let him/her access the Multi-vendor API. You can anytime disable or revoke the user as per the requirement.

Now, let’s see how the marketplace sellers will get access to multi-vendor APIs.

ADMIN PANEL

With this new API Version 2, You can allow sellers to get the API credentials & let them access Multi-vendor APIs with limited permissions.

You need to follow the below-given steps:-

• Visit the Sellers section of the Multi-vendor app.
• Click the Seller Listing menu.
• Select the seller to which you want to permit the API access.

• Visiting the Edit Seller section of the app, scroll down to the bottom to get the option to Generate API credentials for your sellers. Click the Generate API Credentials button & generate the tokens to access the APIs.

As soon as the admin clicks the Generate API credentials button, a pop-up appears and you will be asked to set resource permissions for your sellers. Enable the checkbox to assign permission.

Clicking the Save button, a unique access token gets generated for the seller that will reflect at the seller side too. Now, once you generate the credentials & enable the checkbox “Send Notification to Seller“, the sellers will receive an email regarding the same.

Later if required, admin can update the token. He needs to click the “Update Permissions” button and then, click the “Save” button to get a new access token.

Now, click the SAVE button.

POINT TO BE NOTED

Once you update the permission and click the Save Changes button, a new access token gets generated. So, make sure that you have checked the checkbox “Send Notification to Seller” to send an automatic mail to notifiy the seller about the new update.

You will have the option to configure the email from the “Mail Configuration” menu of the app.

This way, you can generate API credentials for the sellers.

SELLER PANEL

To get the API credentials, the seller needs to visit his “My Account” section of his/her seller panel. 

In the My Account section, the seller will get the API credentials. 

Now, the seller will get the Multi-vendor API access to check the response of certain actions. 

IMPORTANT NOTE

Access Token Validity:-

The unique access token will be valid for
1 YEAR for the Users
30 DAYS for the sellers.

Refresh Token Validity:-

The refresh token will be valid for
2 YEARS for both Users & Sellers.

With the help of the provided API credentials, both user and seller can check the responses of specific actions performed in the app like this:-

Once you provide the API DOC to the seller or user, they can check the responses using the provided API credentials.

For this, both User and Seller needs to follow the below-given steps:-

• Open the API Doc.
• Click the Authorize button.

• Clicking the Authorize button, get the option to enter the value as Bearer {access_token} and click the Authorize button.
  NOTE: The value that needs to be entered in the box: Bearer {access_token}. You need to add ‘Bearer’ prior to the access token. Here is an example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9

• Click the Done button.

• Now, the seller/user will open any of the resources to check the response.

• Click the Try it out button to check the action.

• Lastly, click the Execute button.

This way, the seller/user can get the response for different actions performed in the app.

That’s all about the Multi-vendor API feature app.

https://multivendor-marketplace-4.myshopify.com/pages/demo

In case of any kind of support/Consultancy then please raise a ticket at http://webkul.uvdesk.com/ or drop a mail at support@webkul.com

Thanks for reading this blog!!! 🙂