browse APIv1.8.0

Browse API Release Notes

Just getting started with the Browse API? See the following documents for details on using this API:

See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.

The API release history

The following table lists recent Browse API releases. For older releases, see the Browse API Release Notes Archive.

Release Version	Release Date	Description of Release
v1.8.0	2021-09-08	Added the priorityListing response field to the search method Added the sort option EndingSoonest for listings in search results
v1.7.0	2021-08-12	Added support for `AUTHENTICITY_GUARANTEE` to the qualifiedPrograms filter URI parameter in the search and searchByImage resource methods
v1.6.0	2021-06-15	Added new itemEndDate and topRatedBuyingExperience response fields to the search and searchByImage methods Added new bidCount filter to the search and searchByImage methods
v1.5.0	2021-05-03	Added a new tyreLabelImageUrl response field to the item, item_summary, and search_by_image resources
v1.4.2	2021-04-08	Added support for the following marketplaces to the item and item_summary resources: Ireland (EBAY_IE) Netherlands (EBAY_NL) Poland (EBAY_PL)
v1.4.1	2021-02-03	Updated error code 12029 and added error code 12032 for the search and searchByImage methods
v1.4.0	2020-12-18	Added support for the `taxes` container in the getItems resource method and in the getItem compact response Updated the `price` and `shippingCost` response field descriptions to inform of value-added tax (VAT) inclusion in applicable jurisdictions
v1.3.0	2020-12-03	Added support for the `searchInDescription` filter URI parameter in the search resource method
v1.2.0	2020-11-13	Added support for `AUTHENTICITY_VERIFICATION` to the qualifiedPrograms filter URI parameter in the search and searchByImage resource methods Added a new `AuthenticityVerificationProgram` type to the item resource methods
v1.1.0	2020-10-27	New regionId field returned for included and excluded shipping regions.
v1.0.0	2020-10-19	The Browse API has moved out of the beta stage and has entered into general availability (GA).

v1.8.0

The following section describes the changes made in this release.

Added priorityListing response field

The search method now returns the priorityListing field.

When the value is true, this field indicates that the item is a priority listing. Priority Listings are a subset of eBay listings identified with a higher priority to be promoted.

Note: The priorityListing field is not available using the searchByImage method.

Added EndingSoonest sort option

Search results can now be sorted by EndingSoonest. This shows items in order of the date and time when the listing ends, starting with the listing with the nearest end date/time.

v1.7.0

The following section describes the changes made in this release.

Added AUTHENTICITY_GUARANTEE to qualifiedPrograms filter

Support for AUTHENTICITY_GUARANTEE was added to the qualifiedPrograms filter URI parameter in the search and searchByImage resource methods. The new filter returns only the items that are qualified for the Authenticity Guarantee program. This program enables third-party authenticators to perform authentication verification inspections on items.

Note: Refer to the Buy API Field Filters section of the Buying Integration Guide for details and examples for all the available filters.

v1.6.0

The following section describes the changes made in this release.

Added itemEndDate response field

The search and searchByImage methods now return the itemEndDate field.

This field represents the date and time up to which the item can be purchased. This value is returned in UTC format, which you can convert into the local time of the buyer.

Note: This field is not returned for Good 'Til Cancelled (GTC) listings.

Added topRatedBuyingExperience response field

The search and searchByImage methods now return the topRatedBuyingExperience field.

This field indicates if the item is a top-rated plus item. There are three benefits of a top-rated plus item: a minimum 30-day money-back return policy, shipping the item in 1 business day with tracking provided, and the added comfort of knowing that this item is from an experienced seller with the highest buyer ratings. See the Top Rated Plus Items and Becoming a Top Rated Seller and qualifying for Top Rated Plus help topics for more information.

Added bidCount filter parameter

Support for a new bidCount filter parameter was added to the search and searchByImage methods.

The new filter returns only auction items with a number of bids that is within the specified range.

Note: Refer to the Buy API Field Filters section of the Buying Integration Guide for details and examples for all the available filters.

