SUPPORT APPS
Skip to Content

Odoo Marketplace Web Services API

by

$ 287.82

17.0 0
Live Preview
Required Apps • Sales (sale_management)
• Invoicing (account)
• Discuss (mail)
• eCommerce (website_sale)
• Inventory (stock)
• Website (website)
Community Apps Dependencies odoo_marketplace
odoo_rest
Technical Name odoo_marketplace_rest_api
License OPL-1
You bought this module and need support ? Click here!
Technical Name odoo_marketplace_rest_api
License OPL-1

Introduction

This module enables REST API access to marketplace functionality within Odoo, allowing seamless integration of operations such as seller management, order processing, invoicing, and credit memo handling. By exposing marketplace features through REST endpoints, it empowers businesses to connect their Odoo marketplace with mobile applications, ERP systems, or third-party platforms. This provides flexibility, real-time data exchange, and enhanced efficiency in managing marketplace workflows.

Key Features

  • Provide REST API endpoints for marketplace operations including sellers, orders, invoices, and credit memos

  • Support for canceling seller orders and retrieving landing page details through REST services

  • Secure authentication methods available for both administrators and customers

  • JSON-formatted responses optimized for mobile apps, ERP systems, and third-party integrations

  • Real-time synchronization between Odoo marketplace and external applications

Benefits

  • Connect Odoo marketplace with external systems through standardized REST APIs

  • Enhance operational flexibility by exposing seller and order management features

  • Improve efficiency with automated and real-time data exchange

  • Strengthen interoperability with mobile platforms and external marketplaces

  • Ensure secure access control through role-based authentication methods

Compatibility & Technical Details

Technical Name: odoo_marketplace_rest_api

License: OPL-1

Required Modules:

  • Sales (sale_management)

  • Invoicing (account)

  • Discuss (mail)

  • eCommerce (website_sale)

  • Inventory (stock)

  • Website (website)

  • Multi-Vendor Marketplace base module

  • REST API base module

Installation Steps:

  1. Verify that all required modules, including sales, invoicing, discuss, eCommerce, inventory, website, marketplace base, and REST API base, are installed.

  2. Place the module folder odoo_marketplace_rest_api in the Odoo Add-Ons path.

  3. Activate Developer Mode, update the app list, and install the module.

  4. Configure authentication for administrators and customers.

  5. Begin using the REST endpoints to manage sellers, orders, invoices, credit memos, and marketplace data from external systems.

Odoo Marketplace Web Services API

Provide endpoints to interact with the marketplace in Odoo!!

This multi-vendor marketplace addon will expose the Web Services API of the Marketplace module with REST API so that marketplace functions can be used by other applications like ERP, Mobile applications (iOS, Windows, etc). Create/become sellers, get sellers list, invoice, credit memo, cancel seller orders, landing page data, and many more.

Information

user-guide
User Guide
https://webkul.com/blog/user-manual-of-odoo-marketplace-web-services-api/

What is an API?

An API (Application Program Interface) is a set of protocols and a kind of service that allow two software programs to communicate with each other directly and use functionality and data from each other.

As we know, API is the only way to enhance your application in which software components may interact with other software components that provide interfacing with other apps and software over the internet.

Expose Marketplace Resources via Marketplace API

Odoo Marketplace API's Module exposes several marketplace resources to web API including create/become sellers, get sellers list, invoice, credit memo, cancel seller orders, landing page data, and many more.

Odoo Marketplace function can be used by other applications like ERP, Mobile Apps, and even by the third-party marketplace like Amazon, eBay, Etsy, etc.

Note :-

This module is an add-on to Odoo Marketplace Module. To use this module you must have installed Webkul's Odoo Marketplace Module first.

Benefits

With the help of Odoo Marketplace Web Services API, it is easy to call the functions of the marketplace from any third-party platform like ERP, Mobile application, etc.

The process will be executed and return results as per the execution process

After the successful installation of the module, the listed functions in the Odoo Marketplace Web Services API of the Marketplace module will be exposed.

Highlighted Features

Call functions from any third party platform

Enable mobility by fetching Marketplace functions

