How to Integrate Retool with eBay API

Go to developer.ebay.com and sign in with your eBay account. Navigate to 'Application Access Keys'. If you don't have an application, click 'Create a Keyset' and fill in your application name and description. Choose 'Production' for live seller data (or 'Sandbox' for testing). After creating the application, eBay provides three credentials: App ID (also called Client ID), Cert ID (also called Client Secret), and Dev ID. You'll use the App ID and Cert ID for OAuth token generation. The Dev ID is used for specific legacy API features. For the Sell and Fulfillment APIs, your application needs a User access token — this requires a seller to authorize your application through eBay's OAuth flow. Navigate to the 'User Tokens' section in the developer portal and use eBay's 'OAuth Consent Flow' to authorize your seller account. This generates a refresh token that can be exchanged for access tokens lasting 2 hours. Copy the refresh token — you'll need it for your Retool Resource configuration. For the Browse API (public search/browse data only), you only need an Application token obtained via client credentials — no user authorization required. To get an application token, make a POST request to https://api.ebay.com/identity/v1/oauth2/token with Basic auth (App ID:Cert ID) and body grant_type=client_credentials&scope=https://api.ebay.com/oauth/api_scope.

eBay's access tokens expire after 2 hours, so you need a mechanism to obtain fresh tokens before making API calls. The recommended pattern in Retool is a dedicated 'token query' that runs before your data queries. In Retool, navigate to the Resources tab and create a REST API Resource named 'eBay OAuth'. Set the base URL to https://api.ebay.com/identity/v1. For authentication, select 'Basic Auth'. Set the username to your eBay App ID and the password to your Cert ID. Base64-encoded App ID:Cert ID will be sent as the Authorization header. Create a query named 'getEbayToken' using this resource. Set method to POST and path to /oauth2/token. In the Body tab, set Content-Type to application/x-www-form-urlencoded. The body should contain: grant_type=refresh_token&refresh_token={{ retoolContext.configVars.EBAY_REFRESH_TOKEN }}&scope=https://api.ebay.com/oauth/api_scope/sell.fulfillment https://api.ebay.com/oauth/api_scope/sell.inventory. Create a second REST API Resource named 'eBay API' with base URL https://api.ebay.com. For authentication, select 'Bearer Token' and set the value to {{ getEbayToken.data.access_token }}. This way, the access token from the first query is used in all subsequent API queries. Store your eBay refresh token in a Retool configuration variable: Settings → Configuration Variables → add EBAY_REFRESH_TOKEN as a secret. Never hardcode the refresh token in query bodies.

1// Body for POST /identity/v1/oauth2/token
2// Use application/x-www-form-urlencoded content type
3grant_type=refresh_token&refresh_token={{ retoolContext.configVars.EBAY_REFRESH_TOKEN }}&scope=https%3A%2F%2Fapi.ebay.com%2Foauth%2Fapi_scope%2Fsell.fulfillment+https%3A%2F%2Fapi.ebay.com%2Foauth%2Fapi_scope%2Fsell.inventory

With OAuth working, build the queries that power your seller dashboard. Create a query named 'getListings' using the eBay API resource. Set method to GET and path to /sell/inventory/v1/offer. Add URL parameters: sku (maps to {{ skuSearchInput.value || '' }} for SKU filtering), limit (set to 50), and offset (set to {{ (listingsTable.pagination.current - 1) * 50 || 0 }} for pagination). The Sell Inventory API's /offer endpoint returns all offers (listings) with their current status, price, quantity, and marketplace details. For listing performance data, create a second query targeting eBay's Analytics API: GET /sell/analytics/v1/seller_standards_profile to get overall seller performance, and GET /sell/analytics/v1/traffic_report for impression and click data by listing. Create a third query 'getOrders' using the Fulfillment API: GET /sell/fulfillment/v1/order. Add parameters: filter (set to creationdate:[2025-01-01T00:00:00.000Z..] for date filtering), orderfulfillmentstatus (set to NOT_STARTED for unfulfilled orders), limit (50), and offset for pagination. Run each query to verify the response structure. eBay's responses follow a consistent pattern with a total count, a limit and offset, and an items/orders array.

1// JavaScript transformer for eBay orders response
2const orders = data.orders || [];
3
4return orders.map(order => ({
5  orderId: order.orderId,
6  buyerUsername: order.buyer?.username || 'N/A',
7  createdDate: new Date(order.creationDate).toLocaleDateString(),
8  status: order.orderFulfillmentStatus,
9  paymentStatus: order.paymentSummary?.payments?.[0]?.paymentStatus || 'Unknown',
10  itemCount: order.lineItems?.length || 0,
11  items: order.lineItems?.map(li => li.title).join(', ') || '',
12  orderTotal: `$${parseFloat(order.pricingSummary?.total?.value || 0).toFixed(2)}`,
13  currency: order.pricingSummary?.total?.currency || 'USD',
14  shippingDeadline: order.fulfillmentStartInstructions?.[0]?.maxEstimatedDeliveryDate
15    ? new Date(order.fulfillmentStartInstructions[0].maxEstimatedDeliveryDate).toLocaleDateString()
16    : 'N/A'
17}));

Build the Retool seller command center. Start with a Tab component at the top of the canvas with three tabs: 'Listings', 'Orders', and 'Returns'. On the Listings tab: Add a summary row with Statistic components showing total active listings, total available quantity, and average price. Below, add a Table component bound to {{ getListings_transformed.value || [] }}. Configure columns: SKU, title, price, quantity, status (as a Tag), and an 'Edit Price' action button. The edit button opens a Modal containing a NumberInput for new price and a query that calls PATCH /sell/inventory/v1/offer/{offerId} to update the price. On the Orders tab: Add filter controls (date range, fulfillment status Select, payment status Select) connected to the getOrders query parameters. Add a Table showing the transformed order data. Configure columns: orderId, buyerUsername, items, orderTotal, status (as Tag), createdDate, and action buttons: 'Mark Shipped' (opens a Modal for tracking number entry) and 'View in eBay' (opens the eBay order URL in new tab). The 'Mark Shipped' action triggers a POST to /sell/fulfillment/v1/order/{orderId}/shipping_fulfillment with the carrier, tracking number, and line item IDs. On success, refresh the orders query and show a 'Marked as shipped' notification. For the Returns tab, query the Post-Order API at https://api.ebay.com/post-order/v2/return with filter=OPEN status. For complex multi-API eBay integrations with inventory sync, bulk listing management, and analytics dashboards, RapidDev's team can help architect the full solution.

1// Body for POST /sell/fulfillment/v1/order/{orderId}/shipping_fulfillment
2// Mark an order as shipped with tracking information
3{
4  "lineItems": {{ getOrders_transformed.value
5    .find(o => o.orderId === ordersTable.selectedRow?.orderId)
6    ?.lineItems?.map(li => ({ lineItemId: li.lineItemId, quantity: li.quantity })) || [] }},
7  "shippedDate": "{{ new Date().toISOString() }}",
8  "shippingCarrierCode": "{{ carrierSelect.value }}",
9  "trackingNumber": "{{ trackingNumberInput.value }}"
10}