browse APIv1_beta.34.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_beta.34.0

2020-08-10

  • Added a new restriction to sellers:filter for the search and searchbyimage methods.
  • Added a new error message to the search and searchbyimage methods.

v1_beta.33.0

2020-06-09

  • Added a new paymentMethods container to the response of the Item resource methods
  • Added a new conditionDescription field to the response of the Item resource methods

v1_beta.32.0

2020-05-05

  • Added support for newlyListed to the sort query parameter in the search and searchByImage resource methods
  • Added new warning messages to the item resource methods
  • Added a new warnings container to the getItemsByItemGroup resource method

v1_beta.31.0

2020-04-09

Enabled the itemEndDate field to be returned in the COMPACT getItem response

v1_beta.30.0

2020-04-09

  • Added an availableCoupons object container to the response of the item resource methods
  • Added an availableCoupons boolean flag to the response of the search and searchByImage resource methods

v1_beta.29.0

2020-03-26

  • Added support for legacyItemId to the item and search resource methods
  • Added support for autoCorrections to the search resource method

v1_beta.28.0

2020-02-10

Added support for the Goods and Services tax to the item resource methods

v1_beta.27.0

2020-01-13

  • Added fields for lot size, eBay Guaranteed Delivery, and qualified programs, such as eBay Plus,
  • Added a GST (guaranteed delivery tax) enumeration value to TaxType
  • Added a filter for Guaranteed Delivery items
  • Added new error messages

v1_beta.26.0

2019-10-11

  • Added support for Best Offer and pricing treatment to the item resource methods
  • Anonymized the postal code returned in the itemLocation.postalCode field
v1_beta.25.0

2019-09-17

Added the eligibleForInlineCheckout field to the fieldgroups COMPACT response in the getItem method

v1_beta.24.0

2019-09-09

Added a field that indicates whether the item can be purchased using the Buy Order API

v1_beta.23.0

2019-08-12

Added support for Best Offer and pricing treatment to search and searchByImage methods

v1_beta.34.0

The following sections describe the changes made in this release.

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.

v1_beta.33.0

The following sections describe the changes made in this release.

Added paymentMethods response container

A new paymentMethods container was added to the responses of the getItem, getItemByLegacyID, and getItemsByItemGroup resource methods. This new container presents the payment methods for the item, including the payment method types, brands, and instructions for the buyer.

Added conditionDescription response field

A new conditionDescription field was added to the responses of the getItem, getItemByLegacyID, and getItemsByItemGroup resource methods. This new field presents a full text description and details for the condition of the item.

Note: This field elaborates on the value specified in the condition field, which provides only a short text description for the condition of the item (such as New or Used).

v1_beta.32.0

The following sections describe the changes made in this release.

Added newlyListed sort query parameter

Support for newlyListed was added to the sort query parameter in the search and searchByImage resource methods. This query parameter sorts the result set by listing date, showing the most recently listed item first.

Added new warning messages

The following warning messages were added to the getItem, getItemByLegacyID, and getItemsByItemGroup resource methods:

Warning ID

Message

11508 This seller is currently away. If you make a purchase, please allow additional time for your order to be processed.
11509 This seller is currently away until {sellerReturnDate}. If you make a purchase, please allow additional time for your order to be processed.

Added new warnings container

A new warnings container was added to the getItemsByItemGroup resource method, which contains all of the warning messages for the response.

v1_beta.31.0

The following section describes the change made in this release.

itemEndDate field added to the COMPACT response of getItem

Enabled the itemEndDate field to be returned in the COMPACT getItem response. To enable a COMPACT response in getItem, the fieldgroups query parameter is used and set to COMPACT (e.g. ?fieldgroups=COMPACT).

v1_beta.30.0

The following sections describe the changes made in this release.

Added availableCoupons container

A new availableCoupons object container was added to the response of the following item operations:

  • getItem
  • getItemByLegacyId
  • getItemByItemGroup

