browse APIv1_beta.22.0

API Reference : Resources

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • Experimental Release (Experimental) search_by_image: Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the 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.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • Experimental Release (Experimental) shopping_cart: Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource methods require an Application access token. The shopping_cart resource methods require a User access token.

item_summary

Method NameHTTP MethodPathSummarySamples
searchGET
/item_summary/search
Searches for eBay items by various URI query parameters and retrieves summaries of the items.

Optionally, you can also apply field filters, return refinements, such as condition or category, sort the result set, and control the number of items returned in the result set.

View search - /item_summary/search

search_by_image

Method NameHTTP MethodPathSummarySamples
searchByImagePOST
/item_summary/search_by_image
Searches for eBay items based on a Base64 string of an image.View searchByImage - /item_summary/search_by_image

item

Method NameHTTP MethodPathSummarySamples
getItemGET
/item/{item_id}
Retrieves the details of the specified item.View getItem - /item/{item_id}
getItemByLegacyIdGET
/item/get_item_by_legacy_id
Retrieves item details and returns the REST ID of an item using a legacy ID.

Legacy IDs are returned by eBay traditional APIs, such as the Finding API.
View getItemByLegacyId - /item/get_item_by_legacy_id
getItemsByItemGroupGET
/item/get_items_by_item_group
Retrieves the details of all the individual items (variations) in the specified item group.View getItemsByItemGroup - /item/get_items_by_item_group
checkCompatibilityPOST
/item/{item_id}/check_compatibility
Checks 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

shopping_cart

Method NameHTTP MethodPathSummarySamples
addItemPOST
/shopping_cart/add_item
Creates an eBay cart, if it doesn't exist, for the eBay member and adds items to that cart.View addItem - /shopping_cart/add_item
getShoppingCartGET
/shopping_cart/
Retrieves the contents of the eBay member's cart.View getShoppingCart - /shopping_cart/
removeItemPOST
/shopping_cart/remove_item
Removes a specific item from the eBay member's cart.View removeItem - /shopping_cart/remove_item
updateQuantityPOST
/shopping_cart/update_quantity
Updates the quantity value of a specific item in the eBay member's cart.View updateQuantity - /shopping_cart/update_quantity