odoo-api

Odoo JSON-RPC client

This is a fork of odoo-connect with new added methods (read/count/readGroup) & HTTPS support.

Install

$ npm install --save odoo-api

Usage

const Odoo = require('odoo-api');

const odoo = new Odoo({
	host: 'foobar.com',
	port: 9999
});

odoo
	.connect({
		database: 'unicorn',
		username: 'foo',
		password: 'bar'
	})
	.then(client => {
		return client.searchRead('product.product', [['list_price', '>', '50']], {limit: 1});
	})
	.then(products => {
		console.log(products);
		//=> [{list_price: 52, name: 'Unicorn'}]
	});

API

Odoo(options)

options

Any of the connect options and the following options.

host

Type: string

Host of the Odoo server.

port

Type: number Default: 80

Port of the Odoo service.

odoo.connect([options])

Returns a Promise for a client object.

options

database

Type: string

Name of the database.

username

Type: string

Username to connect with.

password

Type: string

Password to connect with.

Client

client.readGroup(model, args, groupBy, params)

model

Type: string

Model to perform the action on.

args

Type: Array

List of parameters.

groupBy

Type: Array

Fields to group by.

params

Type: Object with properties:

offset

Type: number Default: 0

Result offset.

limit

Type: number Default: 5

Maximum number of results.

order

Type: string Default: id

Name of the fields used to sort the results.

select

Type: string[]

Fields that should be selected.

client.count(model, args)

model

Type: string

Model to perform the action on.

args

Type: Array

List of parameters.

client.read(model, args, params)

model

Type: string

Model to perform the action on.

args

Type: Array

List of parameters.

params

Type: Object with properties:

offset

Type: number Default: 0

Result offset.

limit

Type: number Default: 5

Maximum number of results.

order

Type: string Default: id

Name of the fields used to sort the results.

select

Type: string[]

Fields that should be selected.

client.search(model, args)

model

Type: string

Model to perform the action on.

args

Type: Array

List of parameters.

client.searchRead(model, args, [params])

model

Type: string

Model to perform the action on.

args

Type: Array

List of parameters.

params

offset

Type: number Default: 0

Result offset.

limit

Type: number Default: 5

Maximum number of results.

order

Type: string Default: id

Name of the fields used to sort the results.

select

Type: string[]

Fields that should be selected.

client.create(model, args)

model

Type: string

Model to perform the action on.

args

Type: Array

List of parameters.

client.call(model, method, args, [params])

model

Type: string

Model to perform the action on.

method

Type: string

Odoo RPC method.

args

Type: Array

List of parameters.

params

Type: Object

Custom kwargs properties.

License

MIT ©