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.

  • OpenAPI Specification - Version 2.0 for all of our RESTful APIs will no longer be available starting April 5, 2023. We will continue leveraging OpenAPI Specification - Version 3.0 for new features in our RESTful APIs.

The Browse API has the following resources:

  • item_summary:
    Allows shoppers to search for specific items by keyword, GTIN, category, charity, product, image, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values, or UI parameters.
  • item:
    Allows shoppers to retrieve the details of a specific item or all items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.

    This resource also provides a bridge between the eBay legacy APIs, such as the Finding, and the RESTful APIs, which use different formats for the item IDs.
The item_summary, search_by_image, and item resource calls require an Application access token.

item_summary

Method NameHTTP MethodPathSummarySamples
searchGET/item_summary/searchRetrieves one or more eBay listings based on an advanced set of inclusive and exclusive search filters.View search - /item_summary/search
searchByImagePOST/item_summary/search_by_imageRetrieves one or more eBay listings based on a supplied Base64 image string and an advanced set of inclusive and exclusive search filters.View searchByImage - /item_summary/search_by_image

item

Method NameHTTP MethodPathSummarySamples
getItemGET/item/{item_id}Retrieves an eBay listing by eBay RESTful ID, with a fieldgroups query parameter that controls the detail level of the response.View getItem - /item/{item_id}
getItemByLegacyIdGET/item/get_item_by_legacy_idRetrieves an eBay listing by traditional item ID value, by traditional variation ID value, or by seller-defined SKU, with a fieldgroups query parameter that controls the detail level of the response.View getItemByLegacyId - /item/get_item_by_legacy_id
getItemsGET/item/Retrieves an abbreviated set of details on one or more eBay listings, identified with eBay RESTful item IDs or item group IDs.View getItems - /item/
getItemsByItemGroupGET/item/get_items_by_item_groupRetrieves the details for individual items (variations) in the specified item group.View getItemsByItemGroup - /item/get_items_by_item_group
checkCompatibilityPOST/item/{item_id}/check_compatibilityChecks if the specified product is compatible with the specified item. For example: If a specific car is compatible with a specific part.View checkCompatibility - /item/{item_id}/check_compatibility