Powered by Adobe Commerce 2.4.6-p4

ezgif.com-webp-to-png1.png

Web API Marketplace Add-on

PRODUCT:
0
TOTAL:

Overview

Back to top

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.

Technical Specifications

Back to top

Seller profile

Webkul Software Private Limited

Seller contact

E-mail

Current Version

4.1.1

Adobe Commerce platform compatibility

Adobe Commerce (cloud): 2.4 (current)

Adobe Commerce (on-prem): 2.4 (current)

Magento Open Source: 2.4 (current), 2.2 (obsolete)

Type

Stable Build

Updated

05 October, 2023

Categories

Extensions, Content & Customizations, Personalization & Experience Management

Supported Browsers

Chrome, Firefox, Safari, Edge, IE

Quality Report

Back to top

Installation & Varnish Tests

Passed

Coding Standard

Passed

Plagiarism Check

Passed

Malware Check

Passed

Marketing Review

Passed

Manual Testing

Passed

All tests were conducted on the latest versions of Adobe Commerce that existed for the compatible release lines at the moment of the extension submission. Latest versions of all other software were used, as applicable.

Release Notes

Back to top

5.1.1:

  • Compatible with Magento Open Source : 2.4
  • Stability: Stable Build
  • Description:

    + Compatible with Magento 2.4.* CE
    + Added new REST APIs (Save Seller Profile, Delete Seller Product,
    Seller Details by Product SKU, Report Seller & Product, Upload Image & Create Seller Account)
    + Added New GraphQL APIs (Get Seller Details by Product SKU, Report Seller & Product,
    Create Seller Account, Upload Image, Make Seller Review, Seller Add Product, Save Seller Profile,
    Delete Seller Product)
    + Optimized landing page data API
    + Added seller id filter in product graphql api
    - Fixed seller validations issues
    - Fixed coding standard issues

5.1.0:

  • Compatible with Magento Open Source : 2.4
  • Stability: Stable Build
  • Description:

    + Added search criteria for seller orders.
    + Fixed product image upload issues.
    - Fixed shipment issues.

4.1.1:

  • Compatible with Adobe Commerce (cloud) : 2.4
  • Compatible with Adobe Commerce (on-prem) : 2.4
  • Stability: Stable Build
  • Description:

    + Compatible with Magento 2.4.* EE
    + Added new REST APIs (Save Seller Profile, Delete Seller Product,
    Seller Details by Product SKU, Report Seller & Product, Upload Image & Create Seller Account)
    + Added New GraphQL APIs (Get Seller Details by Product SKU, Report Seller & Product,
    Create Seller Account, Upload Image, Make Seller Review, Seller Add Product, Save Seller Profile,
    Delete Seller Product)
    + Optimized landing page data API
    - Fixed seller validations issues
    - Fixed coding standard issues

4.1.0:

  • Compatible with Adobe Commerce (cloud) : 2.4
  • Compatible with Adobe Commerce (on-prem) : 2.4
  • Stability: Stable Build
  • Description:

    + Added search criteria for seller orders
    + Added product image upload
    - Fixed shipment issues

2.0.3:

  • Compatible with Magento Open Source : 2.2
  • Stability: Stable Build
  • Description:

    release notes
    -------------------------------- Version 2.0.3 -------------------------------------
    + create sellers api from frontend

    -------------------------------- Version 2.0.2 --------------------------------------
    + seller list api with search criteria from both ends.
    + seller's orders api with search criteria from both ends.

    -------------------------------- Version 2.0.1 --------------------------------------

    + compatible with magento ver 2.2.x and marketplace ver 2.1.x

    -------------------------------- Version 2.0.0 --------------------------------------

    + added assign and unassign product to seller by admin api
    + added create shipment api.
    + this module exposes sevral marketplace resources
    + exposes resource to become sellers
    + exposes resource to get sellers
    + exposes resource to invoice, creditmemo, cancel seller orders
    + exposes ask admin and contact seller resources.
    + exposes marketplace landing page data
    + admin and customer level authentication for resorces.
    + consumer can authenticate by any of these methods token, oAuth or session.

Support

Back to top

The best place to start if you need help with a specific extension is to contact the developer. All Adobe Commerce developers have both a contact email and a support email listed.

Contact Vendor

Q & A

Back to top

Reviews

Back to top