Download the PHP package lekoala/odoo-php-client without Composer

Odoo PHP Client

A PHP 8.3+ client for Odoo 19's External JSON-2 API, with generic model calls and optional typed services for partners, invoices, subscriptions, products, payments, API keys, portal PDFs, Stripe and Peppol.

Installation

Until the first release is published, install the package from its Git repository or a Composer path repository.

Quick start

Every JSON-2 method remains available through named parameters:

Single and batch creation have distinct return contracts:

Pagination and iteration

Typed service lists no longer apply a hidden result cap. Use QueryOptions for an explicit page, or iterate() to process large result sets in bounded requests:

limit: null (the default) means no overall cap. Iterators remain bounded by batchSize; array-returning list() methods load all matching rows, so prefer iterate() for large tables. Passing an integer as the second argument remains supported as shorthand for an explicit limit.

Low-level searchRead() sends only the options you actually provide: an empty $fields, a zero limit/offset or a null order is omitted from the request body instead of being sent as []/0/null.

See examples.

AI agents: the generic integration skill shipped with this package is .agents/skills/odoo-php-client/SKILL.md.

Design guarantees

• JSON-2 named arguments are sent without RPC-style positional inference through call().
• Deprecated execute() compatibility is isolated at the public client boundary; adapters and services use named JSON-2 parameters only.
• Read-only calls may be retried after transient gateway/network failures; writes and actions are not retried automatically. Retry count, backoff, timeouts and redirects are configurable on Config (setMaxRetries(), setRetryBackoff(), setConnectTimeout(), setTimeout(), setMaxRedirects()).
• A default context can be set once with Config::setDefaultContext(); explicit per-call context wins key by key.
• Client::fieldsOf() caches fields_get per instance; call clearFieldsCache() after module upgrades.
• Events are dispatched after the remote mutation has committed: a listener exception is logged, never reported as an Odoo failure.
• Stripe and Peppol live in Addon\Stripe and Addon\Peppol (Odoo::$stripe, Odoo::$peppol); the previous service methods remain as deprecated proxies.
• HTTP 401, HTTP 403, network failures and Odoo validation errors use distinct exception types.
• HTTP calls use an injectable transport; cURL is only the zero-configuration fallback.
• A custom adapter can be injected into Client for tests or alternative transports.
• Each JSON-2 call is a separate Odoo transaction. Multi-call business workflows are not atomic.

HTTP transport

The public HTTP boundary is transport-agnostic. With ext-curl installed, no additional configuration is needed. To reuse Guzzle, Symfony HttpClient, or another PSR-18 client, inject Psr18Transport through the configuration.

Guzzle:

Symfony HttpClient:

Redirects are handled consistently by this package. Sensitive JSON-2 headers are removed when a redirect changes origin, and portal PDF requests never receive the API bearer token.

Development

License

MIT. See LICENSE.