Web API Marketplace Add-on

Note- This module is an add-on of Webkul's Marketplace Module. To use this module, you must have purchased and installed Multi-Vendor Marketplace first.

Over the years, web APIs have broadened the range of the interface application which will use your web API and fetch information. Basically, web services let your Magento store integrate with external systems.

Using Web Service API Marketplace add-on, you can expose your marketplace functions as web services. The marketplace functions will be accessible to other application through web services using the Rest API. The add-on allows the web services API of the marketplace module with Rest API to use marketplace functions in other applications. Using Web Services API, you can call the functions of the marketplace from any third party platform like ERP, Mobile application (iOS, Windows, etc).

Use Case:

Suppose a person wants to use marketplace functions on mobile as well as on the ERP. And that person don’t know how to do it. Now here, our module comes into the picture and plays a major role. That person can use our Web Services API Marketplace Add-on. Because Web Service API Marketplace add-on let your Magento 2 Marketplace interact and access the marketplace functions on both the mobile and the ERP too. This makes the data and information accessibility more flexible. 

Features:

• Standard REST API support found.
• This module exposes several marketplace resources to web API including   become sellers, get sellers list, invoice, credit memo, cancel seller orders, landing page data and many more.
• The admin and customer level authentication for resources.
• Search criteria for seller list and seller’s order.
• The consumer can authenticate by any of these methods token, OAuth or session.
• JSON format return can be used in mobile and ERP devices. 
• Using this add-on marketplace can be managed very easily from other applications as well.

Work-Flow:

Install the module first. Then, connect your application to your marketplace host where this module is installed. Now, login to your server using the username and password.  

After the successful connection, use and call Marketplace Web Service API methods from your application-

• Admin Api Calls:
   

magentohost*1/rest/V1/mpapi/admin/sellers?searchCriteria

magentohost*1/rest/V1/mpapi/admin/sellers/:id

magentohost*1/rest/V1/mpapi/admin/sellers/:id/product

magentohost*1/rest/V1/mpapi/admin/sellers/:id/order?

magentohost*1/rest/V1/mpapi/admin/sellers/:id/order/sales

magentohost*1/rest/V1/mpapi/admin/sellers/:id/paytoseller

magentohost*1/rest/V1/mpapi/admin/sellers/:sellerId/assign

magentohost*1/rest/V1/mpapi/admin/sellers/:sellerId/unassign

• Seller Api Calls:
   

magentohost*1/rest/V1/mpapi/sellers/me

magentohost*1/rest/V1/mpapi/sellers/me/product

magentohost*1/rest/V1/mpapi/sellers/me/order?searchCriteria

magentohost*1/rest/V1/mpapi/sellers/me/order/sales

magentohost*1/rest/V1/mpapi/sellers/me/order/:orderId/invoice

magentohost*1/rest/V1/mpapi/sellers/me/order/:orderId/cancel

magentohost*1/rest/V1/mpapi/sellers/me/order/:orderId/invoice/:invoiceId/creditmemo

magentohost*1/rest/V1/mpapi/sellers/me/order/:orderId/creditmemo/:creditmemoId

magentohost*1/rest/V1/mpapi/sellers/me/mailtoadmin

magentohost*1/rest/V1/mpapi/sellers/me/mailtoseller

magentohost*1/rest/V1/mpapi/sellers/me/becomepartner

magentohost*1/rest/V1/mpapi/sellers/me/order/:orderId/ship

• Guest User Accessible Resources:
   

magentohost*1/rest/V1/mpapi/marketplace

magentohost*1/rest/V1/mpapi/sellers?searchCriteria

magentohost*1/rest/V1/mpapi/sellers/:id/reviews

magentohost*1/rest/V1/mpapi/sellers/:review_id/review

The admin will have various menu options in the admin panel to configure the module settings and provide access to the user. And every user will have their own unique keys & Secret keys. For this, the admin will enter the user details like name, email, callback URL, current admin password etc. And the keys will be system generated.  Then, the admin will select the resources to give access to the new admin member.

Benefits:

• Offer marketplace functions on all the applications.
• To open a new avenue for increasing the Sales.
• Providing flexibility and ease of connectivity in learning about customers.