The availableCoupons container returns a list of available coupons for an item.

Added availableCoupons boolean flag

A new availableCoupons boolean flag was added to the itemSummaries object container in the response of the search and searchByImage operations. The itemSummaries.availableCoupons boolean value indicates whether coupons are available for the item.

v1_beta.29.0

The following sections describe the changes made in this release.

Added legacyItemId support

The legacyItemId response was added to the following item operations:

  • getItem
  • getItemByLegacyId
  • getItemByItemGroup

The legacyItemId response was added to the following search operations:

  • search
  • searchByImage

Added autoCorrections support

A new auto_correct query parameter was added to the search and searchByImage operations. The responses for these operations now return an optional autoCorrections container when the auto_correct query parameter is passed.

v1_beta.28.0

The following change has been made to the item resource method.

Support was added for the Goods and Services tax.

An enumeration value of GST may now be returned as a tax type under the taxes.taxType field in the response of the three Get Item operations. The Goods and Services tax is only applicable to the eBay Australia marketplace. To support this change, the GST value has been added the TaxType enumeration type.

v1_beta.27.0

The following sections describe the changes made in this release.

item_summary and search_by_image resource changes

The following has been added to all the methods in the item_summary and search_by_image resources.

Field/Filter Name

Description

ItemSummary.qualifiedPrograms

An array of the qualified programs available for the item, such as EBAY_PLUS.

eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top-Rated eBay sellers must opt in to eBay Plus to be able to offer the program on qualifying listings. Sellers must commit to next-day delivery of those items.

Note: eBay Plus is available only to buyers in Germany, Austria, and Australia marketplaces.

ShippingOptionSummary.guaranteedDelivery A boolean the indicates if the item qualifies for eBay's Global Shipping Program.

guaranteedDeliveryInDays filter

Only items that can be delivered to the buyer within the specified number of days are returned. See Buy API Field Filters for details.

 

Error ID

Message

12507 To filter by 'guaranteedDeliveryInDays', you must include 'deliveryCountry'.
12508 To filter by 'guaranteedDeliveryInDays', you must include 'deliveryPostalCode' for the 'deliveryCountry'.
12509 The 'guaranteedDeliveryInDays' value {guaranteedDeliveryInDays} is invalid for 'deliveryCountry' value {deliveryCountry}. Valid values for 'guaranteedDeliveryInDays' for {deliveryCountry} must be in the range of {rangeLowerBound} to {rangeUpperBound} inclusive.
12510 The 'guaranteedDeliveryInDays' filter is not supported for the marketplace {marketplaceId}. Valid marketplaces are: {validMarketplaces}

 

item resource changes

The following has been added to all the methods in the item resource.

Field/Enum Name

Description

Item.lotSize The number of items in a lot. In other words, a lot size is the number of items that are being sold together.

A lot is a set of two or more items included in a single listing that must be purchased together in a single order line item. All the items in the lot are the same but there can be multiple items in a single lot, such as the package of batteries shown in the example below.

ItemLot DefinitionLot Size
A package of 24 AA batteriesA box of 10 packages10
A P235/75-15 Goodyear tire 4 tires 4
Fashion Jewelry Rings Package of 100 assorted rings 100

Note: Lots are not supported in all categories.

Item.qualifiedPrograms An array of the qualified programs available for the item, such as EBAY_PLUS.

eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top-Rated eBay sellers must opt in to eBay Plus to be able to offer the program on qualifying listings. Sellers must commit to next-day delivery of those items.

Note: eBay Plus is available only to buyers in Germany, Austria, and Australia marketplaces.

ShippingOption.guaranteedDelivery A boolean the indicates if the item qualifies for eBay's Global Shipping Program.
TaxType enum GST: New enumeration value that indicates the tax is a Global Shipping Program tax.

 

v1_beta.26.0

The following changes have been made to the item resource methods.

