Generate eBay API Credentials and Connect Account

This guide explains how to set up eBay API credentials from the eBay Developer Portal and connect your eBay account to Odoo.

Step 1: Create An eBay Developer Account

  1. Go to the eBay Developer Portal.

  2. Sign in with your eBay account or create a new developer account.

  3. Once logged in, you will be on the developer dashboard.

Step 2: Create An Application

  1. From the developer dashboard, click on Create Application.

  2. Enter an Application Title (e.g., Odoo eBay Integration).

  3. Select the environment: Sandbox for testing or Production for live.

  4. Click Create.

    After creation, your application will have three keys:

    • App ID (Client ID): Used to identify your application.

    • Dev ID: Required for the eBay Trading API.

    • Cert ID (Client Secret): Used for OAuth token exchange.

  5. Fill in the following fields:

    • App ID (Client ID): Paste the App ID from the eBay Developer Portal.

    • Cert ID (Client Secret): Paste the Cert ID from the eBay Developer Portal.

    • Dev ID: Paste the Dev ID from the eBay Developer Portal.

    • eBay Website (Marketplace site): Of your store.

    eBay instance credentials tab with App ID, Cert ID and Dev ID fields

Step 3: Configure OAuth Redirect Settings (Generate RuName)

Before you can connect your eBay account, you need to configure the OAuth redirect URL and generate a RuName.

  1. In your Odoo instance, navigate to the Credentials tab of your eBay instance.

  2. Copy the OAuth Callback URL shown on the instance form.

    instance OAuth Callback URL field with copy button

  3. Go back to the eBay Developer Portal, open your application.

  4. Navigate to the User Tokens section for your environment (Sandbox or Production).

  5. Under Your eBay Redirect URL (RuName), paste the OAuth Callback URL copied from Odoo into both:

    • Auth Accepted URL

    • Auth Declined URL

    eBay Developer Portal User Tokens section with redirect URL fields

  6. Click Save or Add. eBay will generate a RuName for this configuration.

  7. Copy the generated RuName. Paste it into the RuName field in your Odoo instance.

    Set generated RuName to Odoo eBay instance

Warning

The OAuth Callback URL must be a publicly accessible URL. If your Odoo instance is behind a firewall or uses a local domain, eBay will not be able to redirect back after authentication.

Important

All four credential fields (App ID, Cert ID, Dev ID, RuName) are required. The Connect eBay Account button will not work without them.

Step 4: Configure Account Deletion Notification (Production Only)

Note

This step is only required for Production environments. It is not needed for Sandbox.

eBay requires a notification endpoint for account deletion/closure events to comply with GDPR regulations.

  1. In your Odoo instance, on the Credentials tab, copy the following:

    • Account Deletion Notification Endpoint: The URL where eBay sends notifications.

    • Account Deletion Verification Token: The token used to validate the endpoint.

    eBay instance Account Deletion Endpoint and Verification Token fields

  2. In the eBay Developer Portal, navigate to your application’s Account Deletion/Closure Notifications settings.

  3. Add the Account Deletion Notification Endpoint URL copied from Odoo.

  4. Enter the Account Deletion Verification Token copied from Odoo.

  5. Click Verify or Save. eBay will send a verification challenge to confirm the endpoint is valid.

Tip

The endpoint URL and verification token are auto-generated by Odoo. You only need to copy and paste them into the eBay Developer Portal. If needed, you can regenerate the verification token using the refresh button next to the field.

Step 5: Connect eBay Account

  1. On your eBay instance in Odoo, click the Connect eBay Account button.

    eBay instance with Connect eBay Account button

  2. You will be redirected to the eBay login/consent page.

  3. Log in with your eBay seller account.

  4. Review the requested permissions and click Agree to grant access.

    eBay OAuth consent page showing requested permissions

  5. After granting access, you will be redirected back to your Odoo instance.

    Redirected back to Odoo instance

  6. The access token and refresh token are automatically generated and stored securely in your Odoo instance.

Step 6: Test The Connection

  1. Click Test Connection in your Odoo instance.

    eBay instance with Test Connection button

  2. If the configuration is correct, a success message will appear confirming the connection.

    eBay Test Connection success message

  3. You can now proceed with the instance configuration and confirmation.

Note

  • Refresh tokens expire after 18 months. When the refresh token is about to expire (within 30 days), the connector creates a reminder activity on the instance. If the refresh token expires, you will need to reconnect your eBay account by clicking the Connect eBay Account button again.

  • After testing the connection, you can configure and confirm the instance.

See also