Skip to main content

Important: Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made by EU/UK sellers. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signature to be included in the HTTP payload.

eBay offers developers a wide range of RESTful and Traditional APIs. For new development, eBay strongly encourages the use of our RESTful APIs. A key benefit of REST is that it uses less bandwidth and supports multiple formats including plain text, XML, HTML, and JSON while SOAP only supports XML.

In addition, the syntax and protocols used by REST (JSON and the URI addressing protocol) are well known and baked into how you already use the web. The underlying system has already been built and installed, and it's available for anyone to use. This minimizes the amount of work users and developers have to do to get their applications up and running. In theory, all RESTful APIs have the same, easy to learn, interface format.

RESTful APIs

eBay RESTful API for buying, selling, general commerce and analytics.

Traditional APIs

eBay Traditional API for buying, selling, general commerce and analytics.

API call limits

Understand the limits of eBay API call usage.

API deprecations

API capabilities that are, or will soon be, deprecated.

API status

Stay updated on current system issues with eBay APIs.

All APIs

Below are all available RESTful and Traditional APIs.

Sell APIs

Name Description API Reference Release Notes
Account API v1 Manage your business policies an custom policies, manage your shipping rate tables and sales tax tables, opt in and out of selling programs, and check your seller privileges using the Account API v1. See Configuring seller accounts in the Selling Integration Guide.
Account API v2 Provides advanced tools for managing and updating custom shipping rate tables.
Analytics API Provides information about an individual seller’s business performance through different report and data gathering resources including customer service metrics, traffic reports, and seller profiles. See Analyzing seller performance in the Selling Integration Guide.
Compliance API Provides tools for validating listings to help sellers keep their listings in compliance with eBay’s policies.
Feed API Manage your eBay business by downloading or uploading inventory, order, and customer service metric files, and creating schedules. This API is designed to make a large merchant's workflow more efficient by leveraging eBay infrastructure to use parallel execution and to automatically retry on errors. See Using the sell Feed API in the Selling Integration Guide.
Finances API Retrieve detailed information on seller payouts for eBay orders, and also retrieve details on all monetary transactions on eBay's system between the seller, buyer, and eBay. These transactions include sales, buyer refunds, seller credits, payment disputes, shipping label purchases, and non-sales related charges to the seller's account.
Fulfillment API Retrieve and fulfill orders, issue refunds, and manage third-party payment disputes initiated by buyers. See Handling orders in the Selling Integration Guide.
Inventory API Create and manage inventory item records, and then convert these inventory items into product offers on eBay marketplaces. See Managing inventory and offers in the Selling Integration Guide.
Logistics API Get quotes for shipping rates and shipping labels for a range of shipping services, all priced with eBay-negotiated shipping rates, and to download shipping labels.
Marketing API Provides the ability to offer appealing discounts and eye-catching ad placements that display in key spots throughout the eBay buying flows; manages the life cycle of item promotions and promoted listings, and generates reports. See Marketing seller inventory in the Selling Integration Guide.
Metadata API Retrieves eBay category policies and information on sales tax jurisdictions.
Negotiation API Gives seller the ability to reach out and make a discount offer to buyers who have shown an interest in their item listings.
Recommendation API Returns information that sellers can use to configure Promoted Listings ad campaigns.

Buy APIs

Name Description API Reference Release Notes
Browse API Search for and retrieve eBay items and use filters and parameters to create customized item sets. Search by image ID (a Base64 string) and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part or search for a compatible part. It also provides the ability for eBay members to add and remove items and change the quantity of an item in their eBay shopping cart as well as view the contents of their eBay cart.
Deal API Search for and retrieve details about eBay deals and events, as well as the items associated with those deals and events.
Feed Beta API Download daily files containing newly listed items or weekly bootstrap files containing all the items in a category. Download an hourly file of items that have changed in a category during that hour.
Feed API Use metadata methods to see what feed types and feed files you have access to, and then download the feed files you want.
Marketing API Returns an array of products based on the category and metric specified. This includes details of the product, such as the eBay product ID (EPID), title, and user reviews and ratings for the product.
Marketplace Insights API Retrieve the sales history of items sold on eBay. (This is a Limited Release.)
Offer API Place bids for a buyer on auction items and retrieve the bidding details for an auction where the buyer has placed a bid.
Order API Open a guest checkout session, update orders, apply a coupon to the order, retrieve order, payment status, and shipment details, and pay for the order. For eBay member checkouts, it also provides legacy IDs to enable you to use the Post Order API for returns and cancellations.

Commerce APIs

Name Description API Reference Release Notes
Catalog API Search the eBay catalog for products on which to base a seller's item listing, retrieve a product record by its eBay product identifier (ePID).
Charity API Retrieve a list of charitable organizations and access the details for those charitable organizations.
Identity API Retrieve account profile information for an authenticated user.
Media API Create, upload, and manage video resources.
Notification API Explore, subscribe to, and process eBay notifications.
Taxonomy API Discover appropriate categories to filter listings retrieved by the Buy APIs, or determine the best category in which to offer an item for sale and determine what categories to include in campaigns or promotions with the Sell APIs.
Translation API (beta) Translate common commerce content, such as the title and description of an item to help present marketplace listings to buyers in different countries or regions. The Translation API takes foreign language search queries from the buyer and translates them for the target marketplace, as well.

Developer APIs

Name Description API Reference Release Notes
Analytics API Provides call-limit and call usage data.
Client Registration API Registers a new third-party financial application with eBay.
Key Management API Creates encrypted keypairs that are required when creating digital signatures for eBay APIs which access confidential financial information.

Traditional Searching APIs

Name Description API Reference Release Notes
Finding API A searching API that allows you to search and browse for items listed on eBay, and provides useful metadata to refine searches and enhance the search experience.

Traditional Shopping/Buying APIs

Name Description API Reference Release Notes
Shopping API A shopping/buying API that makes it easier to search for items on eBay.
Merchandising API

Traditional Selling APIs

Name Description API Reference Release Notes
Trading API A selling API that allows you to list and manage inventory, fulfill orders, and communicate with customers.
Platform Notifications
Product Services A selling API that retrieves information about products on eBay to help sellers list items with Parts Compatibility.
Client Alerts API A selling API that makes it easy to receive near real-time seller and buyer alerts about events on the eBay site.
Listing Recommendation API 1
Large Merchant Services 2
Related Items Management API 3

1 The Listing Recommendation API is scheduled for deprecation. We recommend you integrate with the the new Recommendation API to retrieve recommendations for improving your listings and sales performance, or with the Compliance API to discover non-compliant listings or listings that are at risk at becoming non-compliant in the future.

2 eBay recommends the Merchant Integration Platform for bulk inventory management. The Large Merchant Services documentation is still available for anyone who has already integrated.

3 eBay recommends the The Related Items Management API has been deprecated and is no longer functional. We recommend you integrate with the Marketing API for managing sales promotions for seller inventory.

After Sale APIs

Name Description API Reference Release Notes
Post Order API An after-sale API that allows a buyer to cancel, return, and inquire about orders.
Resolution Case Management API 1
Return Management API 2

1 eBay recommends the Post Order API for managing after-sale problems, such as cancellations and returns. The Resolution Case Management API documentation is still available for anyone who has already integrated.

2 eBay recommends the Post Order API for managing cancellations, returns, inquiries, and escalations. The Return Management API documentation is still available for anyone who has already integrated.