This archive document contains information about older releases. For current releases, see Browse API Release Notes.
| Release Version | Release Date | Description of Release |
|---|---|---|
| v1.9.0 | 2021-10-18 |
Added Browse API support for two new marketplaces: Austria (AT) and Switzerland (CH) |
| 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:
|
| 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 |
|
| 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 |
|
| 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_beta.36.0 | 2020-10-07 |
|
| v1_beta.35.0 | 2020-10-01 |
|
| v1_beta.34.1 | 2020-09-22 | Added support for the Singapore (SG) marketplace to the item_summary resource |
| v1_beta.34.0 | 2020-08-10 |
|
v1.9.0
The following section describes the changes made in this release.
Added Browse API support for AT and CH marketplaces
The Browse API methods item and item_summary are enabled for the Austria (AT) and Switzerland (CH) marketplaces.
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 seller has made the item a priority listing, such as by making it a Promoted Listing. Promoted Listings are available to Above Standard and Top Rated sellers with recent sales activity. For more information, see Promoted Listings.
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.
Note: To view a full list of eBay sites supported by the Browse API, see Buy API Support by Marketplace.
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)
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 were 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
contextualLocationvalues for the supported marketplace in theX-EBAY-C-ENDUSERCTXrequest 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.
v1_beta.36.0
The following sections describe the changes made in this release.
Added getItems method and bulk item search functionality
The getItems method has been added to the Browse API. Multiple item ids and item group ids can now be queried for at the same time. This functionality impacts the getItem and getItems methods.
The getItem method will now show the itemWebUrl and itemAffiliateWebUrl fields for the request fieldgroups="COMPACT".
Added new error messages
| Error ID | Message |
|---|---|
| 11012 | The specified item ids are invalid, or the format of the specified values are invalid. |
| 11013 | The specified group ids are invalid, or the format of the specified values are invalid. |
| 11014 | An item_IDs and an item_group_IDs list cannot be used at same time. Please use only one of these lists. |
| 11015 | The maximum number of item IDs has been exceeded. Please reduce the number of item IDs to {maxAllowedItemIds} or less. |
| 11016 | The maximum number of item group IDs has been exceeded. Please reduce the number of item group IDs to {maxAllowedItemGroupIds} or less. |
| 11017 | An item_ids or an item_group_ids list is required. Please use one of these lists. |
v1_beta.35.0
The following sections describe the changes made in this release.
Added a new error message
The following error message was added to the search and searchbyimage methods:
| Error ID | Message |
|---|---|
| 12030 | The number of categories in the request has exceeded the limit. Please reduce the number of categories to {allowedMaxCategories} or less. |
Added two new URI parameters
The following URI parameters were added to the searchbyimage method in this release:
| URI Parameter | Description |
|---|---|
| charity_ids | This parameter is used to limit the search results to only items associated with the specified charity. |
| fieldgroups | This parameter is used to define the values that are returned in the search response. |
Removed a URI parameter
Support for the epid URI parameter was removed from the searchbyimage method in this release.
Note: The epid URI parameter is still supported by the search method.
v1_beta_34.1
Support for the Singapore (SG) marketplace has been added to the item_summary resource in the Browse API.
v1_beta.34.0
Added restriction to sellers:filter for search and searchbyimage methods
A new restriction for the sellers API filter was added. This restriction limits the number of sellers returned in a search to a maximum of 250.
This filter restriction affects the search and searchbyimage methods.
Added new error message
The following error message was added to the search and searchbyimage methods:
| Error ID | Message |
|---|---|
| 12029 | The number of sellers in the filter has exceeded the limit. Please reduce the number of sellers to 250 or fewer. |