Skip to main content
Guides
Release Notes
Request Headers
Notification Topics
Response Status and Error Codes
Inventory Discovery and Refresh
Notification API
config
destination
public_key
subscription
topic

Notification API

The eBay Notification API provides a comprehensive set of resources for developers to manage the entire lifecycle of asynchronous notifications from eBay. Users can browse available notification topics, configure and manage destination endpoints for receiving notifications, create and manage subscriptions to specific topics with optional filtering, and validate the integrity of received message payloads using public keys. The API supports both application-based and user-based subscriptions, utilizing OAuth 2.0 grant flows, and is essential for applications requiring timely updates on events such as order confirmations, listing revisions, feedback received, and user account changes.

Note: For more information on supported notification topics, see Notification Topics. 

REST
Endpoints
  • GET/config
  • PUT/config
  • POST/destination
  • DELETE/destination/{destination_id}
  • GET/destination/{destination_id}
  • GET/destination
  • PUT/destination/{destination_id}
  • GET/public_key/{public_key_id}
  • POST/subscription
  • POST/subscription/{subscription_id}/filter
  • DELETE/subscription/{subscription_id}
  • DELETE/subscription/{subscription_id}/filter/{filter_id}
  • POST/subscription/{subscription_id}/disable
  • POST/subscription/{subscription_id}/enable
  • GET/subscription/{subscription_id}
  • GET/subscription/{subscription_id}/filter/{filter_id}
  • GET/subscription
  • POST/subscription/{subscription_id}/test
  • PUT/subscription/{subscription_id}
  • GET/topic/{topic_id}
  • GET/topic

Deal API

The Deal API allows third-party developers to search for and retrieve details about eBay deals and events, as well as the items associated with those deals and events.

Note: This is a (Limited Release) API available only to select developers approved by business units. For information on how to obtain access to this API in production, see the Buy APIs Requirements.

REST
Endpoints
  • GET/deal_item
  • GET/event/{event_id}
  • GET/event
  • GET/event_item

Marketing Beta API

Note: This is the beta version of the Marketing API. For the v1 version, see Marketing API.

The Marketing Beta API is part of the eBay Buy APIs. It retrieves eBay products based on a metric, such as Best Selling. This API helps shoppers compare products and motivate them to purchase items. You can use the other Buy APIs to create a buying application that lets users, eBay members or guests, buy from eBay sellers without visiting the eBay site. The Buy APIs provide the opportunity to purchase eBay items in your app or website.

REST
Endpoints
  • GET/merchandised_product

Marketing API

The Marketing API is part of the eBay Buy APIs. It retrieves eBay products based on a metric, such as Best Selling. This API helps shoppers compare products and motivate them to purchase items. You can use the other Buy APIs to create a buying application that lets users, eBay members or guests, buy from eBay sellers without visiting the eBay site. The Buy APIs provide the opportunity to purchase eBay items in your app or website.

This API uses the following resources:

  • merchandised_product - retrieves eBay products for a specific metric, such as Best Selling.
  • most_watched_items - retrieves items with the highest watch counts in a category.
  • similar_items - retrieves recommended similar items for a specified item.

REST
Endpoints
  • GET/merchandised_product
  • GET/most_watched_items
  • GET/similar_items

Taxonomy API

The Taxonomy API enables you to assist both sellers and buyers:

  • It helps sellers to determine the best eBay category under which to offer each inventory item for sale in a selected eBay marketplace. It helps sellers to select the categories of items to include in a campaign or promotion. It also provides information about the aspects to include when defining an inventory item in a given category. For more information, see the Selling Integration Guide.
  • It helps buyers to determine the appropriate categories in which to browse or search for the items they're looking to purchase in a particular eBay marketplace. For more information, see the Buying Integration Guide.

REST
Endpoints
  • GET/category_tree/{category_tree_id}/fetch_item_aspects
  • GET/get_default_category_tree_id
  • GET/category_tree/{category_tree_id}
  • GET/category_tree/{category_tree_id}/get_category_subtree
  • GET/category_tree/{category_tree_id}/get_category_suggestions
  • GET/category_tree/{category_tree_id}/get_item_aspects_for_category
  • GET/category_tree/{category_tree_id}/get_compatibility_properties
  • GET/category_tree/{category_tree_id}/get_compatibility_property_values
  • GET/category_tree/{category_tree_id}/get_expired_categories

Charity API

The eBay Charity API provides buyers and sellers a formal way to search for supported charitable organizations and charitable organization details.

Note: The Charity API is supported only in the UK and US marketplaces.

For more information about using RESTful APIs, see Get started with eBay APIs and Using eBay RESTful APIs.

Sandbox vs. Production data

The data in the eBay Sandbox environment is static. It can be limited in scope and quantity, and is sometimes simulated or mock data. As a result, you should not depend on data in the Production environment to have the same limitations. Use good coding practices to anticipate the wider range and variability of data that your application is likely to encounter.

REST
Endpoints
  • GET/charity_org
  • GET/charity_org

Catalog API

