browse APIv1_beta.26.0

Browse API Release Notes

Just getting started with the Browse API? See the fol

lowing 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.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.22.0

2019-07-15

Added fields to support eBay's Global Shipping Program

v1_beta.21.0

2019-04-30

Added support for searching for items based on compatibility

v1_beta.20.0

2019-03-13

Added the inferredEpid field

v1_beta.19.0

2019-03-07

  • Added a method to check product and item compatibility
  • Added the ebayCollectAndRemitTax field

v1_beta.18.0

2019-02-12

Added support for searching and filtering for charity items on the US and GB marketplaces

 

v1_beta.26.0

The following changes have been made to the 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.

v1_beta.22.0

Added the following fields that return eBay's Global Shipping Program shipping option and the import charges associated with this shipping option.

Field Name

Description

shippingOption.fulfilledThrough If the item is being shipped by eBay's Global Shipping Program, this field returns GLOBAL_SHIPPING. Otherwise this field is null.

Valid Values: GLOBAL_SHIPPING
shippingOption.importCharges The Global Shipping Program import charges for this item.

v1_beta.21.0

This release enables you to use the search method to search for items that are compatible with a specific product. You must submit a keyword, a fitment supported category, and the attributes used to define a specific product.

Note: The only products supported are cars, trucks, and motorcycles.

New URI parameter

The compatibility_filter parameter was added. You use this field to specify the attributes that define a specific product. The service returns items matching the keyword or keyword and product attributes. For example, if the keyword is brakes and compatibility_filter=Year:2018;Make:Honda, the items returned are items with brakes, 2018, or Honda in the title.

The service then uses the product attributes to determine if the item is compatible. The service returns the attributes that are compatible and the CompatibilityMatchEnum value that indicates how well the item matches the attributes. For details, see Check compatibility in the Buy Integration Guide.

New compatibility response fields

The following compatibility response fields were added.

Field

Description

itemSummaries.compatibilityMatchEnum An enumerated value that represent how well the item matches the compatibility filter properties. The values returned are:
  • EXACT - Indicates the item is compatible with all the compatibility properties submitted.
  • POSSIBLE - Indicates the item could fit the product. To further check for compatibility, you can either add more compatibility properties or view the details of the item.
itemSummaries.compatibilityProperties.localizedName The name of the product attribute that as been translated to the language of the site.
itemSummaries.compatibilityProperties.name The name of the product attribute, such as Make, Model, Year, etc.
itemSummaries.compatibilityProperties.value The value for the name attribute, such as BMW, R1200GS, 2011, etc.

New error messages

Error ID

Message

12503 There is no compatibility information found either because there is no compatibility results or the data provided in the compatibility_filter is invalid or insufficient.

12504

You must provide a category ID that supports fitment.
12505 The following compatibility attributes in the request are not supported: {attributes}.
12506 This category ID does not support fitment.

Testing in Sandbox

Testing in Sandbox is only supported using mock data. See Testing search in the Sandbox for details.

v1_beta.20.0

The inferredEpid field was added to the getItem, getItemByLegacyId, getItemsByItemGroup methods. This field returns the ePID (eBay Product ID of a product from the eBay product catalog) for the item, which has been programmatically determined by eBay using the item's title, aspects, and other data. If the seller provided an ePID for the item, the seller's value is returned in the epid field.

Note: This field is returned only for authorized Partners.

v1_beta.19.0

The following changes have been made to the Browse API.

Added a new method

Added the checkCompatibility method to the item resource. This method checks if a product is compatible with the specified item. This method can check the compatibility of cars, trucks, and motorcycles with a specific part listed on eBay. To check for vehichle/part compatibility. you would pass in the item ID of a part as a URI parameter and specify all the attributes used to define a specific car in the compatibilityProperties container. You must also pass in EBAY_US in the X-EBAY-C-MARKETPLACE-ID request header.

If the call is successful, the response will be COMPATIBLE, NOT_COMPATIBLE, or UNDETERMINED.

URI

POST /item/{item_id}/check_compatibility

Request payload

{
  "compatibilityProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

Response

{
    "compatibilityStatus": "COMPATIBLE"
}

For an example, see the Samples section of the call reference.

Added new error messages

The following new error messages have been added.

Error ID

Message

11503 The request is either empty or incomplete. For help, see the documentation for this call.
11505 The item is not valid for compatibility validation.
11506 The 'name' {compatibilityNames} appears more than once in the request.
11507 The following name(s) in the request are not supported {attributes}.

 

Added the ebayCollectAndRemitTax field

The ebayCollectAndRemitTax field is only returned if true, and indicates that eBay will collect tax (sales tax, Goods and Services tax, or VAT) for at least one line item in the order, and remit the tax to the taxing authority of the buyer's residence.

v1_beta.18.0

The following changes have been made to the Browse API.

Added searching for charity items capability

Added the ability to search for and filter for items associated with the specified charity. eBay charities are added to eBay through the PayPal Giving Fund. After the charity is on eBay they can be identified by their charity's registration ID, also known as the Employer Identification Number (EIN). For additional information, see eBay for Charity.

Note: This is supported only on the US and GB marketplaces.

Added URI parameters

The charity_ids URI parameter has been added to the search method. This parameter is a comma separated list of charity IDs. This field limits the results to only items associated with the specified charity.

For example, charity_ids=13-1788491,300108469

Added a charity filter

The charityOnly filter has been added to enable you to limit the items returned to only items associated with a charity. For example:

/buy/browse/v1/item_summary?q=pencil&filter=charityOnly:true