PrestaShop Marketplace Web Service API {User Guide}

With this module, the seller can create web services for the marketplace so that seller can provide access to the third-party user to use their marketplace database through CRUD API.

Prestashop Marketplace Web Service API will help them with that.

Furthermore, users can now use the GET, POST, PUT and DELETE methods on PrestaShop Marketplace Module tables using Core PrestaShop Webservice API.

• This module is an add-on to Marketplace Module. Therefore, to use this module, you need to install PrestaShop Advanced-Multi Vendor Marketplace first.
• API usage is described in module README.md file.
• Module version 6.x.x is only compatible with Marketplace version 6.x.x
• Module version 6.x.x only supports JSON not XML
• Compatible with PrestaShop version 8.x.x.
• PrestaShop Marketplace Web Service API is compatible with PrestaShop Advanced Multi-Vendor Marketplace version 7.x.x.

• A seller can create Auth Key to access their own Marketplace Details.
• Admin has access to manage seller auth key permissions.
• Seller and Admin can manage access to every resource permission.
• View (GET) Marketplace seller’s details using REST API.
• View, add, update and delete Marketplace seller’s products.
• Admin can create own admin auth key for some API.
• View Marketplace Seller’s Orders.

For installing this module, you need to install the Prestashop Advanced Multi Vendor Marketplace module first.

• Firstly, go to the module manager in the back office and click on ‘upload a module’.
• After that, drag and drop the module file or select the file from the system
• In this way, the module installation will be successful.

Under Configuration, the admin can:

• Generate webservice API key.
• Allow sellers to create webservice request.
• Enable or disable manual approval of seller’s webservice request.
• Allow sellers to change the status of authentication key.

To activate the Webservice API, go to Advanced Parameters > Webservice.

Firstly, enable PrestaShop Webservice from the configuration page. Now, click on “Add new webservice key” button to add a new key.

Add webservice key, description, set its status, and give all permissions to the marketplace “seller” resource.

After the successful installation of the module, a new tab “Webservice” gets available in seller’s account. From here, the sellers can add authentication key.

The seller can generate an authentication key, add its description, and manage permission for multiple marketplace resources.

Please note that the resources allowed for sellers are accessible by the endpoint URL.

After the installation of the module, a new tab “Webservice” gets available under Marketplace in the back office.

From this tab, the admin can add webservice account key on seller’s behalf.

Click on ‘Add new’ button to add authentication key.

On clicking the button, a form appears on the page, where the admin can:

• Select the select for whom he wants to add webservice key.
• Generate authentication key.
• Add key description.
• Manage the status and resource permissions for the key

Firstly, you need to access the URL with the PrestaShop ws_key. Then only sellers can access the Marketplace API using the ‘auth_key’ parameter added in the URL.

For that reason, this ‘auth_key’ is the identifier to get the particular seller information.

Complete URL: domain/api/seller?auth_key=PFTVH97CEI&ws_key=IP2LASMH7W5N6T8PB


Seller API details

Get the seller details

Endpoint : /api/seller/sellerinfo

Method: GET

Seller Product API

Get the seller product details

Endpoint : /api/seller/sellerproduct

Method: GET

Get the seller product combinations

Endpoint : /api/seller/getproductcombination?id_mp_product=[id]

Method: GET

Create seller product

Endpoint : /api/seller/saveproduct

Method: POST

Update seller product stock

Endpoint : /api/seller/stockupdate

Method: POST

Create seller product combination

Endpoint : /api/seller/saveproductcombination

Method: POST

Delete seller product

Endpoint : /api/seller/deleteproduct

Method: DELETE

Parameter: id_mp_product

Delete seller product combination

Endpoint : /api/seller/deleteproductcombination

Method: DELETE

Seller Order API

Get the seller order details

Endpoint : /api/seller/sellerorder

Method: GET

Create order for the seller

Endpoint : /api/seller/createorder

Method: POST

Seller Images API

Get the list of types of images

Endpoint : /api/seller/mpimages

Method: GET

Get the logo of the seller

Endpoint : /api/seller/mpimages/sellerlogo

Method: GET

Get the banner of the seller

Endpoint : /api/seller/mpimages/sellerbanner

Method: GET

Get the Shop Logo

Endpoint : /api/seller/mpimages/shoplogo

Method: GET

Get the Shop Banner

Endpoint : /api/seller/mpimages/shopbanner

Method: GET

Get list of product images available

Endpoint : /api/seller/mpimages/products

Method: GET

Get list of images for a particular product

Endpoint : /api/seller/mpimages/products/[id_product]

Method: GET

Get a particular image of a product

Endpoint : /api/seller/mpimages/products/[id_product]/[id_image]

Method: GET

Admin API

Assign product to seller

Endpoint : /api/seller/assignproduct

Method: POST

9: Finally, Upload the seller image by creating a form similar to the PrestaShop default API. And therefore to know more, go through this documentation.

So, this was all about Prestashop Marketplace Web Service API Configuration Module. Finally, I hope this document will help you in checking the functionality of the module in a better way.

Furthermore, do let us know about your views in the comments.

For any kind of technical assistance or query, please raise a ticket at http://webkul.uvdesk.com or send us a mail at [email protected]

Also, please explore our PrestaShop development services & vast range of featureful PrestaShop Addons.