# 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

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-cover data-type="image">Cover image</th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Getting Started</strong></td><td><a href="https://images.unsplash.com/photo-1756992293716-b843700b5ab0?crop=entropy&#x26;cs=srgb&#x26;fm=jpg&#x26;ixid=M3wxOTcwMjR8MHwxfHJhbmRvbXx8fHx8fHx8fDE3NTc1NjkxNjZ8&#x26;ixlib=rb-4.1.0&#x26;q=85">https://images.unsplash.com/photo-1756992293716-b843700b5ab0?crop=entropy&#x26;cs=srgb&#x26;fm=jpg&#x26;ixid=M3wxOTcwMjR8MHwxfHJhbmRvbXx8fHx8fHx8fDE3NTc1NjkxNjZ8&#x26;ixlib=rb-4.1.0&#x26;q=85</a></td><td></td><td><a href="/pages/CyH2xJQs9yWJ1S8BYNav">/pages/CyH2xJQs9yWJ1S8BYNav</a></td></tr><tr><td><strong>SDK</strong></td><td><a href="https://images.unsplash.com/photo-1755308482556-9e8383a5be97?crop=entropy&#x26;cs=srgb&#x26;fm=jpg&#x26;ixid=M3wxOTcwMjR8MHwxfHJhbmRvbXx8fHx8fHx8fDE3NTc1NjkxOTd8&#x26;ixlib=rb-4.1.0&#x26;q=85">https://images.unsplash.com/photo-1755308482556-9e8383a5be97?crop=entropy&#x26;cs=srgb&#x26;fm=jpg&#x26;ixid=M3wxOTcwMjR8MHwxfHJhbmRvbXx8fHx8fHx8fDE3NTc1NjkxOTd8&#x26;ixlib=rb-4.1.0&#x26;q=85</a></td><td></td><td><a href="/pages/JjjojIyKxaiBPzzLwvtg">/pages/JjjojIyKxaiBPzzLwvtg</a></td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://theodxproxy.gitbook.io/odoo-api-proxy/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
