Web Services API Marketplace Add-On

Web Services API Marketplace Add-On

Compatible With: Community 1.6, 1.6.1,, 1.7, 1.8, 1.8.1, 1.9, 1.9.1, 1.9.2, 1.9.3

Tech Specifications

Current Version:
Stable Build
30 November, 2017
Extensions, Sales, Marketplace Feeds
License Type:


This module shares marketplace functions with the other modern device apps. Functions will be accessible to other application through the web services using API.

Other Extensions by WebKul SoftWare Private Limited


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.

This extension allows you to expose your module functions as web services. This means functions will be accessible to other application through web services using the API. Webkul's Web Services Marketplace Add-on allows the web services API of the marketplace module with SOAP 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 of Web Services API Marketplace Add-On -

Suppose a person wants to use marketplace functions on mobile as well as on the ERP. And that person is not having any idea about how to do it and use it. Now here, our module plays a major role. That person can use our Web Services API Marketplace Add-on. And can access the marketplace functions on both the mobile and the ERP too.

Features of Web Services API Marketplace Add-On -

  • Standard Magento web services API extended.

  • Standard  SOAP V1, SOAP V2 API and REST API support found.

  • JSON  format return can be used in mobile and ERP devices including openERP. 

  • Extend all Magento marketplace functions including marketplace, sellers-list, assign seller.

  • Easy to customise the module.

Workflow of Web Services API Marketplace Add-On -

Install the module first. Then connect your application to your marketplace host where this module installed. Then login to your server using the username and password. After the successful connection, call marketplace web service API method from your application.

You can use and call various Web Service API Marketplace methods your application.

  • marketplace.setseller[$sellelrid,$shopurl] – boolean/string

  • marketplace.assignproducttoseller[$sellerid,$productid] - boolean/string

  • marketplace.unassignproductfromseller[$productid] - boolean/string

  • marketplace.getsellerprofile[$sellerid] - array

  • marketplace.getsellerlist - array

  • marketplace.getproductlistofseller[$sellerid] - array

  • marketplace.paycommissiontoseller[$sellerid] - boolean/string

  • marketplace.approvesellerproduct[$product] - boolean/string

  • marketplace.getsellertotalsales[$sellerid] - array

  • marketplace.getsellertotalorderdetails[$sellerid] – array

We also have added REST API methods for the customer and the admin level operation -

  • magentohost/api/sellers - JSON

  • magentohost/api/sellers/:id - JSON

  • magentohost/api/sellers/:id/product - JSON

  • magentohost/api/sellers/:id/order - JSON

  • magentohost/api/sellers/:id/order/sales- JSON

  • magentohost/api/sellers/:id/pay- JSON

The admin will have various menu options in the admin panel to configure the module settings. And can also provide the authentication to the users. The below-mentioned menu options for managing and creating the user roles:

  • REST– Role: The admin can define user permissions and can add new user role or edit existing user roles.

  • REST– Attributes: The admin can select the attributes for any users. The admin can either assign all attributes or select some attributes from the custom.

  • REST OAuth Consumers: The admin can 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, callback URL, rejected call back URL, current admin password etc. And the keys will be system generated.

The admin can also create the new admin user by clicking on add new user. For this, the admin submits the user details like name, first name, last name, email, current admin password, password, password confirmation and set the new user status. Then assign admin role to that particular user and the user will become the admin.

Benefits of Web Services API Marketplace Add-On -

  • Offer marketplace functions on all the applications.

  • Get the attention of the customers anytime anywhere while they are in a  move with their mobiles.

  • To open a new avenue for increasing the Sales.

  • Expose marketplace functions in a simple and a fast way.

  • Providing flexibility and ease of connectivity, in learning about customers.


Release Notes

Back to top


  • Compatible with CE: 1.6 1.6.1 1.7 1.8 1.8.1 1.9 1.9.1 1.9.2 1.9.3
  • Stability: Stable Build
  • Description:

    -------------------------------- Version 1.0.1 ----------------------------------
    + Rest Api support added
    + Now it will support SOAP V2 Also.
    + Standard Magento web services API extended.
    + Standard SOAP and REST API support found.
    + JSON format return can be used in mobile and ERP devices including
    OpenERP . we have built world best OpenERP Magento connector.
    + Extend all Magento marketplace functions including marketplace, sellers-list,
    assign seller.
    + Easy to customise the module.
    + Using this addon Marketplace managed from another application easily.


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

Q & A

Back to top


Back to top