APPS
Odoo Marketplace Web Services API 17.0

Odoo Marketplace Web Services API

$ 109.45 $ 109.45

v 17.0 0

Technical name	odoo_marketplace_rest_api
License	LGPL-3
Website	https://store.webkul.com/Odoo-Multi-Vendor-Marketplace.html

Description
License

string,

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

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
End Points
Postman Collection

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.

Write a mail to us:

[email protected]

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

Write To US

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.

This is an unofficial translation of the GNU Lesser General Public License into Vietnamese. It was not published by the Free Software Foundation, and does not legally state the distribution terms for software that uses the GNU LGPL - only the original English text of the GNU LGPL does that. However, we hope that this translation will help language speakers understand the GNU LGPL better.
GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below.
0. Additional Definitions.
As used herein,"this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU "General" Public License.
"The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below.
An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library.
A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version".
The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version.
The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work.
1. Exception to Section 3 of the GNU GPL.
You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL.
2. Conveying Modified Versions.
If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version:
a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or
b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy.
3. Object Code Incorporating Material from Library Header Files.
The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following:
a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License.
b) Accompany the object code with a copy of the GNU GPL and this license document.
4. Combined Works.
You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following:
a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License.
b) Accompany the Combined Work with a copy of the GNU GPL and this license document.
c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document.
d) Do one of the following:
0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.
1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version.
e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.)
5. Combined Libraries.
You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following:
a)Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License.
b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work.
6. Revised Versions of the GNU Lesser General Public License.
The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation.
If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.