Odoo Integration Guide

This guide will walk you through integrating Claudery with your Odoo e-commerce platform. Odoo uses XML-RPC API which is built-in and doesn’t require additional setup, but you’ll need to generate an API key for authentication (Odoo 16 and above).

Important: API key generation is only available in Odoo version 16 and above. If you’re using an older version of Odoo, you may need to upgrade or use password-based authentication (not recommended for production).

Prerequisites
  • Odoo instance version 16 or above (recommended)
  • Administrator access to your Odoo backend
  • E-commerce module installed and configured in Odoo
  • Claudery SaaS account and access to the Claudery dashboard
Step 1: Get Your Odoo URL and Database Information
1.1 Find Your Odoo URL
  1. Log in to your Odoo instance
  2. Your Odoo URL is the base URL of your Odoo installation
  3. For Odoo.com (SaaS): Format is https://yourcompany.odoo.com
  4. For self-hosted: Format is https://yourdomain.com or http://localhost:8069
  5. Note this URL – you’ll need it for configuration
1.2 Find Your Database Name
  1. When you log in to Odoo, you may see a database selection screen
  2. The database name is typically displayed in the login screen or URL
  3. Common database names: odoo, production_db, or your company name
  4. If unsure, check with your Odoo administrator or hosting provider
Step 2: Generate API Key (Odoo 16+)
2.1 Navigate to User Settings
  1. Log in to your Odoo backend
  2. Click on your user profile (usually in the top right corner)
  3. Select Preferences or My Account
  4. Alternatively, go to Settings → Users & Companies → Users
  5. Click on your user account to edit
2.2 Access Account Security
  1. In the user form, look for the Account Security section
  2. If you don’t see it, make sure you’re in edit mode (click Edit button)
  3. Scroll down to find Account Security or API Keys section
2.3 Generate New API Key
  1. Click New API Key or Generate API Key button
  2. Enter a name for the API key (e.g., “Claudery Integration”)
  3. Click Generate or Create
  4. The API key will be displayed – copy it immediately

Important: Copy the API key immediately and store it securely. The key will only be displayed once and cannot be retrieved later. If you lose it, you’ll need to generate a new API key.

2.4 Verify API Key Permissions
  1. Ensure your user account has the necessary permissions:
    • Access to product management (Sales app)
    • Access to customer data
    • Access to order information
  2. API keys inherit the permissions of the user account they belong to
  3. If you need specific permissions, contact your Odoo administrator
Step 3: Get Your Username
3.1 Find Username
  1. Your username is the login name you use to access Odoo
  2. It’s typically your email address or a username you created
  3. You can find it in your user profile settings
  4. Note this down – you’ll need it along with the API key
Step 4: Configure Claudery Platform Settings
4.1 Access Claudery Dashboard
  1. Log in to your Claudery SaaS dashboard
  2. Navigate to your merchant site settings
  3. Go to the Quick Start section or Platform Settings
4.2 Select Odoo Platform
  1. Select Odoo as your e-commerce platform
  2. This will display the Odoo-specific credential fields
4.3 Enter Odoo URL
  1. Enter your Odoo instance URL in the URL field
  2. Use the full URL with protocol (e.g., https://mycompany.odoo.com)
  3. Do not include trailing slashes or paths like /web
  4. For self-hosted instances, include the port if not using standard ports (e.g., http://localhost:8069)
4.4 Enter Database Name
  1. Enter your Odoo database name in the Database field
  2. Use the exact database name as it appears in Odoo
  3. Common examples: odoo, production_db, mycompany_db
4.5 Enter Username
  1. Enter your Odoo username in the Username field
  2. This is the login name you use to access Odoo
  3. Usually an email address or username
4.6 Enter API Key
  1. Paste your Odoo API Key into the API Key field
  2. Ensure there are no extra spaces before or after the key
  3. This is the key you generated in Step 2.3
4.7 Test Connection
  1. Click the Test Connection or Save & Test button
  2. Wait for the connection test to complete
  3. If successful, you’ll see a confirmation message
  4. If there’s an error, verify all credentials are correct
Step 5: Sync Products
5.1 Initial Product Sync
  1. After successful connection, navigate to the Product Sync section
  2. Click Sync Products or Initial Sync
  3. Wait for the sync process to complete
  4. Monitor the progress – larger catalogs may take several minutes
5.2 Verify Sync
  1. Check the sync status in the dashboard
  2. Review the product count to ensure all products were synced
  3. If any products failed to sync, check the error logs for details
  4. Note: Odoo product templates and variants are both synced
Step 6: Configure Widget Settings
6.1 Get Widget Embed Code
  1. Navigate to Widget Settings in your Claudery dashboard
  2. Copy the provided JavaScript embed code
6.2 Add Widget to Odoo Website
  1. In Odoo, go to Website → Configuration → Settings
  2. Navigate to Customize → HTML/CSS/JS or use the theme editor
  3. Add the Claudery widget script to your website footer or header template
  4. Save and publish your changes
Troubleshooting
Connection Errors
  • Verify your Odoo URL is correct and accessible
  • Ensure your database name is correct (case-sensitive)
  • Check that your username is correct
  • Verify your API key is copied correctly (no extra spaces)
  • Ensure you’re using Odoo 16+ for API key support
  • Check that XML-RPC is enabled in your Odoo instance (usually enabled by default)
  • For self-hosted instances, verify the XML-RPC endpoint is accessible: {url}/xmlrpc/2/common
Sync Issues
  • Check that products exist in your Odoo e-commerce catalog
  • Review error logs in the Claudery dashboard for specific error messages
  • Verify your user account has permissions to read products
  • Check that the e-commerce module is installed and products are published
  • For multi-attribute products, ensure attributes are properly configured
  • Verify product templates have variants if using variable products
API Key Issues
  • If API key generation is not available, verify you’re using Odoo 16 or above
  • Check that your user account has permission to generate API keys
  • If the key doesn’t work, try generating a new one
  • Ensure the API key wasn’t revoked or deleted
  • For older Odoo versions, you may need to use password authentication (contact support)
Odoo Version Compatibility

Claudery’s Odoo integration is tested with Odoo version 16 and above. The integration uses Odoo’s built-in XML-RPC API, which is available in all Odoo versions, but API key authentication (recommended) is only available in version 16+.

For Odoo versions below 16, you may need to use password-based authentication, which is less secure and not recommended for production environments. Consider upgrading to Odoo 16 or above for better security.

Security Notes
  • Keep your API key secure – treat it like a password
  • If the API key is compromised, revoke it in Odoo and generate a new one
  • Use API keys instead of passwords for better security (Odoo 16+)
  • Regularly review API keys in your Odoo user settings
  • Use HTTPS for your Odoo URL to ensure secure communication
  • Consider using a dedicated user account for API access with minimal required permissions
  • For self-hosted instances, ensure XML-RPC endpoints are secured and not publicly accessible without authentication
API Information

Claudery uses Odoo’s XML-RPC API (version 2) for all operations. The integration supports:

  • Product templates and variants
  • Multi-attribute products (Brand, Color, Size, etc.)
  • Customer and order information
  • E-commerce catalog synchronization

Next Steps: Once integration is complete, you can customize your AI assistant settings, configure product search preferences, and start using Claudery’s AI-powered shopping features on your Odoo e-commerce site.