odoo-api-skill

Reference Odoo XML-RPC and JSON-RPC APIs for CRUD and batch operations.

Updated Apr 12, 2026
One-click install
npx skills add https://github.com/LiuDaZheng/odoo-knowledge-base --skill odoo-api-skill
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: odoo-api-skill
Source: https://github.com/LiuDaZheng/odoo-knowledge-base/tree/main/src/skills/odoo-api-skill
Command: npx skills add https://github.com/LiuDaZheng/odoo-knowledge-base --skill odoo-api-skill

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Odoo's XML-RPC and JSON-RPC surfaces are powerful but fragmented across endpoints, languages, and best practices; this Skill consolidates authentication methods, CRUD patterns, batch strategies, and error-handling guidance into a single, practical reference so integrators stop guessing and start building reliable data flows.

Core Features & Use Cases

  • Protocol Reference: Clear differences and recommended usage for XML-RPC and JSON-RPC endpoints.
  • Authentication & Security: Guidance for username/password, API keys, and OAuth plus HTTPS and credential handling.
  • CRUD & Batch Operations: Search, read, create, write, unlink, search_read and bulk import patterns with one2many/many2many command handling.
  • Operational Best Practices: Connection pooling, retry/exponential backoff, pagination, limiting fields, logging, and monitoring strategies.
  • Multi-language Examples: Practical code samples for Python, JavaScript/Node.js, PHP, cURL and guidance for tests and integration scripts.
  • Use Case: Synchronize external CRM customers into Odoo, create sale orders in bulk, and implement robust retry and logging to avoid data loss.

Quick Start

Connect to your Odoo instance, authenticate (preferably with an API key), and perform a search_read on sale.order to return the first 10 draft orders.

Frequently Asked Questions about odoo-api-skill

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I authenticate with the Odoo API using JSON-RPC or XML-RPC?

Odoo API authentication supports username/password, API keys, and OAuth methods. When integrating external systems via JSON-RPC or XML-RPC, prefer API keys for secure credential handling and establish connections over HTTPS.

What is the best way to perform batch operations and bulk imports with the Odoo API?

Odoo API batch operations use search_read, create, write, and unlink patterns for bulk imports. Handle one2many and many2many relationships with specific command tuples to ensure reliable data synchronization across external systems.

How do I handle errors and retries when integrating with the Odoo API?

Odoo API error handling requires implementing retry logic with exponential backoff. Combine this with connection pooling, pagination, and field limiting strategies to ensure robust data synchronization and prevent data loss during network disruptions.

Does the Odoo API support multi-language code samples for external integrations?

Odoo API integration supports multi-language code samples including Python, JavaScript/Node.js, PHP, and cURL. These examples cover authentication, CRUD operations, and batch processing for synchronizing external CRM customers and creating sale orders.

When should I choose JSON-RPC over XML-RPC for Odoo API integration?

Choosing between JSON-RPC and XML-RPC for Odoo API integration depends on your system architecture. Both protocols handle CRUD operations and data synchronization, but JSON-RPC is generally preferred for modern web applications due to lighter payload parsing.