Reference
eBay
Set up eBay OAuth for marketplace selling and order management
Overview
Section titled “Overview”Connect your users to eBay for marketplace selling, inventory management, order fulfillment, and account data.
| Property | Value |
|---|---|
| Provider ID | ebay |
| Category | E-commerce |
| PKCE | Supported |
| Token refresh | Automatic |
| Redirect URI | Shown in Developer Portal |
Step 1: Create an eBay OAuth App
Section titled “Step 1: Create an eBay OAuth App”Go to the eBay Developer Portal
Navigate to developer.ebay.com/my/keys and sign in.
Create a new application
Click Get a Keyset and fill in the application details.
Configure the redirect URI
In the application settings, add the Alter callback URL from the Developer Portal to the RuName (eBay Redirect URL name) configuration.
Get credentials
Copy the Client ID (App ID) and Client Secret (Cert ID).
Step 2: Add to Alter Vault
Section titled “Step 2: Add to Alter Vault”Open the Developer Portal
Go to portal.alterauth.com and navigate to the application.
Add eBay provider
Go to OAuth Providers > Add Provider > eBay.
Enter credentials
- Client ID: Paste your eBay App ID
- Client Secret: Paste your eBay Cert ID
Select scopes
Choose the scopes the application needs.
Save
Click Save. The provider is now active.
Available Scopes
Section titled “Available Scopes”| Scope | Description |
|---|---|
https://api.ebay.com/oauth/api_scope | Access to general eBay API endpoints |
https://api.ebay.com/oauth/api_scope/sell.marketing | Access to selling marketing tools and promotions |
https://api.ebay.com/oauth/api_scope/sell.inventory | Access to inventory and listing management |
https://api.ebay.com/oauth/api_scope/sell.fulfillment | Access to order fulfillment and shipping |
https://api.ebay.com/oauth/api_scope/sell.account | Access to seller account settings and policies |
https://api.ebay.com/oauth/api_scope/commerce.identity.readonly | View the user’s basic eBay account information (immutable user ID) |
- eBay uses full URL strings as scope values rather than short names.
- eBay has separate sandbox and production environments. Test with sandbox credentials before going to production.
- See the eBay OAuth documentation for more details.
Policy-cataloged operations
Section titled “Policy-cataloged operations”Alter policy rules can target these attested operations and families for operation-level and parameter-aware controls.
| Operation ID | Families | Method | Provider path |
|---|---|---|---|
issueRefund | payment | POST | /order/{order_id}/issue_refund |
acceptPaymentDispute | payment | POST | /payment_dispute/{payment_dispute_id}/accept |
contestPaymentDispute | write | POST | /payment_dispute/{payment_dispute_id}/contest |
addEvidence | write | POST | /payment_dispute/{payment_dispute_id}/add_evidence |
updateEvidence | write | POST | /payment_dispute/{payment_dispute_id}/update_evidence |
uploadEvidenceFile | write | POST | /payment_dispute/{payment_dispute_id}/upload_evidence_file |
createShippingFulfillment | write | POST | /order/{orderId}/shipping_fulfillment |
fetchEvidenceContent | read | GET | /payment_dispute/{payment_dispute_id}/fetch_evidence_content |
getActivities | read | GET | /payment_dispute/{payment_dispute_id}/activity |
getOrder | read | GET | /order/{orderId} |
getOrders | read | GET | /order |
getPaymentDispute | read | GET | /payment_dispute/{payment_dispute_id} |
getPaymentDisputeSummaries | read | GET | /payment_dispute_summary |
getShippingFulfillment | read | GET | /order/{orderId}/shipping_fulfillment/{fulfillmentId} |
getShippingFulfillments | read | GET | /order/{orderId}/shipping_fulfillment |