Menu Close
    Hire Us Request Quote Reading List Switch to Dark Mode

    Prestashop Marketplace Web Service API Configuration

    Admin can give access to the third party to use their marketplace database through CRUD API.

    Users can use the GET, POST, PUT and DELETE methods on Prestashop Marketplace Module tables using Core Prestashop Webservice API.

    Note : 

    • This module is an add-on for Marketplace Module. To use this module, you first have to install Prestashop Advanced Multi Vendor Marketplace
    • The “API access document” will be available only if the admin has purchased the “Prestashop Advance Marketplace” module. Admin needs to contact us through our ticket system to have the “API access documents”.

    Features

    • A seller can create Auth Key to access own Marketplace Details
    • Admin has access to manage seller auth key permission
    • Seller and Admin can manage the access to every resource permission
    • View (GET) Marketplace sellers details using REST API
    • View, add, update and delete Marketplace seller’s products
    • Assign admin product to the seller using API
    • View Marketplace Seller’s Orders (Add and Update is not fully functional)

    Installation

    Step 1: Go to the back office-> modules -> Upload a module
    Step 2: Upload zip file of Marketplace WebService module
    Step 3: The module will automatically get installed on your Prestashop

    Configuration Page :

     

    Active PrestaShop WebService API

    First of all, the admin has to activate Prestashop Webservice API.

    Go to Advanced Parameters -> Webservice  Tab,

    Step 1: In the Configuration block, Enable PrestaShop’s Webservice as Yes.

    Step 2: Click on “Add new webservice key” button to add a new Webservice key,

    Step 3: Add an API key. Recommended generating a random key for security purpose. Add a description, active the status and then give all permissions to the marketplace “seller” resource.

    seller
    
    

    Follow the process of Prestashop API and you can see the Marketplace Database API

    Using the PrestaShop Web Service

    Seller Authentication Key

    Seller needs to create an authentication key to access the web service API.

    Go to “My Account -> Webservice” Tab

    Add a new Authentication Key,

    On Create Authentication page, Seller can see the form same like PrestaShop have in back office.

    The seller can Generate an Authentication key, Add the description, manage status (if admin provides) and Manage permission for multiple marketplace resources.

    Seller allowed resources can be accessible by the endpoint URL.

    Admin Authentication Key Management

    Admin can also create and manage seller authentication key from backoffice. After installing Marketplace Webservice module, a “Manage Webservice” tab added in the Marketplace tab.

    Click on the “Marketplace Management -> Manage Webservice” tab.

    Click on Add New button and you can see the same for where you can select a select a seller and provide an Authentication key.

     

     

     

    Marketplace Webservice URL with Auth Key

    You need to first access the URL with the PrestaShop ws_key, then Marketplace Seller can access the Marketplace API using ‘auth_key’ parameter adding in the URL.

    This ‘auth_key’ is the identifier to get the particular seller information.

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

    Seller Details API

    Get the Seller details

    Endpoint : /api/seller/sellerinfo

    Method: GET

    Seller Product API

    1: Get the Seller Product Details

    Endpoint : /api/seller/sellerproduct

    Method: GET

    2: Create seller product

    Endpoint : /api/seller/saveproduct

    Method: POST

    3: Assign admin product to seller

    Endpoint : /api/seller/assignproduct

    Method: GET

    Parameter: id_product

    4: Delete seller product

    Endpoint : /api/seller/deleteproduct

    Method: DELETE

    Parameter: id_mp_product

    Seller Order API

    1: Get the Seller Order Details

    Endpoint : /api/seller/sellerorder

    Method: GET

    2: Create Seller Order

    Endpoint : /api/seller/createorder

    Method: POST

     

    Seller Images API

    1: Get the List of image types

    Endpoint : /api/seller/mpimages

    Method: GET

    2: Get the Seller Logo

    Endpoint : /api/seller/mpimages/sellerlogo

    Method: GET

    3: Get the Seller Banner

    Endpoint : /api/seller/mpimages/sellerbanner

    Method: GET

    4: Get the Shop Logo

    Endpoint : /api/seller/mpimages/shoplogo

    Method: GET

    5: Get the Shop Banner

    Endpoint : /api/seller/mpimages/shopbanner

    Method: GET

    6: Get list of product images available

    Endpoint : /api/seller/mpimages/products

    Method: GET

    7: Get list of images a particulat product

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

    Method: GET

    8: Get a particular image of a product

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

    Method: GET

    9: Upload the seller image by creating a Form same as like PrestaShop default API does in this documentation Image management

     

    Support

    For any technical assistance and for the full documentation,  please raise a ticket at http://webkul.uvdesk.com or for any other support drop us a mail at support@webkul.com

     

    Current Product Version - 5.1.2

    Supported Framework Version - 1.7

    . . .

    Comments (2)

    Add Your Comment

  • Mujtaba
    Hello,
    I want to add/update products and their images on prestashop shop using webservice api.
    How can I do it what steps I need todo, what are the services you people are providing and what are the charges for those services.

    Thanks

    • amit kushwaha
      Hello,

      Thank you for showing interest in our module.
      This module is an extension of our Advanced Marketplace module and using this you can view/add/update and delete Marketplace seller’s product.
      Here, its look like you want to use Prestashop core API to update the catalog products.

      Please mail us at support@webkul.com so that we can discuss in detail.

      Thank you!

  • Back to Top
    css.php
    Hire Us!
    Brief us about your requirements and we'll get back to you.
    Woo! Hooy!
    We have just recieved your project brief and our expert will contact you shortly.
    Send Again
    Close

    Table of Content

    Hide Index