Access web functionality by integrating mobile apps

Exchange data between Marketplace and API Database

Authenticate by token, oAuth or session

Perform data changes in real-time

Detailed Features

Expose Marketplace Resources to web API in Odoo

  • This module exposes several marketplace resources to web API.
  • It includes creating and becoming a seller, getting sellers' lists, invoices, credit memos, canceling seller orders, landing page data, and many more.

Authenticate resources on admin and customer level

  • The module provides admin and customer level authentication for resources.
  • It also provides search criteria for seller list and seller's order.
  • The consumer can authenticate by any of these methods: token, oAuth, or session.

Use JSON format in Odoo

  • 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.

Extend Mobility of the Marketplace

  • Using Marketplace API, enable the mobile app functionality by fetching the functions of the marketplace.
  • This will enable customers to handle their Marketplace from their smartphones too.

Cross-Application Interaction

  • With the help of this module, a mobile app can be integrated for accessing web functionality.
  • By means of Marketplace API, data can be exchanged between your marketplace store and the API database-driven resources.

More Scope For Development

  • With the use of API, applications layers can be created and used to distribute the information and services to a new audience.

More Flexible Environment

  • With the use of API, any changes with time can be performed and easily populates the data in real-time.

Increase Capability

  • API provides a more efficient way to transfer data to every channel on which the access is granted.

Postman Collection

1 - Select Import in Postman
2 - Paste the Postman collection Link
Postman Collection URL is - https://api.postman.com/collections/21501178-8876c13e-ab4f-4a8c-872d-660a9245ac1b?access_key=PMAT-01HKSFDBWCYQJ1SEXPP2Q7G10K

Rest Api Response Codes

1.Create Seller with Values.

api resource : /api/mp/seller/create
method : POST

request : 
{
"email":String,
"name":String,
}
Response : 
{
"success": Bool,
"message": String,
"responseCode": int,
"permissions": {
   "read": Bool,
   "write": Bool,
   "delete": Bool,
   "create": Bool
},
"model_id": int,
"create_id": int,
}

2.Get seller data with Id.

api resource : /api/mp/seller/id
method : GET
*pass seller id .

request : 
{}
Response : 
{
"success": bool,
"message": String,
"responseCode":int,
"record_id":int,
"permissions":
{
  "read":bool,
  "write": bool,
  "delete": bool,
  "create": bool
},
"model_id": int,
"data":
[
  {
  "id":int,
  "name": String,
  }
]
}

3.Create Seller shop.

api resource : /api/mp/shop/create
method : POST

request : 
{
  "seller_id" :int,
  "url_handler": String,
  "name": String,
  "street": String,
  "street2":String,
  "zip": int
}
Response : 
{
"success": Bool,
"message": String,
"responseCode": int,
"permissions": {
   "read": bool,
   "write": bool,
   "delete": bool,
   "create": bool
                }
}

4.Get Seller data with id.

api resource : /api/mp/seller/id/shops
method : GET
*pass seller id .

request : 
{}
Response : 
{
   "success": Bool,
   "message": String,
   "responseCode": Int,
   "record_id": Int,
   "permissions": {
       "read": Bool,
       "write": Bool,
       "delete": Bool,
       "create": Bool
   },
   "model_id": Int,
   "data": [
       {
           "id": Int,
           "name": Str
       }
   ]
}

5.Create Seller product.

api resource : /api/mp/product/create
method : POST

request : 
{
	"name": "Blake Clancy Test Product",
	"description": "Testing Description",
	"marketplace_seller_id": 47
}
Response : 
{
   "success": Bool,
   "message": String,
   "responseCode": int,
   "permissions": {
       "read": Bool,
       "write": Bool,
       "delete": Bool,
       "create": Bool
   },
   "model_id": int,
   "create_id": int
}

6.Get seller Products.

api resource : /api/mp/seller/id/products
method : GET

request : 
{}
Response : 
{
   "success": Bool,
   "message": String,
   "responseCode": int,
   "record_id": int,
   "permissions": {
       "read": Bool,
       "write": Bool,
       "delete": Bool,
       "create": Bool
   },
   "model_id": int,
   "data": [
       {
           "id": int,
           "name":Str
       },
       {
           "id": int,
           "name": Str
       }
   ]
}

