Set up the Odoo integration

​

Prerequisites

• ✅ Sync2Books account — An active Sync2Books account with the Odoo integration enabled for your application
• ✅ A running Odoo instance — Self-hosted, Odoo.sh, or Odoo Online. Sync2Books doesn’t provision one for you
• ✅ Network reachability — Sync2Books’ servers must be able to reach the merchant’s Odoo url over HTTPS. If Odoo sits behind a firewall or VPN with no public ingress, the merchant needs to allowlist Sync2Books’ egress IPs first

​

What the merchant needs to provide

​

Finding the database name

• Odoo Online (odoo.com): the database name is almost always the subdomain chosen at signup — my-company.odoo.com → database my-company.
• Self-hosted / Odoo.sh: visit <odoo-url>/web/database/selector to list all databases on that server. If there’s only one, Odoo may skip straight to login — the merchant’s Odoo admin can find it in odoo.conf’s db_name line. This is also the screen where the database name is chosen, the first time a self-hosted instance is set up:

​

Generating an API key

1

Open the account menu

Click the profile icon (top-right) → Preferences.

2

Account Security → New API Key

3

Confirm password

Odoo re-asks for the password before generating a key — this is expected.

4

Name the key and set an expiry

The validity duration defaults to 1 Day. If the merchant clicks “Generate key” without changing this, the key — and the Sync2Books connection — silently stops working the next day. Pick a long duration, or “No expiration” if offered.

5

Copy the key immediately

Odoo shows the key exactly once. If the dialog is closed without copying it, there’s no way to view it again — the merchant would have to delete the key and generate a new one.

​

Connect a company

curl -X POST "https://api.sync2books.com/companies/{companyId}/odoo/connect" \
  -H "x-api-key: {apiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://my-company.odoo.com",
    "database": "my-company",
    "username": "admin@example.com",
    "apiKey": "{odoo_api_key}"
  }'

{
  "id": "connection-uuid",
  "integrationKey": "odoo",
  "companyId": "company-uuid",
  "status": "connected",
  "providerMetadata": {
    "url": "https://my-company.odoo.com",
    "database": "my-company",
    "username": "admin@example.com"
  }
}

​

Reconnecting

curl -X POST "https://api.sync2books.com/companies/{companyId}/odoo/connect" \
  -H "x-api-key: {apiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://my-company.odoo.com",
    "database": "my-company",
    "username": "admin@example.com",
    "apiKey": "new-api-key-here",
    "connectionId": "connection-uuid"
  }'

​

Verify the connection

curl -X GET "https://api.sync2books.com/connections/company/{companyId}/integration/odoo" \
  -H "x-api-key: {apiKey}"

​

Read next

• Odoo overview - Learn about the integration
• Odoo integration reference - API reference
• Odoo FAQs - Common questions