Story

The reason why this documentation exists is because Odoo doesn't provide any official specification or information for their HTTP API itself.

Context and Usage

First and foremost, it is important to know that this API only has a single endpoint and only the request payload changes. Thus why, this documentation couldn't be conveniently made into an OpenAPI spec.

All interactions made with the API are POST requests and most of them must pass the authentication.

Use Cases

The following are potential use cases of the API that could apply to the common user:

• Software applications where using code libraries isn't possible
• SaaS applications such as n8n and it's Odoo node
• Common testing or data filtering

Resources

Useful links I came across while writing this documentation:

• n8n's Odoo node - Specifies some of the syntax to be used for requests
• Odoo - Web Services
• Odoo - External API
• OdooRPC's documentation Python module documentation
• openobject-server 7.0 - Source Code