Page cover

Welcome to ODXProxy Documentation

Welcome to the official documentation for ODXProxy, a lightweight and efficient API proxy layer for Odoo. This guide is designed to help developers, integrators, and technical users interact with Odoo’s core models and modules through a simplified, secure, and standardized API interface.

Whether you're building third-party integrations, managing complex business processes, or just looking to streamline Odoo's native APIs, TheODXProxy provides a flexible foundation to work with.

What is ODXProxy?

TheODXProxy acts as a middleware that sits between your applications and an Odoo backend. It abstracts the complexity of Odoo’s native XML-RPC or JSON-RPC interfaces, offering a clean, REST-like API that is:

  • Fast and lightweight

  • Safe and secure

  • Easier to use and integrate

  • Extensible for custom modules

⚙️ Built for Performance

ODXProxy is written in Rust, using the high-performance Axum web framework and the asynchronous runtime Tokio. This modern tech stack enables:

  • Blazing-fast API response times

  • Low memory usage under high concurrency

  • Scalable architecture for enterprise workloads

  • Safety guarantees from Rust’s strong type system

Who is this for?

This documentation is intended for:

  • Backend developers who need to integrate Odoo with other systems.

  • DevOps or system architects deploying Odoo in large environments.

  • Technical consultants configuring custom business flows through API.

  • Anyone looking for a clean interface to access and manipulate Odoo data.

What You’ll Find Here

  • 📦 Core Concepts: Overview of TheODXProxy’s architecture and configuration.

  • ⚙️ Base Model Guides: How to work with key Odoo models like res.partner, product.product, sale.order, and more.

  • 🧩 Custom Modules: How to extend ODXProxy for your own models and business logic.

  • 🔐 Security & Auth: Authentication, permission handling, and API token usage.

  • 🛠️ Examples & Use Cases: Real-world usage examples and recommended practices.

Jump right in

Last updated