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.20.1 | 2025-01-17 | Added the contactUrl response field to the getItem, getItems, getItemByLegacyId, and getItemsByItemGroup methods. |
v1.20.0 | 2025-01-07 | Added a new query parameter, quantity_for_shipping_estimate, and response field, immediatePay, to getItem, getItems, getItemByLegacyId, and getItemsByItemGroup methods. |
v1.19.9 | 2024-09-09 | Added return of a listing's actual remaining quantity available for delivery in getItem, getItems, getItemByLegacyId, and getItemsByItemGroup methods. |
v1.19.8 | 2024-08-08 | Added support for GPSR information. |
v1.19.7 | 2024-04-17 | Added support for affiliate links for the Polish marketplace. |
v1.19.6 | 2024-03-19 |
Expanded values for the itemLocationRegion filter for the search method. Added support for the Belgium marketplace. |
v1.19.5 | 2024-02-13 | Added support for the itemLocationRegion filter for the search method. |
v1.19.4 | 2024-01-30 | Added support for required Economic Operator information. |
v1.19.3 | 2024-01-29 | Expanded marketplace support for auto correction of browse terms. |
v1.19.2 | 2023-10-24 | Added support for the userId response field to the following methods: getItem, getItemByLegacyId, and getItemsByItemGroup. |
v1.20.1
The following changes have been made in this release:
Schema changes
The contactUrl field has been added to the CompanyAddress and ResponsiblePerson types of the getItem, getItems, getItemByLegacyId, and getItemsByItemGroup methods. This field returns the electronic contact information of a manufacturer and/or responsible person associated with a product (if GPSR information is provided on a listing).
v1.20.0
The following changes has been made in this release:
Schema changes
The following schema changes have been made:
-
The quantity_for_shipping_estimate query parameter has been added to the getItem, getItems, getItemByLegacyId, and getItemsByItemGroup methods. This query parameter sets the item quantity to be used when calculating the shipping estimate information returned in the response.
-
The immediatePay response field has been added to the getItem, getItems, getItemByLegacyId, and getItemsByItemGroup methods. This boolean indicates that the seller requires immediate payment from the buyer when purchasing an item.
New error code and warning
The following error code and warning were added to the getItem, getItems, getItemByLegacyId, and getItemsByItemGroup methods:
-
A new error code 11019 has been added with the following description: "The quantity_for_shipping_estimate value {quantityForShippingEstimate} is invalid. Please enter a positive value."
-
A new warning 11510 has been added with the following description: "There was a problem calculating the shipping cost. Please try again."
v1.19.9
This release adds the return of the actual remaining quantity for a listing through the estimatedRemainingQuantity field. This field was added to the EstimatedAvailability type in the getItem, getItems, getItemByLegacyId, and getItemsByItemGroup methods.
v1.19.8
In preparation for new legal requirements by the European Union taking effect on December 13th, 2024, this release adds support for General Product Safety Regulation (GPSR) information.
Schema changes
To support the upcoming regulatory requirements, schema changes have been made to support GPSR information. The following types, and their associated fields and enumerated values, have been added to the getItem, getItemByLegacyId, and getItemsByItemGroup methods to provide seller provided GPSR information:
-
CompanyAddress type (in the manufacturer container): This type is used to provide contact information for the manufacturer of the product.
-
ResponsiblePerson (in the responsiblePersons container): This type provides information, such as name and contact details, for an EU-based Responsible Person or entity, associated with the product.
-
ProductSafetyLabels (in the productSafetyLabels container): This type contains the ProductSafetyLabelPictogram type and ProductSafetyLabelStatement type, and provides seller provided product safety pictograms and statements for the listing.
v1.19.7
The following change has been made in this release:
Expanded support for affiliate links
Affiliate links are now supported for the Polish Marketplace (EBAY_PL).
v1.19.6
The following changes have been made in this release:
Expanded values for itemLocationRegion filter
The itemLocationRegion filter has been expanded to include the following values:
-
ASIA
-
BORDER_COUNTRIES
-
CONTINENTAL_EUROPE
-
EUROPEAN_UNION
-
NORTH_AMERICA
-
UK_AND_IRELAND
New error code
A new error code 12517 has been added in the search method with the following description: "The 'itemLocationRegion' filter value is not supported for the marketplace {marketplaceId}. Valid values are: {validRegionValues}."
Expanded supported marketplaces
Belgium (EBAY_BE) has been added as a supported marketplace for the Browse API.
Added Accept-Language header
The Accept-Language header has been added to methods of the Browse API. This header allows users to toggle between supported languages on the Belgian and Canadian marketplaces. For more information on this header, see HTTP request headers.
v1.19.5
The following changes have been made in this release:
Added itemLocationRegion filter
The search method now supports the itemLocationRegion filter. This filter allows only items located in a specific region to be returned in the response. The only currently supported value is WORLDWIDE
.
New error code
A new error code 12517 has been added in the search method with the following description: "Only one item location filter can be applied at a time. Refer to the API call documentation."
v1.19.4
The following changes have been made in this release:
Schema changes
To support new legal requirements by the European Union and the UK to provide Economic Operator information, the following schema changes have been made:
- The following new type has been added to the getItem, getItemByLegacyId, getItems, and getItemsByItemGroup methods:
EconomicOperator
: provides required Economic Operator information about the manufacturer and/or supplier of the item.
- The following new field has been added to the
SellerLegalInfo
type:economicOperator
: Provides required information about the manufacturer and/or supplier of the item.
v1.19.3
The following changes have been made in this release:
Expanded marketplace support for auto correction of browse terms
The list of marketplaces that support the auto correction of browse terms has been expanded and now includes:
- Austria
- Australia
- Canada
- Switzerland
- Germany
- Spain
- France
- United Kingdom
- Ireland
- Italy
Schema changes
There are no schema changes associated with this release.
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.