The Catalog API allows users to search for and locate an eBay catalog product that is a direct match for the product that they wish to sell. Listing against an eBay catalog product helps insure that all listings (based off of that catalog product) have complete and accurate information. In addition to helping to create high-quality listings, another benefit to the seller of using catalog information to create listings is that much of the details of the listing will be prefilled, including the listing title, the listing description, the item specifics, and a stock image for the product (if available). Sellers will not have to enter item specifics themselves, and the overall listing process is a lot faster and easier.

REST
Endpoints
  • GET/product/{epid}
  • GET/product_summary/search

Offer API

The Offer API provides the ability to place and retract a proxy bid for a buyer and to retrieve all the auctions where the buyer is bidding.
Note: This is a (Limited Release) API available only to select developers approved by business units. For information on how to obtain access to this API in production, see the Buy APIs Requirements.

REST
Endpoints
  • GET/bidding/{item_id}
  • POST/bidding/{item_id}/place_proxy_bid

Message API

The Message API provides resources for managing user conversations on the eBay platform, allowing developers to send, retrieve, and update the status of messages and conversations. Key functionalities include sending messages in new or existing threads (sendMessage), retrieving filtered lists of conversations (getConversations), fetching all messages within a specific conversation (getConversation), and modifying the status (e.g., active, deleted, archived, read, unread) of single or multiple conversations (updateConversation, bulkUpdateConversation).

REST
Endpoints
  • POST/bulk_update_conversation
  • GET/conversation/{conversation_id}
  • GET/conversation
  • POST/send_message
  • POST/update_conversation

Notification API

The eBay Notification API provides a comprehensive set of resources for developers to manage the entire lifecycle of asynchronous notifications from eBay. Users can browse available notification topics, configure and manage destination endpoints for receiving notifications, create and manage subscriptions to specific topics with optional filtering, and validate the integrity of received message payloads using public keys. The API supports both application-based and user-based subscriptions, utilizing OAuth 2.0 grant flows, and is essential for applications requiring timely updates on events such as order confirmations, listing revisions, feedback received, and user account changes.

Note: For more information on supported notification topics, see Notification Topics. 

REST
Endpoints
  • GET/config
  • PUT/config
  • POST/destination
  • DELETE/destination/{destination_id}
  • GET/destination/{destination_id}
  • GET/destination
  • PUT/destination/{destination_id}
  • GET/public_key/{public_key_id}
  • POST/subscription
  • POST/subscription/{subscription_id}/filter
  • DELETE/subscription/{subscription_id}
  • DELETE/subscription/{subscription_id}/filter/{filter_id}
  • POST/subscription/{subscription_id}/disable
  • POST/subscription/{subscription_id}/enable
  • GET/subscription/{subscription_id}
  • GET/subscription/{subscription_id}/filter/{filter_id}
  • GET/subscription
  • POST/subscription/{subscription_id}/test
  • PUT/subscription/{subscription_id}
  • GET/topic/{topic_id}
  • GET/topic

Identity API

The Identity API returns data for an authenticated user (user access token) based on the OAuth scopes provided. Non-confidential information, such as eBay userID is returned using the default scope. Confidential data for an individual, such as address, email, phone, etc. are returned based on the OAuth scope you use in the call. For business users, all the public business information is returned using the default OAuth scope.

The Identity API can be used to let users log into your app or site using eBay, which frees you from needing to store and protect user's PII (Personal Identifiable Information) data.

REST
Endpoints
  • GET/user

Translation API

This API allows third-party developers to translate listing titles and listing descriptions from one supported language into another.

REST
Endpoints
  • POST/translate

VeRO API

The eBay VeRO API allows owners of an intellectual property, such as a copyright or trademark, to report eBay listings that infringe on their intellectual property rights.

Important! The VeRO API is only available to members of the Verified Rights Owner (VeRO) Program.

REST
Endpoints
  • GET/vero_reason_code/{vero_reason_code_id}
  • GET/vero_reason_code
  • POST/vero_report
  • GET/vero_report/{vero_report_id}
  • GET/vero_report_items

Developer Analytics API

Use the Developer Analytics API to retrieve call-limit and utilization data for eBay RESTful APIs and the legacy Trading API.

The rate_limit resource retrieves call-limit data for an application.

The user_rate_limit resource retrieves call-limit data for an application user.

The returned rate-limit data includes the call quota, number of calls used, number of remaining calls, reset time, and the time window for each resource.

REST
Endpoints
  • GET/rate_limit/
  • GET/user_rate_limit/

Client Registration API

Use the Client Registration API to register a new regulated third-party financial application with eBay.

This API is intended for regulated Third Party Providers (TPPs) who are, or will be, engaged in financial transactions on behalf of individuals domiciled in the EU or UK.

The Client Registration API supports Dynamic Client Registration for payment-services workflows that are subject to EU and UK payment-services regulations. A successful registration returns HTTP status code 201 Created and client registration information.

REST
Endpoints
  • POST/client/register

Key Management API

Use the Key Management API to create and retrieve keypairs that are required when adding digital signatures to selected eBay API calls.

The signing_key resource lets developers create new signing keypairs, retrieve a specific signing keypair by ID, and retrieve metadata for all signing keypairs associated with the application key making the call.

The Key Management API is used for APIs that access confidential financial information and require a digital signature for HTTP calls made on behalf of EU/UK sellers.

REST
Endpoints
  • POST/signing_key
  • GET/signing_key/{signing_key_id}
  • GET/signing_key