Browse API Release Notes

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

• Using eBay RESTful APIs
• Buying Integration Guide
• Browse API Overview
• Browse API Reference

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.19.2	2023-10-24	Added support for the userId response field to the following methods: getItem, getItemByLegacyId, and getItemsByGroupId.
v1.19.1	2023-08-10	Added new Error Code 12516 for search method.
v1.19.0	2023-06-26	Added support for the conditionDescriptors field to the following methods: getItem, getItemByLegacyId, getItemsByItemGroup
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.19.2

The following changes have been made in this release: 

Added the userId field

The userId field can now be returned for the getItems, getItembyLegacyId, and getItemsByGroupId methods. This field provides the unique identifier of a seller across all eBay sites. This value does not change, even when a user changes their username. This field is only returned when setting fieldgroups to ADDITIONAL_SELLER_DETAILS.

Added the ADDITIONAL_SELLER_INFORMATION fieldgroup

A new fieldgroups value ADDITIONAL_SELLER_DETAILS has been added to support this feature. Setting fieldgroups to ADDITIONAL_SELLER_DETAILS adds the userId field to the response.

v1.19.1

The following change has been made in this release.

Added new Error Code

A new error code 12516 has been added in the search method with description "The ‘q’ value is invalid. It must be longer than one character when using the ‘searchInDescription’ filter."

v1.19.0

The following changes have been made in this release.

Added the conditionDescriptors field

To support the return of condition descriptor information for applicable items, the following new array has been added to the getItem, getItemByLegacyId, and getItemsByItemGroup method: 

• conditionDescriptors : provides additional information about the condition of an item in a structured format.

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.

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 enumerated 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.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

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.

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.