README

PHP client for the Odoo JSON-2 API (Odoo 19+).

This library provides a clean, type-safe wrapper around Odoo's new JSON-2 external API, which replaces the legacy XML-RPC and JSON-RPC interfaces.

Requirements

PHP 8.3+
A PSR-18 HTTP client (e.g., Guzzle 7.5+)

Installation

composer require obuchmann/odoo-json-api

If you don't already have a PSR-18 HTTP client installed:

composer require guzzlehttp/guzzle

Quick Start

use Obuchmann\OdooJsonApi\Config;
use Obuchmann\OdooJsonApi\Odoo;

$config = new Config(
    url: 'https://your-odoo-instance.com',
    apiKey: 'your-api-key',
    database: 'your-database', // optional if dbfilter is configured
);

$odoo = new Odoo($config);

// Search and read partners
$partners = $odoo->searchRead('res.partner', fields: ['name', 'email'], limit: 10);

Usage

Configuration

use Obuchmann\OdooJsonApi\Config;

$config = new Config(
    url: 'https://your-odoo-instance.com',
    apiKey: 'your-api-key',
    database: 'mydb',       // optional
);

Direct Methods

use Obuchmann\OdooJsonApi\Domain;

// Search and read
$partners = $odoo->searchRead('res.partner', fields: ['name', 'email'], limit: 10);

// Search with domain filter
$domain = new Domain();
$domain->where('is_company', '=', true)
       ->where('country_id', '=', 14);

$companies = $odoo->searchRead('res.partner', $domain, fields: ['name']);

// Search for IDs only
$ids = $odoo->search('res.partner', $domain);

// Read by IDs
$records = $odoo->read('res.partner', [1, 2, 3], fields: ['name', 'email']);

// Count
$count = $odoo->count('res.partner', $domain);

// Create
$id = $odoo->create('res.partner', [
    'name' => 'New Partner',
    'email' => 'partner@example.com',
]);

// Update
$odoo->write('res.partner', [$id], ['name' => 'Updated Name']);

// Delete
$odoo->unlink('res.partner', [$id]);

// Get field definitions
$fields = $odoo->fieldsGet('res.partner', ['string', 'type']);

// Call any method
$result = $odoo->execute('res.partner', 'custom_method', ['param' => 'value']);

Fluent Request Builder

// Fluent interface scoped to a model
$partners = $odoo->model('res.partner')
    ->where('is_company', '=', true)
    ->fields(['name', 'email', 'phone'])
    ->orderBy('name asc')
    ->limit(20)
    ->offset(0)
    ->get();

// Get first matching record
$partner = $odoo->model('res.partner')
    ->where('email', '=', 'user@example.com')
    ->fields(['name', 'email'])
    ->first();

// Find by ID
$partner = $odoo->model('res.partner')
    ->fields(['name', 'email'])
    ->find(42);

// Count
$count = $odoo->model('res.partner')
    ->where('active', '=', true)
    ->count();

// CRUD via builder
$id = $odoo->model('res.partner')->create(['name' => 'New']);
$odoo->model('res.partner')->update([1, 2], ['active' => false]);
$odoo->model('res.partner')->delete([1, 2]);

Domain Filters

use Obuchmann\OdooJsonApi\Domain;

$domain = new Domain();
$domain->where('name', 'ilike', 'test')
       ->where('active', '=', true)
       ->orWhere('email', '!=', false);

Context

use Obuchmann\OdooJsonApi\Context;

$context = new Context(['lang' => 'fr_FR', 'tz' => 'Europe/Paris']);

$partners = $odoo->searchRead('res.partner', context: $context);

Custom HTTP Client

You can provide your own PSR-18 client:

use GuzzleHttp\Client as GuzzleClient;
use GuzzleHttp\Psr7\HttpFactory;

$httpClient = new GuzzleClient(['timeout' => 30]);
$factory = new HttpFactory();

$odoo = new Odoo($config, $httpClient, $factory, $factory);

Testing

# Unit tests
composer test:unit

# Static analysis
composer analyse

Integration Tests

Integration tests require a running Odoo 19 instance with an API key:

# Start Odoo via Docker
cd docker && docker compose up -d

# Run integration tests
ODOO_HOST=http://localhost:8069 ODOO_API_KEY=your-key ODOO_DATABASE=odoo composer test:integration

License

MIT

obuchmann / odoo-json-api

Maintainers

Package info

Statistics

Security