Browse API
The Browse API has the following resources: item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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) 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) 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 calls require an Application access token. The shopping_cart resource calls require a User access token.
Endpoints 11
item
- GETgetItems
/item/?item_ids=string&item_group_ids=stringThis method retrieves the details of specific items that the buyer needs to make a purchasing decision. Note: This is a (Limited Release) available only to… - GETgetItemByLegacyId
/item/get_item_by_legacy_id?fieldgroups=string&legacy_item_id=string&legacy_variation_id=string&legacy_variation_sku=stringThis method is a bridge between the eBay legacy APIs, such as Shopping, and Finding and the eBay Buy APIs. There are differences between how legacy APIs and… - GETgetItemsByItemGroup
/item/get_items_by_item_group?item_group_id=stringThis method retrieves the details of the individual items in an item group. An item group is an item that has various aspect differences, such as color, size,… - GETgetItem
/item/:item_id?fieldgroups=stringThis method retrieves the details of a specific item, such as description, price, category, all item aspects, condition, return policies, seller feedback and… - POSTcheckCompatibility
/item/:item_id/check_compatibilityThis method checks if a product is compatible with the specified item. You can use this method to check the compatibility of cars, trucks, and motorcycles…
item_summary
- GETsearch
/item_summary/search?aspect_filter=string&auto_correct=string&category_ids=string&charity_ids=string&compatibility_filter=string&epid=string&fieldgroups=string&filter=string>in=string&limit=string&offset=string&q=string&sort=stringThis method searches for eBay items by various query parameters and retrieves summaries of the items. You can search by keyword, category, eBay product ID…
search_by_image
- POSTsearchByImage
/item_summary/search_by_image?aspect_filter=string&category_ids=string&charity_ids=string&fieldgroups=string&filter=string&limit=string&offset=string&sort=stringThis is an Experimental method. This method searches for eBay items based on a image and retrieves summaries of the items. You pass in a Base64 image in the…
shopping_cart
- GETgetShoppingCart
/shopping_cart/This is an experimental method. This method retrieves all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items… - POSTaddItem
/shopping_cart/add_itemThis is an Experimental method. This method creates an eBay cart for the eBay member, if one does not exist, and adds items to that cart. Because a cart never… - POSTremoveItem
/shopping_cart/remove_itemThis is an experimental method. This method removes a specific item from the eBay member's cart. You specify the ID of the item in the cart (cartItemId) that… - POSTupdateQuantity
/shopping_cart/update_quantityThis is an experimental method. This method updates the quantity value of a specific item in the eBay member's cart. You specify the ID of the item in the…
API details
- Base URL
https://api.ebay.com/buy/browse/v1- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
OAuth 2.0 (client credentials flow) with 3 scopes - Operations
- 11 operations on 11 pathsGET 6POST 5
- Main resources
- item 5shopping_cart 4item_summary 1search_by_image 1
- Description format
- Swagger 2.0, API version
v1.1.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Browse API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Browse API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “getItems” (GET /item/?item_ids=string&item_group_ids=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Browse API?
The Browse API has the following resources: item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item… It is listed under E-commerce and has 11 endpoints.
Who publishes the Browse API?
It is listed from eBay's public API description (an OpenAPI document), not published by eBay on Swastik Codes. Anyone who controls ebay.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Browse API?
Requests go to https://api.ebay.com/buy/browse/v1. Endpoint paths are added to this base URL.
How do I authenticate with the Browse API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; OAuth 2.0 (client credentials flow) with 3 scopes.
How many endpoints does the Browse API have?
11 operations on 11 paths (6 GET, 5 POST). The largest groups are item, shopping_cart, item_summary, search_by_image.
Is forking the Browse API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.