Odoo REST API (JSON & XML)

by
Odoo

$ 96.98

v 16.0 Third Party 265
Availability
Odoo Online
Odoo.sh
On Premise
Odoo Apps Dependencies Discuss (mail)
Lines of code 1216
Technical Name restapi
LicenseOPL-1
Websitehttps://www.synconics.com
Versions 9.0 10.0 11.0 12.0 13.0 14.0 15.0 16.0 17.0
You bought this module and need support? Click here!
Availability
Odoo Online
Odoo.sh
On Premise
Odoo Apps Dependencies Discuss (mail)
Lines of code 1216
Technical Name restapi
LicenseOPL-1
Websitehttps://www.synconics.com
Versions 9.0 10.0 11.0 12.0 13.0 14.0 15.0 16.0 17.0

REST API Application (JSON & XML)

REST API, also known as (application programming interference), is commonly used to provide web services interaction. All interactions between applications, data, and devices have APIs that allow computers to operate them and that is what ultimately creates connectivity.

The RESTful API accesses Odoo using standard HTTP GET, PUT, POST, and DELETE methods and a simple JSON and XML input and output format.

It uses both the OAuth1 and OAuth2 protocols to authenticate 3rd party applications.

Consider the following link for a quick reference guide to use Odoo RestAPI:
https://bit.ly/3QI4219

This module is compatible with

Authentication

Provides Authentication with both Oauth1, Oauth2 and Basic protocols.

Fetching of Records

Super easy to fetch records of any Odoo objects.

Creating records

Creating records in Odoo.

Updates records

Updates records in Odoo.

Deleting Records

Deleting records in Odoo

Calling Methods

Calling Methods in Odoo

Support Reports

Supports Report Printing

Odoo Version Information.

Using the following request, user can check the Odoo version information.

GET
/restapi/1.0/common/version

OAuth1 Authentication

Using the following request, user can authenticate using Oauth1 protocol.

Step1: Temporary Credential Request endpoint:
POST
/restapi/1.0/common/oauth1/request_token


Step2: Resource Owner Authorization endpoint:
GET
/restapi/1.0/common/oauth1/authorize


Step3: Token Credentials Request endpoint:
POST
/restapi/1.0/common/oauth1/access_token

OAuth2 Authentication

Using the following request, user can authenticate using Oauth2 protocol.

Step1: Resource Owner Authorization endpoint:
GET
/restapi/1.0/common/oauth2/authorize


Step2: Token Credentials Request endpoint:
POST
/restapi/1.0/common/oauth2/access_token

Basic Authentication

Using the following request, user can authenticate using Basic protocol.

Step1: Token Credentials Request endpoint:
POST
/restapi/1.0/common/basic/access_token

Check Access Rights

Using the following request, user can check the access rights of current objects

GET
/restapi/1.0/object/{object_name}/check_access_rights?operation={list_of_operations}

List Record

Using the following request, user can get a list record of current objects.

GET
/restapi/1.0/object/{object_name}/search

Count Record

Using the following request, the user can count the number of records of current objects.

GET
/restapi/1.0/object/{object_name}/search_count

Read Records

Using the following request to read records, the user can fetch individual records, read record sets and filter records.

Read Single Record:
GET
/restapi/1.0/object/{object_name}/{id}


Read Record Set:
GET
/restapi/1.0/object/{object_name}?ids={comma_separated_ids}


Read Filter Records:
GET
/restapi/1.0/object/{object_name}/?domain={comma_separated_list_of_args}


Listening Record Fields

Using the following request, the user can fetch the listening field of the current object.

GET
/restapi/1.0/object/{object_name}/fields_get

Create Record

Using the following request, user can create records in current Odoo.

