Skip to content

Browse API API

by ebay.com

OAuthHTTPSShopping
Open documentation ↗

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.

Browse API is a shopping API from ebay.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 11 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Shopping
Base URL
https://api.ebay.com/buy/browse/v1
Version
v1.1.0
Endpoints
11
Spec updated
2020-11-02

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://api.ebay.com/buy/browse/v1/item/" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://api.ebay.com/buy/browse/v1/item/", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://api.ebay.com/buy/browse/v1/item/",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/item/This 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 sele
GET/item/get_item_by_legacy_idThis 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 RES
GET/item/get_items_by_item_groupThis 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, s
GET/item/{item_id}This method retrieves the details of a specific item, such as description, price, category, all item aspects, condition, return policies, seller feedback and sc
POST/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 with
GET/item_summary/searchThis method searches for eBay items by various query parameters and retrieves summaries of the items. You can search by keyword, category, eBay product ID (ePID
POST/item_summary/search_by_imageThis 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 req
GET/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 added
POST/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 e
POST/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 yo
POST/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 cart

Questions

Does the Browse API API need an API key?

Yes. The Browse API API uses OAuth authentication; the documentation explains how to get credentials.

Does the Browse API API support HTTPS?

Yes, the Browse API API is served over HTTPS.

How many endpoints does the Browse API API have?

Its OpenAPI description lists 11 endpoints in version v1.1.0. All of them are shown on this page.

What are alternatives to the Browse API API?

Other Shopping APIs include Etsy, eBay, Flipkart Marketplace, Inventory Management, Intel Product Catalogue Service.

Compare alternatives →

Listed from APIs.guru (CC0).