This archive document contains information about older releases. For current releases, see Browse API Release Notes.
| Release Version | Release Date | Description of Release |
|---|---|---|
| v1.18.4 | 2023-05-31 | Waste Electrical and Electronic Equipment (WEEE) registration number is now returned. |
| v1.18.3 | 2023-03-17 | Removed the shopping_cart resource and methods as the Browse API no longer supports the Shopping Cart. |
| v1.18.2 | 2023-02-08 | Added support for the fields hazardousMaterialsLabels and repairScore to the following methods: getItem, getItemByLegacyId, and getItemsByItemGroup. |
| v1.18.1 | 2022-11-09 | Added check and error for limit and offset relation condition for the search and searchByImage methods |
| v1.18.0 | 2022-09-02 |
Added the field categoryName to category objects in responses for the methods search and searchByImage Added leafCategoryIds to items in responses for the methods search and searchByImage Added INTERNATIONAL_SHIPPING to the list of enumerated values for the field fulfilledThrough; this affects the methods getItem, getItemByLegacyId, and getItemsByItemGroup |
| v1.17.0 | 2022-07-21 | Added the response field categoryIdPath to the methods getItem, getItemByLegacyId, getItems, and getItemsByItemGroup |
| v1.16.0 | 2022-05-05 | CLASSIFIED_AD has been added as a new option for the buyingOptions filter and the BUYING_OPTIONS_REFINEMENT fieldgroup |
| v1.15.0 | 2022-04-13 | Added the itemCreationDate response field to the getItem, getItemByLegacyId, getItems, and getItemsByItemGroup methods |
| v1.14.0 | 2022-03-28 | Added the shippingOptions array to the response fields returned by the getItems method and when the parameter "fieldgroups=COMPACT" is passed in with the getItem method. |
| v1.13.0 | 2022-02-16 | Added the response field addOnServices to the getItem, getItemByLegacyId, and getItemsByItemGroup methods in the Browse Search API |
| v1.12.0 | 2022-01-24 |
Added the response field itemCreationDate to the search method in the Browse Item API Added the response field listingMarketplaceId to the getItem, getItemByLegacyId, getItemsByItemGroup, and search methods in the Browse Search API |
| v1.11.0 | 2021-12-15 |
Added the response fields sellerCustomPolicies and ecoParticipationFee to the getItem, getItemByLegacyId, and getItemsByItemGroup methods in the Browse Item API Added five auction-related response fields to the getItem and getItems methods in the Browse Item API. |
| v1.10.0 | 2021-11-01 |
Added the response fields priorityListing and watchCount to the getItem, getItems, getItemByLegacyId, and getItemsByItemGroup methods in the Browse Item API Added the response field watchCount to the search and searchByImage methods in the Browse Search API Added the filter priorityListing to the search method in the Browse Search API |
| 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.18.4
The following changes have been made in this release.
Schema updates
To support the return of Waste Electrical and Electronic Equipment (WEEE) information, the following new field has been added to the SellerLegalInfo type:
- weeeNumber: the manufacturer number assigned to first distributors of electrical and electronic equipment.
v1.18.3
The following section describes the changes made in this release.
Removed Shopping Cart
The Browse API no longer supports the Shopping Cart, so the shopping_cart resource and methods, addItem, getShoppingCart, removeItem, and updateQuantity, have been removed from the documentation set.
ted value. This value indicates that the item is being shipped through the eBay International Shipping program. This change affects responses for the methods getItem, getItemByLegacyId, and getItemsByItemGroup.
v1.18.2
The following section describes the changes made in this release.
Added the field hazardousMaterialsLabels
The following methods now return the field hazardousMaterialsLabels: getItem, getItemByLegacyId, and getItemsByItemGroup.
The hazardousMaterialsLabels field provides information about hazardous material labels that apply to an item. It includes arrays of two additional fields, hazardPictogram and hazardStatement.
Added the field repairScore
The following methods now return the field repairScore: getItem, getItemByLegacyId, and getItemsByItemGroup.
The repairScore field represents the Repair Index, a value that indicates how easy it is to repair the item. Score values range from 0.1 (hardest to repair) to 10.0 (easiest), always including a single decimal place. Note: Support for this field is currently limited to the France marketplace.
v1.18.1
The following section describes the changes made in this release.
Added error for limit and offset relation condition
Error code 12515 was added to the search and searchByImage methods.
| Error ID | Message |
|---|---|
| 12515 | The 'offset' value must be either zero or a multiple of the 'limit' value. |
v1.18.0
The following sections describe the changes made in this release.
categoryName field
Each category object returned by the methods search and searchByImage now includes the field categoryName. Previously, only categoryId was returned.
leafCategoryIds array
Responses for the methods search and searchByImage now include an array of leaf category IDs for each item. An item can have up to two leaf categories. When this is the case, the leaf category IDs are returned in the order primary, secondary.
International Shipping
The field shippingOptions.fulfilledThrough now includes INTERNATIONAL_SHIPPING as a supported enumera
v1.17.0
The following section describes the changes made in this release.
Added categoryIdPath response field to Browse API
The getItem, getItemByLegacyId, getItems, and getItemsByItemGroup methods now return the response field categoryIdPath. This field contains the IDs of every category in the item path, separated by pipe characters, starting with the top level parent category.
For example, if an item belongs to the top level category Home and Garden (category ID 11700), followed by Home Improvement (159907), Heating, Cooling and Air (69197), and Thermostats (115947), the field would return the value: 11700|159907|69197|115947.
v1.16.0
The following section describes the changes made in this release.
CLASSIFIED_AD is added as a buyingOptions value
The string value CLASSIFIED_AD can be applied as a buyingOptions filter for the following methods:
- search
- searchByImage
The string value CLASSIFIED_AD is now returned in the buyingOptions array response for the following methods:
- getItem
- getItemByLegacyId
- getItems
- getItemsByItemGroup
- search
- searchByImage
Note: Refer to the Buy API Field Filters section of the Buying Integration Guide for details and examples for all the available filters.
In addition, the string value CLASSIFIED_AD is now included in the BUYING_OPTIONS_REFINEMENTS fieldgroup and may be returned within the buyingOptionDistributions array for those searches where BUYING_OPTIONS_REFINEMENTS has been set as a fieldgroup.
v1.15.0
The following section describes the changes made in this release.
Added itemCreationDate response field
The following methods now return the itemCreationDate field:
- getItem
- getItemByLegacyId
- getItems
- getItemsByItemGroup
This response field returns a timestamp that indicates the date and time an item listing was created.
Note: The timestamp value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which can be converted into the local time of the buyer.
v1.14.0
The following section describes the changes made in this release.
Added shippingOptions to the response fields for getItems and to the COMPACT option for getItem
The getItems method now returns the shippingOptions array of fields.
shippingOptions fields are also returned when the parameter "fieldgroups=COMPACT" is passed in with the getItem method.
v1.13.0
The following section describes the changes made in this release.
Added addOnServices response field to Browse Item API
The getItem, getItemByLegacyId, and getItemsByItemGroup methods now return the response field addOnServices, an array of add-on services that apply to an item, such as the eBay Authenticity Guarantee service.
An add-on service may be optional or required and may apply a fee to the item purchase.
v1.12.0
The following section describes the changes made in this release.
Added itemCreationDate and listingMarketplaceId response fields to Browse Item API
The getItem, getItemByLegacyId, getItemsByItemGroup, and search methods now return the response field listingMarketplaceId. This value indicates the eBay marketplace where the item is listed.
The search method now returns the response field itemCreationDate. This value indicates the date and time when the item listing was created.
v1.11.0
The following sections describe the changes made in this release.
Added sellerCustomPolicies and ecoParticipationFee response fields to Browse Item API
The getItem, getItemByLegacyId, and getItemsByItemGroup methods now return the response fields sellerCustomPolicies and ecoParticipationFee.
These fields implement support for extended producer responsibility (EPR) laws and regulations that are in effect in some countries.
The sellerCustomPolicies field lists custom policies that a seller applies to a listing. Currently, these policies can be one of the following types:
PRODUCT_COMPLIANCE: Discloses product information as required for regulatory compliance.TAKE_BACK: Describes the seller's legal obligation to take back a previously purchased item when the buyer purchases a new one.
The ecoParticipationFee field defines the amount remitted to an eco organization, applied to the cost of the eventual disposal of the item.
Added five auction-related response fields to Browse Item API
The getItem (COMPACT) and getItems methods now return the following five auction-related response fields:
- bidCount: an integer value that indicates the current number of bids for an auction item.
- currentBidPrice: a string indicating the current highest bid for an auction item.
- minimumPriceToBid: a string indicating the minimum price of the next bid; to place a bid it must be equal to or greater than this amount.
- reservePriceMet: a boolean value indicating if the seller-specified reserve price for an auction item has been met.
- uniqueBidderCount: an integer value indicating the number of different eBay users who have placed one or more bids on an auction item.
v1.10.0
The following sections describe the changes made in this release.
Added priorityListing and watchCount response fields to Browse Item API
The getItem, getItems, getItemByLegacyId, and getItemsByItemGroup methods now return the response fields priorityListing and watchCount.
The priorityListing field is a boolean value that indicates whether the listing is a part of a Promoted Listing campaign.
The watchCount field is an integer value that indicates the number of users that have added the item to their watch list.
Added watchCount response field to Browse Search API
The search and searchByImagemethods now return the response field watchCount.
The watchCount field is an integer value that indicates the number of users that have added the item to their watch list.
Added priorityListing filter to Browse Search API
The search method now supports the priorityListing filter parameter. When set to true, this filter returns only items that are a part of a Promoted Listing campaign.
Note: Refer to the Buy API Field Filters section of the Buying Integration Guide for details and examples for all the available filters.
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.
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. |