POST
/restapi/1.0/object/{object_name}?vals={values_for_the_object's_fields}

Update Records

Using the following request, users can update the current record and more than one record.

Update Single Record:
PUT
/restapi/1.0/object/{object_name}/{id}?vals={fields_and_values_to_update}


Update Record Set:
PUT
/restapi/1.0/object/{object_name}?ids={comma_separated_ids}&vals={fields_and_values_to_update}

Delete Records

Using the following request, users can delete individual records and more than one record.

Delete Single Record:
DELETE
/restapi/1.0/object/{object_name}/{id}


Delete Record Set:
DELETE
/restapi/1.0/object/{object_name}?ids={comma_separated_ids}

Report Printing

Using the following request, users can print individual reports as well as print reports of more than one.

Print Single Record:
GET
/restapi/1.0/report/{report_name}/{id}


Print Record Set:
GET
/restapi/1.0/report/{report_name}?ids={comma_separated_ids}


Inspection and Introspection

An inspection provides information about Odoo models via its various fields (ir.model).

In addition to this, users can get information about the Odoo objects.

Introspection provides information about the fields of Odoo models and allows adding custom fields without using Python code (ir.model.fields).

Furthermore, using these, users can create new fields at the Odoo site without the use of Pythons.

By going to Settings => Technical => Models

Here, users can view the read / create record schema.

Users can see what field details will be in the feedback.

Frequently Asked Questions

Do I have to install an extra library before installing this module?

Yes, You need to execute the requirements.txt file of this module using pip3.

How can I get Consumer Key and Consumer Secret in this module ?

You need to go to Users ⇒ Authentication, Here you need to create a new record after the creation of the record you will get Consumer Key and Consumer Secret.

How can I get Redirect URL for Oauth2?

Go to Users ⇒ Authentication ⇒ Oauth2 Access Token and Endpoint, Here to Authorize Redirect URL you need to add a URL and this URL will be used as Redirect URL for Oauth2.

Is Oauth2 Access Token permanent to use in request?

No, the Oauth2 access token will be expired within half an hour, then you need to regenerate the access token using the refresh token.

Does your module can perform request operations for custom models?

Yes, Our module also supports request operation for custom objects.

Does your module support multi-database filters?

No, Our module will not work on Multi-database filters.

Can I call a function which is declared?

Yes, You can call functions which are declared on a particular model.
For Example: /restapi/1.0/object///

Till how much time do I get free support for this module from your company, once I purchase this app?

Our company will give free support for thirty days. One month free bug support period will be offered pertaining to any one server used, testing or live.

Is it possible for you to add on a few features in this module as per my company requirements?

Our company's dedicated team of experts will map your company's requirements, and will do customization accordingly. You can contact us using our company Email id: contact@synconics.com.

Suggested Products
Our Apps

Terms & Conditions

  • All the apps are to be purchased separately, for individual versions and individual edition.
  • One month free bug support period will be offered pertaining to any one server used, testing or live.
  • Synconics is not responsible for installation or updating of the module on any of your server.
  • If an error appears in our app due to other custom modules installed in your system or if Odoo base source code is not updated on your system, to make it compatible with your source code, we'll charge you for our efforts to resolve those errors and make the module compatible with your source code.
  • Please refer the document for configuration. If any support is needed for module configuration, installation, updating or any help is needed, it will be considered in paid support.
  • Please note that you are not allowed to distribute or resell this module after purchase.
  • This module is tested and working on Odoo vanilla with Ubuntu OS.
  • Support services will be provided from Monday to Friday, 10:30 AM to 7 PM IST (Indian Standard Time).
  • Support will not be provided during Indian public holidays or company holidays.
Questions? Get in touch!

Odoo REST API: Version 1.0 documentation

Our Odoo REST API Reference houses a lot of information, but doesn't always tell you how you should use it.

If you want to built apps and other integrations for the Odoo, this tutorial will walk you through what is required to authenticate and make basic API calls.

Get the module

The module restapi is available on Synconics App Store, Here are links for:

  • Version 12.0 (Community & Enterprise)
  • Version 13.0 (Community & Enterprise)
  • Version 14.0 (Community & Enterprise)
  • Version 15.0 (Community & Enterprise)

Installation

Install restapi module by following below steps:

  1. Unzip restapi module to custom addons directory
  2. Restart odoo server
  3. Activate Developer Mode from the Settings menu
  4. Navigate to the Apps menu
  5. Click on Update Apps List menu in left side bar
  6. Once apps list is updated, click on Apps menu from left / top side bar
  7. Search module restapi
  8. Click on Install button.

Getting Started

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.

Please log in to comment on this module

  • The author can leave a single reply to each comment.
  • This section is meant to ask simple questions or leave a rating. Every report of a problem experienced while using the module should be addressed to the author directly (refer to the following point).
  • If you want to start a discussion with the author or have a question related to your purchase, please use the support page.