Home Nodes Odoo

Odoo

The Odoo Node enables integration with an Odoo ERP instance via its JSON-RPC API.
It allows invoking common Odoo model methods dynamically, such as searching, reading, creating, updating, and deleting records.

Revision History

1.0.0.0 Initial Release

Properties

Connection

Type: Connection Input

Url
Type: String
The base URL of your Odoo instance, e.g. http://localhost:8069.

Database
Type: String
The Odoo database name to authenticate against.

Username
Type: String
The username or email address for Odoo login.

Password
Type: Password
The password associated with the username.

Uid
Type: String Output
The authenticated user ID returned after successful login. Used internally for requests.

Model

Type: String Input
The technical name of the Odoo model to operate on, e.g. res.partner.

Method

Type: String Input
The method to call on the model.

Arguments

Type: JSON Input
A JSON array representing the positional arguments for the method call.

Response

Type: JSON Output
The JSON-formatted response returned from Odoo after method invocation.

Remarks

Authentication and Connection

The node authenticates to Odoo using the provided Url, Database, Username, and Password.
Upon successful login, Odoo returns a user ID (Uid) used in subsequent API calls.

Sample Generation

Samples are generated based on your specific Odoo implementation, as such you need to be connected and acquire metadata to generate samples.
When additional features are enabled on Odoo, you will have to request metadata again to update the models that are available to the samples.

JSON-RPC Communication

This node interacts with Odoo via JSON-RPC over HTTP POST.
Each request specifies a model and method, along with positional and keyword arguments serialized as JSON.
This dynamic approach supports flexible method calls across many Odoo models.

Metadata Retrieval and Samples

To facilitate user experience, the node retrieves metadata from the Odoo instance, including available models and their fields.
This metadata is used to generate sample operations and example inputs/outputs for supported methods dynamically.

Supported Methods

All Odoo model methods are supported by the node via JSON-RPC invocation.
However, the node specifically provides samples and tailored support for the following six common methods:

  • search: Returns a list of record IDs matching domain filters.
    Arguments: [domain]

  • search_read: Combines search and read; returns list of records with specified fields.
    Arguments: [domain, fields]

  • read: Reads specific records by ID with requested fields.
    Arguments: [ids, fields]

  • write: Updates existing records by ID with new values.
    Arguments: [ids, values]

  • create: Creates a new record with specified values.
    Arguments: [values]

  • unlink: Deletes records by ID.
    Arguments: [ids]

Other methods may be invoked by specifying their names and arguments, but samples and keyword argument handling are optimized for these six.

Keyword Arguments

Depending on the method, keyword arguments can include:

  • limit: Limits number of records returned.
  • offset: Skips first N records.
  • order: Defines sorting order, e.g., "id desc".
  • context: Additional contextual parameters like language, timezone, or user preferences (JSON object or JSON string).