v1.5.0

The following section describes the changes made in this release.

Added tyreLabelImageUrl response field

The following methods now return the tyreLabelImageUrl field:

getItem
getItemByLegacyId
getItemsByItemGroup
search
searchByImage

This new field provides a URL to the image that shows the information on the tyre label.

v1.4.2

The following section describes the changes made in this release.

Added support for new marketplaces

The item and item_summary resources now support the following marketplaces:

Ireland (EBAY_IE)
Netherlands (EBAY_NL)
Poland (EBAY_PL)

Note: To view a full list of eBay sites supported by the Browse API, see Buy API Support by Marketplace.

v1.4.1

The following section describes the changes made in this release.

Updated error message 12029 and added error message 12032 for search and searchByImage

The error message for error code 12029 was updated for the search and searchByImage methods:

Old Error Message	New Error Message
The number of sellers in the filter has exceeded the limit. Please reduce the number of sellers to 250 or fewer.	The maximum number of listings that can be retrieved is 10,000, so your offset value must be less than 10,000. If 10,000 or more listings are matching your search criteria, consider narrowing the scope of your search.

Error code 12032 was added to the search and searchByImage methods:

Error ID	Message
12032	The number of sellers in the filter has exceeded the limit. Please reduce the number of sellers to 250 or fewer.

v1.4.0

The following sections describe the changes made in this release.

Added support for taxes container to getItems and getItem compact response

The taxes container is now returned for the getItems resource method, as well as for the getItem compact response.

This container returns the tax information for the item, such as the tax jurisdiction, the tax percentage, and the tax type.

Updated field descriptions for value-added tax (VAT)

The price and shippingCost response field descriptions where updated to inform users that the value returned in these fields includes a value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB) to see the VAT-inclusive pricing/cost.

For the search and searchByImage methods, users can also see VAT-inclusive pricing returned in the price and shippingCost response fields by doing one (or both) of the following:

Specify the supported marketplace using the deliveryCountry filter URI parameter (such as filter=deliveryCountry:GB)
Pass the contextualLocation values for the supported marketplace in the X-EBAY-C-ENDUSERCTX request header

Note: Refer to the VAT Obligations in the EU article for more information about VAT.

v1.3.0

The following section describes the changes made in this release.

Added searchInDescription filter URI parameter

Support for a new searchInDescription filter URI parameter was added to the search resource method.

The new filter returns only the items with titles or descriptions matching the specified keyword.

Note: Refer to the Buy API Field Filters section of the Buying Integration Guide for details and examples for all the available filters.

v1.2.0

The following sections describe the changes made in this release.

Added AUTHENTICITY_VERIFICATION to qualifiedPrograms filter

Support for AUTHENTICITY_VERIFICATION was added to the qualifiedPrograms filter URI parameter in the search and searchByImage resource methods. The new filter returns only the items that are qualified for the Authenticity Guarantee program. This program enables third-party authenticators to perform authentication verification inspections on items.

Note: Refer to the Buy API Field Filters section of the Buying Integration Guide for details and examples for all the available filters.

Added AuthenticityVerificationProgram type to item methods

A new AuthenticityVerificationProgram type was added to the item resource methods. The authenticityVerification container is returned for items that are qualified for the Authenticity Guarantee program.

v1.1.0

This version includes the following update.

New regionId field added for included and excluded shipping regions.

A new regionId field is now returned for each shipping region that is returned under the regionIncluded and regionExcluded containers for all 'get item' responses. Based on the regionType value, values for the regionId may include two-letter, ISO 3166 country codes, two-letter abbreviations for US states or Canadian provinces, or eBay-defined IDs that represent large geographical regions or special domestic regions within an individual country.

v1.0.0

This is the initial general availability (GA) release for the Browse API. This release does not include any functionality or schema changes for the Browse API methods.

Note: Refer to API versioning for more information about eBay API lifecycles, and see the Browse API Release Notes Archive for older beta release information.