Buy Now

Opencart Marketplace Web Services API

Opencart Marketplace Web Services API Module will provide REST API by which you can use functions of Opencart Marketplace in other applications like mobile applications and ERP. It will allow the developer to implement many functionalities of Opencart Marketplace like seller dashboard, seller orders etc to another platform like Android and iOS. After implementing the API of Opencart Marketplace, the store owner can manage their store from other applications.

Since it’s an add-on for the Marketplace Module, so marketplace module must be installed before installing the Opencart Marketplace Web Services API.

Features

  • Easy to customise the module.
  • This module uses standard Opencart API key.
  • Opencart marketplace functions included seller-profile, seller-order, seller dashboard, write review, add history, sell page and contact seller.

Installation

The admin can find the catalog folder in the zip file. The admin needs to move catalog folder into the root directory of your opencart website.

How to Generate API Key

The admin can add a new API by navigating System=>API. 

add new api

After clicking on add new API button, the admin can set the name of API and can generate API key.  The admin can also set the IP addresses and can see the session from here.

generate key

After generating the API key, the admin can use this key for their application or software.

How To Use – REST API

After the configuration of the Opencart Marketplace web services API, the admin needs to follow the given instructions.

Admin Level Operations:

S.no API URL and parameters Return type
1 API URL: siteurl/index.php?route=api/wkrestapi/marketplace/apiLogin

Request Type: POST

Parameter: apiKey, customer_id

Description: To authenticate the user. If the login is successfully done then you will get the wk_token in response that will be used to call the rest of the APIs.

JSON
2 API URL: siteurl/index.php?route=api/wkrestapi/marketplace/getSellerProfile

Parameters: wk_token, id(seller_id), width(optional), sort(optional), order(optional), page(optional), limit(optional)

Request Type : POST

Params : array()

Description: To get the seller profile details.

JSON
3 API URL: siteurl/index.php?route=api/wkrestapi/marketplace/getSellerOrders

Request Type : POST

Parameters: wk_token, id(order_id)

Description: To get the seller orders.

JSON
4 API URL: siteurl/index.php?route=api/wkrestapi/marketplace/getDashbordData

Request Type: POST

Parameters: wk_token

Description: To get the seller dashboard data.

JSON
5 API URL: siteurl/index.php?route=api/wkrestapi/marketplace/addHistory

Request Type: POST

Parameters: wk_token, order_id, order_status_id, notifyadmin, comment,

Description: To add the order history.

JSON

 

Customer Level Operations:

S.no

Methods and parameters

Return type

1

API URL: siteurl/index.php?route=api/wkrestapi/marketplace/writeReview

Parameters: wk_token, seller_id, name, text, quality_rating, price_rating, value_rating

Request Type: POST

Description: To write the review for the seller

JSON

2

API URL: siteurl/index.php?route=api/wkrestapi/marketplace/contactSeller

Parameters: wk_token, seller_id, subject, message

Request Type: POST

Description: To contact the seller. Mail will be sent to seller and admin according to the marketplace settings.

JSON

3

API URL: siteurl/index.php?route=api/wkrestapi/marketplace/getSellData

Parameters: wk_token, width(optional)

Request Type: POST

Description: To get the marketplace sell page data.

JSON

That’s all for the Opencart Marketplace web services API, still have any issue feel free to add a ticket and let us know your views to make the module better https://webkul.uvdesk.com/en/

Current Product Version - 2.0.0.0

Supported Framework Version - 2.0.x.x, 2.1.x.x, 2.2.x.x, 2.3.x.x

. . .

Ask a Feature

Index