Menu Close
    Hire Us Request Quote Reading List Switch to Dark Mode

    Multivendor Marketplace for Shopify: Multi-vendor API

    Here we are with the Multivendor Marketplace app for Shopify: Multi-vendor API.

    API stands for Application programming interface which is a set of tools and protocols that will help you building sync and much more.

    Till now, you were using the API Version 1 to allow users to access the Multi-vendor APIs in Multi-vendor Marketplace app for Shopify. Now, we have introduced the Multi-vendor API Version 2. With this upgraded version, you can allow the sellers to get access to Multi-vendor APIs and let them check the responses for various actions performed in the app.

    You have to enable this API feature from the feature app section so that you can access the API. Moreover, this feature will have additional charges of USD15 per month over and above your current multivendor plan.

    Let’s understand this in detail.

    ENABLE API FEATURE

    To enable the API feature you will have to visit features app section of the app. Find this app in the Multivendor Marketplace feature app section. You have to enable this API feature from the featured app section so that you can access the API. Besides that, this will have additional charges of USD15 per month over and above your current multivendor plan.

    Click the ENABLE button to activate the Multi-vendor API feature app.

    Features of Multi-vendor API Version 2

    • 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.

    Please Note:- With the upgraded Multi-vendor API version 2, You can allow both Users & sellers to access the API with desired permissions. So, the provided API credentials will work separately for both of them i.e. User will have the permission to access admin’s data while the sellers will be permitted to access their own seller panel data.  It’s all depends on the assigned permissions.

    API Doc

    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

    How to Add Users?

    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.

    How to Allow Sellers to Get Access to 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 Product 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 Changes” button to get a new access token.

    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.

    How to check the response?

    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.
    • 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.

    Support

    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!!! 🙂

    . . .

    Comment

    Add Your Comment

    Be the first to comment.

    Back to Top
    css.php
    Hire Us!
    Brief us about your requirements and we'll get back to you.
    Woo! Hooy!
    We have just recieved your project brief and our expert will contact you shortly.
    Send Again
    Close

    Table of Content

    Hide Index