Added Best Offer

BEST_OFFER is now returned in the buyingOptions field in the item resource methods.

Added a value to PriceDisplayConditionEnum

Added the following enumeration value to the PriceDisplayConditionEnum type in the item resource methods.

ONLY_SHOW_ON_REQUEST: Indicates the minimum advertised price can be shown only when the buyer requests to see it.

Added pricing treatment elements

The following changes have been made to the item resource methods to support price discounts:

  • Added the MarketingPrice.priceTreatment field, which returns an enumeration value that represents the pricing treatment (discount) that was applied to the price of the item. Note: The pricing treatment affects the way and where the discounted price can be displayed.
  • Added the PriceTreatmentEnum type which defines the following values that represent a discount type.

    Enum Value

    Description

    MINIMUM_ADVERTISED_PRICE Indicates the price treatment is Minimum Advertised Price (MAP). This is the lowest price the item is allowed to be advertised/shown at and can be shown only after the item has been added to the cart. For details about when in the buying flow the item's price can appear, see priceDisplayConditionEnum.
    LIST_PRICE Indicates the price treatment is Strike through pricing (STP). For this treatment, the list price, which is crossed off (struck through) and discounted price are shown. List price is the price a seller recently listed the item for sale or sold the item for.
    MARKDOWN Indicates the price treatment is a markdown. The price before the markdown (Was price) is shown as well as the discount price. This item is part of a seller promotion and has an end date.

Anonymized postal Code in itemLocation field

Sellers set a postal code (or zip code in US) for items when they are listed. The postal code is used for calculating proximity searches. In all the Browse API methods It has been anonymized when returned in itemLocation.postalCode via the API.

 

v1_beta.25.0

Added the eligibleForInlineCheckout field to the fieldgroups COMPACT response of the getItem method.

Query Parameter

Type

Description

eligibleForInlineCheckout Boolean This field indicates if the item can be purchased using the Order API.

v1_beta.24.0

Added the following field to the getItem and getItemByLegacyId methods.

Field Name

Type

Description

eligibleForInlineCheckout

boolean

This field indicates if the item can be purchased using the Buy Order API.
  • If the value is true, this indicates that the item can be purchased using the Order API.
  • If the value is false, this indicates that the item cannot be purchased using the Order API and must be purchased on the eBay site.

v1_beta.23.0

The following changes have been made to the search and searchByImage methods.

Added Best Offer

BEST_OFFER is now returned in the itemSummaries.buyingOptions field. It has also been added to the buyingOptions filter, which gives you the ability to return only items that have Best Offer. For details about this filter, see the buyingOptions filter documentation.

Added a value to PriceDisplayConditionEnum

Added the following enumeration value to the PriceDisplayConditionEnum type.

ONLY_SHOW_ON_REQUEST: Indicates the minimum advertised price can be shown only when the buyer requests to see it.

Added pricing treatment elements

The following changes have been made to support price discounts:

  • Added the MarketingPrice.priceTreatment field, which returns an enumeration value that represents the pricing treatment (discount) that was applied to the price of the item. Note: The pricing treatment affects the way and where the discounted price can be displayed.
  • Added the PriceTreatmentEnum type which defines the following values that represent a discount type.

    Enum Value

    Description

    MINIMUM_ADVERTISED_PRICE Indicates the price treatment is Minimum Advertised Price (MAP). This is the lowest price the item is allowed to be advertised/shown at and can be shown only after the item has been added to the cart. For details about when in the buying flow the item's price can appear, see priceDisplayConditionEnum.
    LIST_PRICE Indicates the price treatment is Strike through pricing (STP). For this treatment, the list price, which is crossed off (struck through) and discounted price are shown. List price is the price a seller recently listed the item for sale or sold the item for.
    MARKDOWN Indicates the price treatment is a markdown. The price before the markdown (Was price) is shown as well as the discount price. This item is part of a seller promotion and has an end date.