browse APIv1_beta.10.0

Browse API Overview

Topics

Technical overview

Using the Browse API, you can create a rich selection of items for your buyers to browse with keyword and category searches.

Browse API resources

  • item_summary – basic information for an item or a group of items, such as title, pricing, images, shipping, and seller. It also includes refinements, such as item condition, buy options, category, and item aspects (color, brand, etc.).
  • item - detailed information for a purchasable items to enable users to make buying decisions. In addition to the basic item information and providing additional information about shipping, seller, etc., the item details include product review data, item location, return policy terms, and more. This resource also provides a bridge between the RESTful Buy APIs and the legacy APIs, such as Trading and Finding.

For more details, see Buying Integration Guide.

Business use cases

The Browse API is designed to be used together with the Buy APIs to create cohesive shopping, browsing, buying applications. For example, your buyers can have a seamless buying experience woven into a social application. This section outlines the high-level use cases for the Browse API.

Find eBay items using search

You can find exactly the items you want to show to your shoppers by searching for items by keyword, category, eBay product Id (EPID), or GTIN. Or a combination of these.

Refine the search results

You can control what is returned by the search using the fieldgroups field. By default, search returns matching items. But in addition to or instead of returning items, you can choose to return the aspects (all the variations of an item such and color and size), buying options (fixed or auction), conditions, and categories of the items found. These are known as refinements. This information enables you to create histograms, which enables shoppers to drill down in each refinement narrowing the search results.

The following is an example of a histogram of camera brands. It was created from the data returned in the aspect refinement container (aspectDistributions).

       Image of a Carmera Brand Histogram

Filter the search results by item aspects

You can use the information returned in aspectDistributions to filter the results by specific aspects, such as brand. For example:

aspect_filter=categoryId:20863,Brand:{canon,nikon}

Filter the search results by field filters

You can use field filters to refine the results based on the value returned in a field, such as listing format, item condition, price range, UPC value, listing end date, location, and more. You can use multiple filters in a single call. For details about the search call field filters, see Using the search Call Field Filters.

Get the details of each item in a group or a specific item

When the item has variations, you can retrieve the details of the individual items in an item group. You can also retrieve the details of a specific item.

Get item details using a legacy item Id

You can use the item Ids returned by eBay legacy APIs, such as Trading, Shopping, and Finding, to retrieve the details of the item and the RESTful item Id, which you can use with all the Buy API calls.

API restrictions

Please note the following constraints for the Browse API.

Note: In addition to the Browse API restrictions below, there are also requirements for using the Buy APIs. For more information, see Buy APIs Requirements.

Identifier incompatibility

The Buy APIs identifiers for item and order do not match the identifiers used on the eBay site and in buyer emails. So you cannot use the Buy APIs identifiers with the eBay legacy APIs, such as Trading and Finding. But you can use the eBay legacy APIs item identifiers with the Buy APIs. For details, see the section of the Buying Integration Guide.

Regional/site constraints

The Browse API is currently supported for the following eBay sites.

  • EBAY-AU - Australia (ebay.com/au)
  • EBAY-CA - Canada (English) (ebay.ca)
  • EBAY-DE - Germany (ebay.de)
  • EBAY-ES - Spain (ebay.es)
  • EBAY-FR - France (ebay.fr)
  • EBAY-IT - Italy (ebay.it)
  • EBAY-UK - Great Britain (ebay.co.uk)
  • EBAY-US - USA (ebay.com)

eBay policies and rules

Although the eBay Buy APIs are available for anyone to use in eBay's sandbox environment, use of the APIs in production is restricted. Users must meet standard eligibility requirements, get approvals from eBay support organizations, and sign contracts with eBay and PayPal to access the Buy APIs in production.

See Buy APIs Requirements in the Buying Integration Guide for more information.

search call limit and restriction

The search call can return a maximum of 10,000 items and you cannot use the wildcard * in the search call request.