iTechGuides is reader-supported. When you buy through links on our site, we may earn an affiliate commission. As an Amazon Associate I earn from qualifying purchases. Learn more
Odoo can connect to ecommerce stores, marketplaces, accounting platforms, warehouses, CRM systems, and internal applications through its external API. For a new integration, start by checking your Odoo release and subscription: current Odoo documentation presents External JSON-2 as the replacement for the older XML-RPC and JSON-RPC interfaces, while external API access is restricted to Custom pricing plans. A reliable connection then follows a disciplined path: create a least-privilege integration user, protect an API key, inspect models and fields, map records, make retries idempotent, and reconcile the two systems. This guide explains that process, the API choices, an Amazon order-and-inventory example, no-code alternatives, and the failure points that commonly break production synchronizations.
What does an Odoo API integration do?
An Odoo API integration lets another application read or change Odoo business objects through authenticated web requests. Those objects include contacts, products, sales orders, invoices, deliveries, stock quantities, projects, and custom models. The external application remains responsible for translating its own data model into Odoo fields, deciding when to send changes, recording failures, and proving that both systems eventually agree.
A useful integration is more than a successful login. It defines which system owns each field, how records are matched, what happens when a user edits both systems, how deleted or cancelled records are represented, and how a timed-out request can be retried without creating a duplicate order. Treat the API as one component in an integration layer that also contains mapping, queues, secrets management, monitoring, and reconciliation.
Recommended Free Tools
Which Odoo API should a new integration use?
For greenfield work, evaluate External JSON-2 first. Odoo’s current master documentation says the XML-RPC and JSON-RPC endpoints are deprecated and describes External JSON-2 as their replacement. Existing Odoo 18-era systems may still use the Models API over XML-RPC, but a long-lived project should include a migration path rather than deepen a dependency on deprecated endpoints.
#1 Best Overall
- Read Before You Buy — No Video Output: These adapters support charging and USB 2.0 data transfer, but cannot transmit video signals. Except for standard USB webcams (which use USB data only), they are not compatible with HDMI/DisplayPort cables, video-capable USB-C hubs, or docking stations with video output.
- Convert USB-A Ports to USB-C: Designed to connect USB-C earphones, cables, flash drives, card readers, and other USB-C accessories to standard USB-A ports. Plug-and-play with no drivers or software required.
- Aluminum Alloy Housing: Built with a sturdy aluminum alloy shell that aids in heat dissipation and protects against daily wear and scratches. Designed to maintain a stable and secure connection.
- Compact & Travel-Friendly: The ultra-compact design allows the adapter to stay plugged into your device without blocking adjacent ports or adding bulk, reducing wear and tear on your original USB ports.
- 12-Month Warranty: Backed by a 12-month manufacturer warranty for peace of mind. Designed to meet strict quality control standards for reliable everyday performance.
| Interface | Current position | Where it fits | Planning note |
|---|---|---|---|
| External JSON-2 | Documented replacement | New integrations and migrations | Test the exact endpoint and response shape against the Odoo release you will run |
| JSON-RPC | Deprecated in current master documentation | Existing integrations that have not yet migrated | Keep a retirement plan and avoid designing new contracts around it |
| XML-RPC | Deprecated in current master documentation; documented for Odoo 18-era Models API use | Legacy clients using execute_kw |
Useful while a migration is staged, but verify compatibility on every upgrade |
The documentation gives a planned removal horizon of Odoo 22 in fall 2028 and Online 21.1 in winter 2027 for the deprecated interfaces. These are policy targets, not a substitute for checking your own release notes, so confirm the dates before committing to a multi-year implementation.
How does the older XML-RPC call work?
In the Odoo 18-era Models API, a client authenticates and receives a user ID, then calls the object endpoint with the database name, user ID, password or API key, model name, method name, positional arguments, and keyword arguments. The method is commonly sent through execute_kw. Typical model methods include search, read, search_read, create, write, and unlink.
execute_kw(database, user_id, api_key, model, method, positional_args, keyword_args)This signature is a conceptual shape rather than a copy-and-paste production client. Your integration must apply the correct transport, content type, access rights, pagination, company context, and error handling for the specific Odoo release.
Which Odoo plans include external API access?
Odoo states that external API access is available only on Custom pricing plans. One App Free and Standard plans do not provide it, so confirm the subscription before selecting an architecture or promising a customer that a connector will work.
| Odoo plan | External API access | Implication |
|---|---|---|
| One App Free | Not available | An external system cannot use Odoo’s external API under this plan |
| Standard | Not available | Move to an eligible plan before building API-dependent synchronization |
| Custom | Available | Check release-specific API behavior, user permissions, and commercial terms |
How do you prepare an Odoo integration before writing code?
Preparation prevents most expensive rework. Complete these checks before creating endpoints or mapping spreadsheets.
- Record the exact release and hosting type. The available interface and deprecation timetable depend on the Odoo version, and online deployments can have a different upgrade schedule from self-hosted installations.
- Verify the Custom plan. API availability is a commercial prerequisite, not merely a technical setting.
- List business objects and ownership. Decide whether Odoo or the connected application is authoritative for product names, prices, tax codes, stock, customers, orders, invoices, and shipment status.
- Define volume and timing. A nightly export, near-real-time order feed, and high-frequency inventory reservation have very different queue, retry, and reconciliation requirements.
- Choose stable external identifiers. Preserve the source system’s order ID, SKU, customer ID, or shipment ID in Odoo so lookups do not depend on names that users can change.
- Document company and warehouse context. Multi-company and multi-warehouse records can appear correct while being assigned to the wrong company, location, or route if context is omitted.
How do you create a secure Odoo integration user and API key?
Use a dedicated user with only the groups and model permissions required by the integration. Do not reuse an administrator account: excessive rights turn a connector compromise into a full database compromise.
- In Odoo, create or select the integration user and assign the minimum read, create, write, or delete permissions required by the agreed workflow.
- Open Preferences → Account Security and generate an API key. API keys were introduced in Odoo 14.0.
- Store the key in a secrets manager or protected server-side environment variable. Never place it in browser JavaScript, a mobile application, a public repository, screenshots, or support tickets.
- Use the key in place of the password for web-service operations. Odoo’s documentation treats the key as equivalent to the password for API calls.
- Record ownership, creation date, intended systems, and a rotation or revocation procedure. Test revocation in a staging environment so an emergency credential change does not become an outage.
How do you discover Odoo models and fields safely?
Do not guess field names from a screen label. Inspect model metadata and use fields_get() where appropriate, then verify field types, required values, selection options, relational targets, access rights, company context, and whether a field is computed or read-only.
Start with a small read-only account and a staging database. Retrieve one representative record, inspect its relational IDs and status values, and identify which fields are safe to write. For a many-to-one field, your mapping normally needs an Odoo record ID or a deterministic lookup by an external identifier. For one-to-many lines, establish whether the API expects commands that create, update, or remove child records.
Rank #2
- 5-in-1 USB-C Hub: Experience comprehensive connectivity featuring a Power Delivery input, two USB-A 2.0 ports, a USB-A 3.0 port, and an HDMI port. (Note: The USB-C power delivery input port is only for connecting an external wall charger to power your laptop and cannot power peripheral devices.)
- 90W Pass-Through Charging: Achieve optimal charging with 90W pass-through power to your laptop, supported by a total input of 100W, with the hub reserving 10W for operational efficiency. (Note: Wall charger not included.)
- Quick Data Transfers: Accelerate your productivity with rapid data transfers using a high-speed 5Gbps USB 3.0 port and two 480Mbps USB 2.0 ports.
- 4K HDMI Display: Enhance your visual experience with a hub capable of delivering 4K resolution at 30Hz in both mirror and extend modes. Please note that this hub is compatible with MacBook (macOS 12 and newer), Windows 10 and 11, ChromeOS, and laptops equipped with DP Alt Mode and Power Delivery. Note: This device is not compatible with Linux.
- What You Get: Anker USB-C Hub (5-in-1, 4K HDMI), welcome guide, 18-month warranty, and our friendly customer service.
Metadata discovery should also cover business rules that are not obvious from the schema. Confirm whether an order must be confirmed before a delivery is created, whether an invoice can be posted by the integration user, and which workflow transitions trigger emails, reservations, or accounting entries.
How do you authenticate and call Odoo methods?
The exact request depends on whether you use JSON-2 or a legacy RPC client, but the operational sequence is consistent: authenticate, call a narrowly scoped model method, validate the response, and persist a correlation record.
- Authenticate. Obtain the user identity required by the chosen interface, or configure the JSON-2 authentication flow documented for your release.
- Address one model deliberately. Include the model and method rather than issuing broad, administrator-style operations.
- Send explicit arguments. Supply domains, field lists, limits, offsets, ordering, and company context where supported. Explicit parameters make a replay understandable.
- Validate the response. Check that the returned ID, status, quantity, or timestamp is the expected type and value before marking the source record synchronized.
- Record a correlation ID. Log your request ID, source ID, Odoo ID, operation, result, and failure class without logging the API key or unnecessary personal data.
Use search_read for bounded read workflows, but avoid unbounded scans. Paginate large datasets, request only needed fields, and checkpoint progress so a process restart does not begin from zero.
Quick wins for a faster PC:
Clear out junk files and repair common Windows errorsFree Scan →Fix the driver behind crashes, sound loss and screen glitchesFind Drivers →How should records, conflicts, and retries be mapped?
Design the mapping before the first live write. A mapping specification should name the source field, Odoo model and field, conversion rule, required/optional status, validation rule, and owner when values conflict.
Use an external key for idempotency
Store a unique source identifier on the Odoo record, using a dedicated field or an approved external-ID mechanism. On every retry, look up that identifier first. If it exists, update the known record or verify that the payload is unchanged; if it does not, create the record and persist the new Odoo ID. This prevents a network timeout after a successful create from producing a second order when the client retries.
Define conflict rules explicitly
Choose a policy for simultaneous edits: Odoo wins, the source system wins, latest timestamp wins, or a human review queue handles the conflict. Include timezone and clock-skew rules in that decision. Never silently overwrite a tax code, stock quantity, or posted accounting value simply because an incoming record is newer by wall-clock time.
Separate transient and permanent failures
Retry timeouts, connection resets, and temporary server errors with exponential backoff and a maximum attempt count. Do not blindly retry authentication failures, permission errors, invalid field values, or business-rule violations. Send permanent failures to a durable queue with the payload, validation message, and operator action required.
What operational controls keep synchronization reliable?
Production integrations need visibility equal to their business impact. At minimum, implement the following controls.
Rank #3
- Sleek 7-in-1 USB-C Hub: Features an HDMI port, two USB-A 3.0 ports, and a USB-C data port, each providing 5Gbps transfer speeds. It also includes a USB-C PD input port for charging up to 100W and dual SD and TF card slots, all in a compact design.
- Flawless 4K@60Hz Video with HDMI: Delivers exceptional clarity and smoothness with its 4K@60Hz HDMI port, making it ideal for high-definition presentations and entertainment. (Note: Only the HDMI port supports video projection; the USB-C port is for data transfer only.)
- Double Up on Efficiency: The two USB-A 3.0 ports and a USB-C port support a fast 5Gbps data rate, significantly boosting your transfer speeds and improving productivity.
- Fast and Reliable 85W Charging: Offers high-capacity, speedy charging for laptops up to 85W, so you spend less time tethered to an outlet and more time being productive.
- What You Get: Anker USB-C Hub (7-in-1), welcome guide, 18-month warranty, and our friendly customer service.
- Structured logs: capture operation, source ID, Odoo ID, request ID, attempt number, latency, and outcome. Redact credentials and sensitive customer data.
- Dead-letter handling: retain messages that exceed retry limits so an operator can correct data and replay them.
- Rate and load protection: use bounded concurrency, pagination, backoff, and queue depth alerts rather than sending an unrestricted burst.
- Reconciliation: compare order counts, monetary totals, available stock, shipment states, and last-update watermarks by period and company.
- Replay tools: allow a failed message or date range to be replayed after a fix, while preserving idempotency.
- Audit trail: record who changed mapping rules, credentials, permissions, and endpoint versions.
Reconciliation should be independent of the normal success path. A connector can report every request as successful while dropping records because a filter, company context, or pagination cursor was wrong.
Can Odoo synchronize Amazon orders and inventory?
Yes. Odoo’s Amazon Connector is designed for this use case, provided the seller already has a paid Amazon Seller account. In Odoo, enable Amazon Sync through Sales → Configuration → Settings, then configure seller credentials and marketplaces according to the connector’s setup flow.
The official feature documentation describes synchronization of confirmed Fulfillment by Amazon (FBA) and Fulfillment by Merchant (FBM) orders and order items, creation of missing partner records, notification to Amazon when confirmed FBM shipments are sent, and synchronization of available FBM quantities. It also supports multiple seller accounts and marketplaces.
What’s actually slowing this PC down?
Pick the symptom - the matching free tool is one click away.
Before choosing the built-in connector or another module, decide which records must be authoritative. Product identifiers, tax treatment, shipping services, cancellations, returns, and inventory reservations often require more policy than a simple order import. Test partial shipments, cancelled orders, duplicate marketplace notifications, and an item that exists on Amazon but not yet in Odoo.
What should you compare in an Amazon connector?
| Decision area | Questions to answer |
|---|---|
| Version and API | Which Odoo releases are supported, and does the connector use a current interface or a legacy one? |
| Synchronization direction | Does data flow Amazon to Odoo, Odoo to Amazon, or both, and which events start each flow? |
| Object coverage | Are orders, products, inventory, invoices, deliveries, returns, and partner records included? |
| Credentials | Who owns the marketplace credentials, where are they stored, and how are they rotated? |
| Reliability | Are retries, duplicate detection, dead-letter handling, and reconciliation provided? |
| Hosting and support | Does it run on your Odoo hosting arrangement, and who handles upgrades or failed jobs? |
| Total cost | Include Odoo’s required plan, connector or module fees, marketplace charges, implementation, monitoring, and maintenance. |
When is a no-code connector enough?
Ready-made workflow services can connect Odoo triggers and actions without a custom application. Make publishes Odoo workflow templates, and Zapier describes a trigger/action model for moving data between applications. These tools are often suitable for a lead notification, task creation, or a low-volume status update.
Use a stronger integration layer when the workflow affects accounting, inventory, fulfillment, or high order volume. A visual recipe may not provide the field-level idempotency, queue durability, transaction ordering, error classification, and reconciliation needed to protect financial or stock data. Confirm that the service can reach your Odoo hosting environment and that credentials remain server-side.
Zapier’s current partner-program page describes an ecosystem of more than 8,000 integrations. That breadth can reduce one-off connector work, but it does not prove that a particular Odoo workflow supports your models, volume, permissions, or compliance requirements.
The Tool Desk
Outbyte PC Repair FREEClear out junk files and repair common Windows errorsFree Scan →Outbyte Driver Updater FREEFix the driver behind crashes, sound loss and screen glitchesFind Drivers →What third-party Odoo modules can add?
Third-party modules can extend marketplace coverage or delegate synchronization to another platform. One vendor listing describes an Amazon connector for Odoo version 18; treat its supported features, maintenance, and listed price as vendor-specific and verify them before purchase. Another module, described as Base Connector for Odoo – Amazon, exposes an API key to Base.com, with Base handling Amazon synchronization across 23 marketplaces and requiring an active Base subscription.
Rank #4
- Dual Converters, Infinite Potential：Includes 2× USB C male to USB A female adapters and 2× USB A male to USB C female adapters. Perfect for a wide range of uses—tablets with Bluetooth keyboards, expand USB ports on macbook, and more. Two different converters for all your daily needs
- Next-Level 10Gbps & 3A Charging: No more slow 480Mbps, this usb to usb c adapter has a transfer speed of up to 10Gbps, allowing you to do more transferring in less time. This usb adapter fits both USB A and USB C charger, supporting up to 3A fast charging
- Upgraded Exquisite Craftsmanship: With an aluminum alloy housing and metal connector, the usbc to usb adapter is extremely durable and sturdy. Rigorously tested to withstand more than 10,000 times of plugging and unplugging, ensuring long-lasting performance
- Broad Compatible: The usb c to usb adapter widely supports all USB C/ USB A devices like laptops, tablets, cellphones, car chargers, and phone chargers. Such as compatible with MacBook Pro/Air 2023/2022, Thunderbolt 4/3 Devices,Apple MagSafe Watch 9/8/7/SE/Ultra, iPad Pro 2022/2021, Samsung Galaxy S23/S20/S10, and iPhone 17/16/15 Pro. Plug and play
- Please Note: To reach 10Gbps speed, keep the cable under 3.3 ft. For USB A Male to USB C adapters, try flipping the USB C connector. USB C Male to USB A adapters support bidirectional 10Gbps transfer within 3.3 ft
Evaluate such modules with a sandbox and a written acceptance test. Confirm upgrade support for your exact Odoo edition, source-code access or escrow expectations, data residency, credential ownership, uninstall behavior, and what happens to queued jobs when the module is disabled.
How do you test an Odoo integration before launch?
Use a staged test plan instead of a single successful create request.
- Schema tests: verify required fields, selection values, relational lookups, decimal precision, currencies, and timezone conversion.
- Permission tests: run every operation with the real integration user and confirm that forbidden writes fail safely.
- Workflow tests: create, update, confirm, cancel, ship, invoice, and return representative records where those transitions apply.
- Replay tests: force a timeout after a create and replay the message; verify that only one Odoo record exists.
- Recovery tests: revoke the key, disable the target service, fill the queue, and restore service. Confirm alerting and replay behavior.
- Reconciliation tests: compare source and Odoo counts and totals after each batch, including a deliberately rejected record.
- Upgrade tests: run the suite against the exact Odoo release and hosting environment planned for production.
How do you migrate XML-RPC or JSON-RPC to JSON-2?
Do not treat the migration as a transport-only rewrite. Inventory every model, method, domain, field list, context value, error parser, and retry assumption in the existing client.
Do these 3 things before closing this tab:
1Clear out junk files and repair common Windows errors2Scan for outdated or missing drivers - takes under a minute3Repair Windows errors before they cause bigger problems- Capture the current integration’s real request and response contracts in a staging environment.
- Map each operation to its External JSON-2 equivalent and identify differences in authentication, payload shape, batching, errors, and pagination.
- Build an adapter so business mapping is independent of the transport. This lets you run old and new clients against the same test cases.
- Replay representative historical messages, including duplicates, out-of-order updates, cancelled orders, and permission failures.
- Run a period of dual observation or shadow reads where practical, comparing IDs, totals, statuses, and latency without double-writing business records.
- Switch writes during a controlled window, retain rollback procedures, and monitor reconciliation more closely than normal.
Because Odoo’s published removal horizon is tied to future releases, recheck the current documentation before scheduling the final cutover. A plan made for an older release can become unsafe after an upgrade.
What are the most common Odoo integration failures?
Authentication works in a browser but not in the connector
Check that the connector is using the API key rather than an interactive password, the correct database and user, and a server-side secret. Confirm the user has the required groups and that the key has not been revoked or copied with extra whitespace.
Records are created twice
This usually means the client marks a message failed after Odoo committed it, then retries without an external identifier lookup. Add an idempotency key, persist the Odoo ID, and make create-or-update behavior explicit.
Inventory totals disagree
Check company, warehouse, location, unit-of-measure, and timestamp context before changing quantities. Compare available-to-promise values with the source system’s definition; a raw on-hand figure may not mean the same thing as sellable stock.
Outdated Drivers Are Slowing You Down
One free scan finds every outdated or missing driver and matches the right update for your exact hardware.Free scan · exact hardware matchWindows Errors? Fix Them Before They Spread
Repair common Windows errors and clear accumulated junk for a smoother, more stable PC - no reinstall needed.Free scan · no reinstallWrites fail after an Odoo upgrade
Re-run metadata discovery and permission tests. Fields, selection values, workflow rules, and deprecated endpoints can change between releases; pin the client to a tested release contract and schedule upgrades as integration work, not routine maintenance.
Best Value
- 5-in-1 Connectivity: Equipped with a 4K HDMI port, a 5 Gbps USB-C data port, two 5 Gbps USB-A ports, and a USB C 100W PD-IN port. Note: The USB C 100W PD-IN port supports only charging and does not support data transfer devices such as headphones or speakers.
- Powerful Pass-Through Charging: Supports up to 85W pass-through charging so you can power up your laptop while you use the hub. Note: Pass-through charging requires a charger (not included). Note: To achieve full power for iPad, we recommend using a 45W wall charger.
- Transfer Files in Seconds: Move files to and from your laptop at speeds of up to 5 Gbps via the USB-C and USB-A data ports. Note: The USB C 5Gbps Data port does not support video output.
- HD Display: Connect to the HDMI port to stream or mirror content to an external monitor in resolutions of up to 4K@30Hz. Note: The USB-C ports do not support video output.
- What You Get: Anker 332 USB-C Hub (5-in-1), welcome guide, our worry-free 18-month warranty, and friendly customer service.
Which integration approach should you choose?
Choose External JSON-2 with a custom integration layer when the connection is strategic, bidirectional, high-volume, or responsible for accounting and inventory. Use the built-in Amazon Connector when its documented order, shipment, quantity, marketplace, and seller-account behavior matches your process and you accept its hosting and upgrade constraints. Use a no-code workflow for small, low-risk automations where occasional manual repair is acceptable. Use a third-party module only after verifying release support, credential ownership, retry behavior, reconciliation, and the full recurring cost.
Whichever route you choose, the durable design principles are the same: verify the Custom plan, use a least-privilege user and protected API key, discover the schema, map stable identifiers, make retries idempotent, monitor every queue, and reconcile business totals. Those controls matter more than the choice of client library.
Frequently Asked Questions
Can I use an Odoo API key from a browser application?
Do not expose it in browser code. An Odoo API key has password-equivalent access for web-service operations, so calls should pass through a server-side service that keeps the key in protected configuration and applies its own authorization rules.
Free tools Windows power users keep installed
One-click scans. No signup required.
Does an Odoo integration automatically synchronize custom fields?
No. A custom field must be discovered, included in the mapping, validated for its type and permissions, and tested through the relevant workflow. Computed or read-only fields may be available for reads but unsuitable for writes.
How often should an Odoo connector reconcile data?
Set the interval according to business risk and volume rather than a universal timer. Inventory and fulfillment feeds may need frequent checks, while a financial export can reconcile by batch; always run an independent comparison of counts, totals, and statuses.
What happens if an Odoo API request times out?
A timeout does not prove that Odoo rolled back the operation. Retry only through an idempotent workflow: search by the source identifier, inspect the existing record, and then create or update as appropriate instead of issuing an unconditional create.
Will an Odoo plan upgrade alone fix a broken connector?
It may provide the required external API entitlement, but it does not resolve incorrect permissions, deprecated endpoints, field mappings, credentials, or workflow assumptions. Re-test authentication, metadata, writes, retries, and reconciliation after any plan or version change.
Quick Recap
Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.
