Skip to main content

Authorization

Follow this guide to create a new eBay Fulfillment API credential that will allow Nexla to authenticate to and exchange data with your eBay Fulfillment API account.
ebay_fulfillment_api_auth.png

eBay Fulfillment API

Prerequisites​

The eBay Fulfillment API uses OAuth 2.0 (3-legged authorization code flow), which requires you to register an application in the eBay Developer Program and obtain an App ID (Client ID) and Cert ID (Client Secret). These credentials identify your registered application and authorize it to act on behalf of an eBay seller account.

Register for the eBay Developer Program​

  1. Go to https://developer.ebay.com and sign in with your eBay account, or create a new eBay account if you do not already have one.

  2. Once signed in, navigate to Hi, [your name] in the top navigation and select Account to access the Developer Program account settings.

Create an Application Keyset​

  1. Navigate to Application Keys in the developer portal (or go directly to https://developer.ebay.com/my/keys).

  2. Click Create a keyset under the Production environment (use Sandbox for testing).

  3. Enter a name for your application in the Application Title field, then click Continue.

  4. Confirm your primary contact information when prompted, then click Submit.

  5. eBay will generate three key values for your application:

    • App ID (Client ID): Uniquely identifies your registered application. This value is used as the Client ID in the Nexla credential.

    • Dev ID: Uniquely identifies your developer account profile. This value is not required for Nexla configuration.

    • Cert ID (Client Secret): Acts as the client secret for token requests. Keep this value confidential—do not share or expose it publicly.

    Store your App ID and Cert ID in a secure location immediately after creation. The Cert ID is sensitive and should be treated like a password. For production use, always create a Production keyset; use the Sandbox keyset only for development and testing.

  6. Before you can use your Production keyset, eBay requires you to subscribe to or opt out of eBay marketplace account deletion/closure notifications. Follow the prompts on the Application Keys page to complete this step.

Configure OAuth Redirect URI​

  1. In the eBay Developer Portal, navigate to Get a Token from eBay via Your Application (or the OAuth settings section for your keyset).

  2. Add Nexla's OAuth redirect/callback URI as an allowed RuName (eBay Redirect URL name). eBay uses RuNames to map redirect URIs to your application. Consult your Nexla instance configuration or contact Nexla support for the exact redirect URI to register.

Confirm Required OAuth Scope​

  1. The eBay Fulfillment API requires the https://api.ebay.com/oauth/api_scope/sell.fulfillment OAuth scope to access order and shipping fulfillment data. This scope is pre-configured as the default in the Nexla eBay Fulfillment API credential. Confirm that your application keyset includes this scope by reviewing the scopes assigned to your keyset in the Developer Portal.

    For complete details on obtaining eBay OAuth credentials, see the Getting your OAuth credentials guide in the eBay Developers Program documentation.

Create an eBay Fulfillment API Credential​

  • To create a new eBay Fulfillment API credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

eBay OAuth2 (3-Legged) Authentication​

The eBay Fulfillment API credential uses a 3-legged OAuth 2.0 flow, which means an eBay seller must interactively grant your application access to manage orders and fulfillment on their behalf. After granting access, eBay issues access tokens that Nexla uses for all API calls.

  1. In the Authorization URL field, confirm or enter the eBay OAuth authorization endpoint. The default value is https://auth.ebay.com/oauth2/authorize and should not need to be changed for Production use. For Sandbox, use https://auth.sandbox.ebay.com/oauth2/authorize.

  2. Enter your application's App ID (also referred to as Client ID) in the Client ID (App ID) field. This is the App ID generated when you created your application keyset in the eBay Developer Portal.

  3. In the Access Scope field, enter the space-separated list of OAuth scopes that this credential will request. The default value is https://api.ebay.com/oauth/api_scope/sell.fulfillment, which grants access to view and manage order fulfillments. Additional scopes can be added as needed:

    • https://api.ebay.com/oauth/api_scope/sell.fulfillment — View and manage order fulfillments (required for the Fulfillment API)

    • https://api.ebay.com/oauth/api_scope/sell.finances — View and manage payment and order financial information (required for issuing refunds)

    • https://api.ebay.com/oauth/api_scope/sell.payment.dispute — View and manage payment disputes and related details

  4. In the Token URL field, confirm or enter the eBay token exchange endpoint. The default value is https://api.ebay.com/identity/v1/oauth2/token and is used to exchange authorization codes for access tokens.

  5. Enter your application's Cert ID (also referred to as Client Secret) in the Client Secret (Cert ID) field. This is the Cert ID generated alongside your App ID in the eBay Developer Portal. This value is stored securely and used to authenticate token requests.

  6. In the Base URL field, select the environment for this credential:

    • Production: https://api.ebay.com/sell/fulfillment/v1 — Use this for live eBay seller accounts.

    • Sandbox: https://apiz.ebay.com/sell/fulfillment/v1 — Use this for testing and development.

    The Sandbox environment is a replica of the Production environment that allows developers to test integrations without affecting real orders or seller accounts. Additional information about eBay's OAuth token flows is available in the Get OAuth access tokens documentation.

  7. After all fields are configured, Nexla will redirect you to eBay's authorization page, where the eBay seller whose account will be accessed must sign in and grant consent to the requested scopes.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.