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.
- search_by_image:
(Experimental) 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.
- shopping_cart: (Experimental)
(Limited Release) 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 calls require an Application access token. The shopping_cart resource calls require a User access token.
item_summary
| Method Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| search | GET | /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 Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| searchByImage | POST | /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 Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| getItem | GET | /item/{item_id} | Retrieves the details of the specified item. | View getItem - /item/{item_id} |
| getItemByLegacyId | GET | /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 |
| getItems | GET | /item/ | Retrieves the details for multiple items. | View getItems - /item/ |
| getItemsByItemGroup | GET | /item/get_items_by_item_group | Retrieves the details for individual items (variations) in the specified item group. | View getItemsByItemGroup - /item/get_items_by_item_group |
| checkCompatibility | POST | /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 Name | HTTP Method | Path | Summary | Samples |
|---|---|---|---|---|
| addItem | POST | /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 |
| getShoppingCart | GET | /shopping_cart/ | Retrieves the contents of the eBay member's cart. | View getShoppingCart - /shopping_cart/ |
| removeItem | POST | /shopping_cart/remove_item | Removes a specific item from the eBay member's cart. | View removeItem - /shopping_cart/remove_item |
| updateQuantity | POST | /shopping_cart/update_quantity | Updates the quantity value of a specific item in the eBay member's cart. | View updateQuantity - /shopping_cart/update_quantity |