Advanced Rest Api

by
Odoo

59.64

v 16.0 Third Party 3
Availability
Odoo Online
Odoo.sh
On Premise
Lines of code 335
Technical Name advanced_rest_api
LicenseOPL-1
Versions 12.0 17.0 13.0 15.0 14.0 16.0
You bought this module and need support? Click here!
Availability
Odoo Online
Odoo.sh
On Premise
Lines of code 335
Technical Name advanced_rest_api
LicenseOPL-1
Versions 12.0 17.0 13.0 15.0 14.0 16.0

Advanced Rest Api

An HTTP-based API for managing data in odoo

Advanced Rest Api is a powerful tool that allows you to access and modify data stored in your odoo database using simple HTTP requests. Whether you need to fetch data, create new records, update existing ones, or delete them, advanced_rest_api makes it easy to do so, by sending the appropriate request in JSON format. The response can be chosen to be in either JSON or XML format. With advanced_rest_api, you can easily automate data management tasks, integrate your odoo with other systems, and build custom applications that rely on the data stored in your odoo.

The RESTful API allows developers to access data stored in Odoo, such as customer information, sales data, and inventory levels, as well as perform actions like creating new records, updating existing ones, and deleting data. The API can also be used to trigger workflows, such as generating invoices or creating new sales orders.

Note: Before start:
1) Open odoo.conf
2) Add 'dbfilter = dbname'.
3) Restart odoo service.

How to use Advanced Rest API


Create token


Request Type : GET
End Point : {{base_url}}/api/auth/token
Header : {"content_type":"application/x-www-form-urlencoded"}

                          
db:Database_name
login:User_login
password:User_password
                          
                        

                          
{
    "state": "Success",
    "uid": 6,
    "name": "Marc Demo",
    "user_context": {
        "lang": "en_US",
        "tz": "Europe/Brussels",
        "uid": 6
    },
    "company_id": 1,
    "company_ids": [
        1
    ],
    "access_token": "access_token_0a9b7f89c1c44668b25e0273706b0bf80a66b314",
    "expires_in": "31536000"
}
                          
                        

Search record from sale.order


Request Type : GET
End Point : {{base_url}}/api/sale.order
Header : {"api_key":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "content_type":"application/json"}

                          
{ "fields":"['id','partner_id',]", "domain":"[('id','=',23)]"}
                          
                        

Fields represent the individual data elements of a record in the database, by including them in the fields parameter of your request, you can retrieve only the information you need. For example, if you only want to retrieve the name, email, and phone number of a customer, you would include those fields in your request.
On the other hand, domain allows you to filter your request by specifying conditions that the records must satisfy in order to be included in the result, this way you can retrieve only the specific subset of records you need."

                          
{
    "jsonrpc": "2.0",
    "id": null,
    "result": {
        "status": 200,
        "state": "Success",
        "count": 1,
        "data": [
            {
                "id": 23,
                "partner_id": [
                    10,
                    "Deco Addict"
                ],
                "date_order": "2023-01-06 08:45:15"
            }
        ]
    }
}                          
                        

Update data


Request Type : PUT
End Point : {{base_url}}"/api/sale.order"
Header : {"api_key":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "content_type":"application/json"}

                          
{"payload" : {"reference": "your reference"}, "id":[23]}
                          
                        

                          
{
    "jsonrpc": "2.0",
    "id": [
        23
    ],
    "result": {
        "status": 200,
        "state": "Success",
        "message": "update sale.order record [23] successfully!"
    }
}
                          
                        

Call function


Request Type : PATCH
End Point : {{base_url}}"/api_function/sale.order/23"
Header : {"api_key":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "application/x-www-form-urlencoded"}

                          
action:action_confirm
                          
                        

                          
{
    "state": "Success",
    "message": "record 23 has been successfully patched"
}
                          
                        

Contact / Support

Need help or want extra features?

Need help with the configuration or want this module to have more functionalities?
Contact us on

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.
Not working in Odoo 16
by
michael@oakridge.tech
on 10/24/23, 5:01 PM

I have used this module in older versions, it had been excellent, but the models in the current version use deprecated decorators and sadly it does not work in v16


There are no comments yet!