6.Get order deliveries with order id.

api resource : /api/mp/order/id/deliveries
method : Get

request : 
{}
Response : 
{
   "success": Bool,
   "message": String,
   "responseCode": int,
   "record_id": int,
   "permissions": {
       "read": Bool,
       "write": Bool,
       "delete": Bool,
       "create": Bool
   },
   "model_id": int,
   "data": [
       {
           "id": int,
           "name": Str
       }
   ]
}

8.Get Marketplace Payments.

api resource : /api/mp/payments
method : GET

request : 
{}
Response : 
{
   "success": Bool,
   "message": String,
   "responseCode": int,
   "permissions": {
       "read": Bool,
       "write": Bool,
       "delete": Bool,
       "create": Bool
   },
   "model_id": int,
   "data": [
       {
           "id": int,
           "name": Str
       }
   ]
}

9. Get Marketplace Invoices.

api resource :/api/mp/invoices
method : GET

request : 
{}
Response : 
{
   "success": Bool,
   "message": String,
   "responseCode": Int,
   "permissions": {
       "read": Bool,
       "write": Bool,
       "delete": Bool,
       "create": Bool
   },
   "model_id": Int,
   "data": [
       {
           "id": Int,
           "name":Str
       }
   ]
}

10.To delete the seller shop .

api resource : /api/mp/shop/id
method : Delete

request : 
{}
Response : 
{
   "success": Bool,
   "message": String,
   "responseCode": int,
   "record_id": int,
   "permissions": {
       "read": Bool,
       "write": Bool,
       "delete": Bool,
       "create": Bool
   },
   "model_id": int
}

11.to change the sellers data.

api resource : /api/mp/seller/id
method : PUT

request : 
{
"email": String,
}
Response : 
{
   "success": Bool,
   "message": String,
   "responseCode": int,
   "record_id": int,
   "permissions": {
       "read": Bool,
       "write": Bool,
       "delete": Bool,
       "create": Bool
   },
   "model_id": int
}

12.Change the shop data.

api resource : /api/mp/shop/id
method : PUT

request : 
{
  "Name":"changed name",
}
Response : 
{
   "success": Bool,
   "message": Str",
   "responseCode": int,
   "record_id": int,
   "permissions": {
       "read": Bool,
       "write": Bool,
       "delete": Bool,
       "create": Bool
   },
   "model_id": int
}

13.Change the product data

api resource : /api/mp/product/id
method : PUT

request : 
{
	"Name":"changed name"
}
Response : 
{
   "success": Bool,
   "message": Str",
   "responseCode": int,
   "record_id": int,
   "permissions": {
       "read": Bool,
       "write": Bool,
       "delete": Bool,
       "create": Bool
   },
   "model_id": int
}

Help and Support

Get Immediate support for any of your query

You will get 90 days free support for any doubt, queries, and bug fixing (excluding data recovery) or any type of issue related to this module.

mail

Write a mail to us:

[email protected]

Any queries or want any extra features? Just drop a mail to our support.

Write To US
support-icon

Get in touch with our Expert:

https://webkul.uvdesk.com/en/customer/create-ticket/

Have any technical queries, want extra features, or anything else? Our team is here to answer all your questions. Just Raise A Support Ticket. 

Odoo Proprietary License v1.0
This software and associated files (the "Software") may only be used (executed,
modified, executed after modifications) if you have purchased a valid license
from the authors, typically via Odoo Apps, or if you have received a written
agreement from the authors of the Software (see the COPYRIGHT file).

You may develop Odoo modules that use the Software as a library (typically
by depending on it, importing it and using its resources), but without copying
any source code or material from the Software. You may distribute those
modules under the license of your choice, provided that this license is
compatible with the terms of the Odoo Proprietary License (For example:
LGPL, MIT, or proprietary licenses similar to this one).

It is forbidden to publish, distribute, sublicense, or sell copies of the Software
or modified copies of the Software.

The above copyright notice and this permission notice must be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.