API docs by Redocly

Browse API (v1.18.0)

Download OpenAPI specification:Download

License: eBay API License Agreement

The Browse API has the following resources:

  • item_summary: Lets shoppers search for specific items by keyword, GTIN, category, charity, product, or item aspects and refine the results by using filters, such as aspects, compatibility, and fields values.
  • search_by_image: Experimental Release (Experimental) Lets shoppers search for specific items by image. You can refine the results by using URI parameters and filters.
  • item:
    • Lets you retrieve the details of a specific item or all the items in an item group, which is an item with variations such as color and size and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part.
    • Provides a bridge between the eBay legacy APIs, such as Finding, and the RESTful APIs, which use different formats for the item IDs.
  • shopping_cart: Experimental Release (Experimental) Limited Release(Limited Release) Provides the ability for eBay members to see the contents of their eBay cart, and add, remove, and change the quantity of items in their eBay cart.   Note: This resource is not available in the eBay API Explorer.

The item_summary, search_by_image, and item resource calls require an Application access token. The shopping_cart resource calls require a User access token.

item_summary

search

This method searches for eBay items by various query parameters and retrieves summaries of the items. You can search by keyword, category, eBay product ID (ePID), or GTIN, charity ID, or a combination of these.

Note: Only listings where FIXED_PRICE (Buy It Now) is a buying option are returned by default. To retrieve listings that do not have FIXED_PRICE as a buying option, the buyingOptions filter can be used to retrieve those listings.

Note that an auction listing enabled with the 'Buy it Now' feature will initially show AUCTION and FIXED_PRICE as buying options, but if/when that auction listing receives a qualifying bid, only AUCTION would remain as a buying option. If this happens, the buyingOptions filter would need to be used to retrieve that auction listing.

This method also supports the following:

  • Filtering by the value of one or multiple fields, such as listing format, item condition, price range, location, and more. For the fields supported by this method, see the filter parameter.
  • Retrieving the refinements (metadata) of an item , such as item aspects (color, brand), condition, category, etc. using the fieldgroups parameter.
  • Filtering by item aspects and other refinements using the aspect_filter parameter.
  • Filtering for items that are compatible with a specific product, using the compatibility_filter parameter.
  • Creating aspects histograms, which enables shoppers to drill down in each refinement narrowing the search results.

For details and examples of these capabilities, see Browse API in the Buying Integration Guide.

Pagination and sort controls

There are pagination controls (limit and offset fields) and sort query parameters that control/sort the data that is returned. By default, the results are sorted by "Best Match". For more information about Best Match, see the eBay help page Best Match.

URLs for this method

  • Production URL:https://api.ebay.com/buy/browse/v1/item_summary/search?
  • Sandbox URL:https://api.sandbox.ebay.com/buy/browse/v1/item_summary/search?

Request headers

This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide.

Restrictions

This method can return a maximum of 10,000 items. For a list of supported sites and other restrictions, see API Restrictions.

eBay Partner Network: In order to receive a commission for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.
Authorizations:
Client_Credentials
query Parameters
aspect_filter
string

This field lets you filter by item aspects. The aspect name/value pairs and category, which is required, is used to limit the results to specific aspects of the item. For example, in a clothing category one aspect pair would be Color/Red.

For example, the method below uses the category ID for Women's Clothing. This will return only items for a woman's red shirt.

/buy/browse/v1/item_summary/search?q=shirt&category_ids=15724&aspect_filter=categoryId:15724,Color:{Red}

To get a list of the aspect pairs and the category, which is returned in the dominantCategoryId field, set fieldgroups to ASPECT_REFINEMENTS.

/buy/browse/v1/item_summary/search?q=shirt&fieldgroups=ASPECT_REFINEMENTS

Note: The pipe symbol is used as a delimiter between aspect filter values. If a value contains a pipe symbol (for example, the brand name 'Bed|Stü'), you must enter a backslash before the pipe character to prevent it from being evaluated as a delimiter.

The following example shows the correct format for entering two brand names as aspect filter values, one of which contains a pipe symbol:

/buy/browse/v1/item_summary/search?limit=50&category_ids=3034&filter=buyingOptions:{AUCTION|FIXED_PRICE}&aspect_filter=categoryId:3034,Brand:{Bed\|Stü|Nike}

Required: The category ID is required twice; once as a URI parameter and as part of the aspect_filter. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/gct:AspectFilter

auto_correct
string

A query parameter that enables auto correction.

Valid Values: KEYWORD

category_ids
string

The category ID is used to limit the results. This field can have one category ID or a comma separated list of IDs.

For example:
/buy/browse/v1/item_summary/search?category_ids=29792

Note: Currently, you can pass in only one category ID per request.

You can also use any combination of the category_Ids, epid, and q fields. This gives you additional control over the result set.

For example, let's say you are looking of a toy phone. If you search for "phone", the result set will be mobile phones because this is the "Best Match" for this search. But if you also include the toy category ID, the results will be what you wanted.

For example:
/buy/browse/v1/item_summary/search?q=phone&category_ids=220

The list of eBay category IDs is not published and category IDs are not the same across all the eBay marketplaces. You can use the following techniques to find a category by site:

  • Use the Category Changes page.
  • Use the Taxonomy API. For details see Get Categories for Buy APIs.
  • Submit the following method to get the dominantCategoryId for an item.

    /buy/browse/v1/item_summary/search?q= keyword&fieldgroups=ASPECT_REFINEMENTS
Note: If a top-level (L1) category is specified, you must also include the q query parameter.

Required: The method must have category_ids, epid, gtin, or q (or any combination of these)

charity_ids
string

The charity ID is used to limit the results to only items associated with the specified charity. This field can have one charity ID or a comma separated list of IDs. The method will return all the items associated with the specified charities.

For example:
/buy/browse/v1/item_summary/search?charity_ids=13-1788491,300108469

The charity ID is the charity's registration ID, also known as the Employer Identification Number (EIN). In GB, it is the Charity Registration Number (CRN), commonly called "Charity Number".

  • To find the charities eBay supports, you can search for a charity at Charity Search or go to Charity Shop.
  • To find the charity ID of a specific charity, click on a charity and use the EIN number. For example, the charity ID for American Red Cross, is 530196605.
You can also use any combination of the category_Ids and q fields with a charity_Ids to filter the result set. This gives you additional control over the result set.

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

Maximum: 20 IDs

Required: One ID

compatibility_filter
string

This field specifies the attributes used to define a specific product. The service searches for items matching the keyword or matching the keyword and a product attribute value in the title of the item.

Note: The only products supported are cars, trucks, and motorcycles.
For example, if the keyword is brakes and compatibility-filter=Year:2018;Make:BMW, the items returned are items with brakes, 2018, or BMW in the title.

The service uses the product attributes to determine whether 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.

Tip: See the Samples section for a detailed example.
Best Practice: Submit all of the product attributes for the specific product.

To find the attributes and values for a specific marketplace, you can use the getCompatibilityProperties method in the Taxonomy API.

For more details, see Check compatibility in the Buy Integration Guide.

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

  • q (keyword)
  • One fitment supported category ID (such as 33559 Brakes)
  • At least one product attribute name/value pair
For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/gct:CompatibilityFilter

epid
string

The ePID is the eBay product identifier of a product from the eBay product catalog. This field limits the results to only items in the specified ePID.

The Marketing API getMerchandisedProducts method and the Browse API getItem, getItemByLegacyId, and getItemsByItemGroup calls return the ePID of the product. You can also use the product_summary/search method in the Catalog API to search for the ePID of the product.

For example:
/buy/browse/v1/item_summary/search?epid=15032

Maximum: 1

Required: The method must have category_ids, epid, gtin, or q (or any combination of these)

fieldgroups
string

This field is a comma separated list of values that lets you control what is returned in the response. The default is MATCHING_ITEMS, which returns the items that match the keyword or category specified. The other values return data that can be used to create histograms or provide additional information.

Valid Values:

  • ASPECT_REFINEMENTS - This returns the aspectDistributions container, which has the dominantCategoryId, matchCount, and refinementHref for the various aspects of the items found. For example, if you searched for 'Mustang', some of the aspect would be Model Year, Exterior Color, Vehicle Mileage, etc.

    Note: ASPECT_REFINEMENTS are category specific.
  • BUYING_OPTION_REFINEMENTS - This returns the buyingOptionDistributions container, which has the matchCount and refinementHref for AUCTION, FIXED_PRICE (Buy It Now), and CLASSIFIED_AD items.
  • CATEGORY_REFINEMENTS - This returns the categoryDistributions container, which has the categories that the item is in.
  • CONDITION_REFINEMENTS - This returns the conditionDistributions container, such as NEW, USED, etc. Within these groups are multiple states of the condition. For example, New can be New without tag, New in box, New without box, etc.
  • EXTENDED - This returns the shortDescription field, which provides condition and item aspect information and the itemLocation.city field.
  • MATCHING_ITEMS - This is meant to be used with one or more of the refinement values above. You use this to return the specified refinements and all the matching items.
  • FULL - This returns all the refinement containers and all the matching items.
Code so that your app gracefully handles any future changes to this list.

Default: MATCHING_ITEMS

filter
string

An array of field filters that can be used to limit/customize the result set.

For example:
/buy/browse/v1/item_summary/search?q=shirt&filter=price:[10..50]

You can also combine filters.
/buy/browse/v1/item_summary/search?q=shirt&filter=price:[10..50],sellers:{rpseller|bigSal}

Note: Refer to Buy API Field Filters for details and examples of all supported filters. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/cos:FilterField

gtin
string

This field lets you search by the Global Trade Item Number of the item as defined by https://www.gtin.info. You can search only by UPC (Universal Product Code). If you have other formats of GTIN, you need to search by keyword.

For example:
/buy/browse/v1/item_summary/search?gtin=099482432621

Maximum: 1

Required: The method must have category_ids, epid, gtin, or q (or any combination of these)

limit
string

The number of items from the result set returned in a single page.

Note: If a value is set in the limit field, the value of offset must be either zero or a multiple of the limit value. An error is returned for invalid values of offset.

Default: 50

Maximum number of items per page (limit): 200

Maximum number of items in a result set: 10,000

offset
string

Specifies the number of items to skip in the result set. This is used with the limit field to control the pagination of the output.

For example, if offset is 0 and limit is 10, the method will retrieve items 1-10 from the list of items returned; if offset is 10 and limit is 10, the method will retrieve items 11-20 from the list of items returned.

Note: The value of offset must be either zero or a multiple of the value set in the limit field. An empty result set is returned for invalid values of offset.

Valid Values: 0-10,000 (inclusive)

Default: 0

Maximum number of items returned: 10,000

q
string

A string consisting of one or more keywords that are used to search for items on eBay. The keywords are handled as follows:

  • If the keywords are separated by a space, it is treated as an AND. In the following example, the query returns items that have iphone AND ipad.

    /buy/browse/v1/item_summary/search?q=iphone ipad

  • If the keywords are input using parentheses and separated by a comma, or if they are URL-encoded, it is treated as an OR. In the following examples, the query returns items that have iphone OR ipad.

    /buy/browse/v1/item_summary/search?q=(iphone, ipad)

    /buy/browse/v1/item_summary/search?q=%28iphone%2c%20ipad%29

Restriction: The * wildcard character is not allowed in this field.

Required: The method must have category_ids, epid, gtin, or q (or any combination of these).

sort
string

The order and field name that is used to sort the items.

You can sort items by price, distance, or listing date. To sort in descending order, insert a hyphen (-) before the name of the sorting option. If no sort parameter is submitted, the result set is sorted by "Best Match".

Here are some examples showing how to use the sort query parameter:

  • sort=distance - This sorts by distance in ascending order (shortest distance first). This sorting option is only applicable if the pickup filters are used, and only ascending order is supported.
  • sort=-price - This sorts by price + shipping cost in descending order (highest price first). This sorting option (by price) is only guaranteed to work correctly if the X-EBAY-C-ENDUSERCTX request header is used, with the contextualLocation parameter being used to set the delivery country and postal code. Here is an example of how this header would be used to do this (note the URL encoding):

    X-EBAY-C-ENDUSERCTX: contextualLocation=country%3DUS%2Czip%3D19406
  • sort=newlyListed - This sorts by listing date (most recently listed/newest items first).
  • sort=endingSoonest - This sorts by date/time the listing ends (listings nearest to end date/time first).
Default: Ascending For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/cos:SortField

Responses

search_by_image

searchByImage

Experimental Release This is an Experimental method.

This method searches for eBay items based on a image and retrieves summaries of the items. You pass in a Base64 image in the request payload and can refine the search by category, or eBay product ID (ePID), or a combination of these using URI parameters.

To get the Base64 image string, you can use sites such as https://codebeautify.org/image-to-base64-converter.

This method also supports the following:

  • Filtering by the value of one or multiple fields, such as listing format, item condition, price range, location, and more. For the fields supported by this method, see the filter parameter.
  • Filtering by item aspects using the aspect_filter parameter.

For details and examples of these capabilities, see Browse API in the Buying Integration Guide.

Pagination and sort controls

There are pagination controls (limit and offset fields) and sort query parameters that control/sort the data that is returned. By default, the results are sorted by "Best Match". For more information about Best Match, see the eBay help page Best Match.

URLs for this method

Request headers

This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide.

URL Encoding for Parameters

Query parameter values need to be URL encoded. For details, see URL encoding query parameter values. For readability, code examples in this document have not been URL encoded.

Restrictions

This method can return a maximum of 10,000 items. For a list of supported sites and other restrictions, see API Restrictions.

eBay Partner Network: In order to receive a commission for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.

Authorizations:
Client_Credentials
query Parameters
aspect_filter
string

This field lets you filter by item aspects. The aspect name/value pairs and category, which is required, is used to limit the results to specific aspects of the item. For example, in a clothing category one aspect pair would be Color/Red.

For example, the method below uses the category ID for Women's Clothing. This will return only items for a woman's red shirt.

category_ids=15724&aspect_filter=categoryId:15724,Color:{Red}

Required: The category ID is required twice; once as a URI parameter and as part of the aspect_filter. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/gct:AspectFilter

category_ids
string

The category ID is used to limit the results. This field can have one category ID or a comma separated list of IDs.

Note: Currently, you can pass in only one category ID per request.

You can also use any combination of the category_Ids and epid fields. This gives you additional control over the result set.

The list of eBay category IDs is not published and category IDs are not the same across all the eBay marketplaces. You can use the following techniques to find a category by site:

  • Use the Category Changes page.
  • Use the Taxonomy API. For details see Get Categories for Buy APIs.
  • Submit the following method to get the dominantCategoryId for an item.
    /buy/browse/v1/item_summary/search?q= keyword&fieldgroups=ASPECT_REFINEMENTS
Required: The method must have category_ids or epid (or any combination of these)

charity_ids
string

The charity ID is used to limit the results to only items associated with the specified charity. This field can have one charity ID or a comma separated list of IDs. The method will return all the items associated with the specified charities.

For example:
/buy/browse/v1/item_summary/search?charity_ids=13-1788491,300108469

The charity ID is the charity's registration ID, also known as the Employer Identification Number (EIN). In GB, it is the Charity Registration Number (CRN), commonly called "Charity Number".

  • To find the charities eBay supports, you can search for a charity at Charity Search or go to Charity Shop.
  • To find the charity ID of a specific charity, click on a charity and use the EIN number. For example, the charity ID for American Red Cross, is 530196605.
You can also use any combination of the category_Ids and q fields with a charity_Ids to filter the result set. This gives you additional control over the result set.

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

Maximum: 20 IDs

Required: One ID

fieldgroups
string

This field is a comma separated list of values that lets you control what is returned in the response. The default is MATCHING_ITEMS, which returns the items that match the keyword or category specified. The other values return data that can be used to create histograms or provide additional information.

Valid Values:

  • ASPECT_REFINEMENTS - This returns the aspectDistributions container, which has the dominantCategoryId, matchCount, and refinementHref for the various aspects of the items found. For example, if you searched for 'Mustang', some of the aspect would be Model Year, Exterior Color, Vehicle Mileage, etc.

    Note: ASPECT_REFINEMENTS are category specific.
  • BUYING_OPTION_REFINEMENTS - This returns the buyingOptionDistributions container, which has the matchCount and refinementHref for AUCTION, FIXED_PRICE (Buy It Now), and CLASSIFIED_AD items.
  • CATEGORY_REFINEMENTS - This returns the categoryDistributions container, which has the categories that the item is in.
  • CONDITION_REFINEMENTS - This returns the conditionDistributions container, such as NEW, USED, etc. Within these groups are multiple states of the condition. For example, New can be New without tag, New in box, New without box, etc.
  • EXTENDED - This returns the shortDescription field, which provides condition and item aspect information and the itemLocation.city field.
  • MATCHING_ITEMS - This is meant to be used with one or more of the refinement values above. You use this to return the specified refinements and all the matching items.
  • FULL - This returns all the refinement containers and all the matching items.
Code so that your app gracefully handles any future changes to this list.

Default: MATCHING_ITEMS

filter
string

An array of field filters that can be used to limit/customize the result set.

For example:
/buy/browse/v1/item_summary/search?q=shirt&filter=price:[10..50]

You can also combine filters.
/buy/browse/v1/item_summary/search?q=shirt&filter=price:[10..50],sellers:{rpseller|bigSal}

Note: Refer to Buy API Field Filters for details and examples of all supported filters. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/cos:FilterField

limit
string

The number of items, from the result set, returned in a single page.

Default: 50

Maximum number of items per page (limit): 200

Maximum number of items in a result set: 10,000

offset
string

The number of items to skip in the result set. This is used with the limit field to control the pagination of the output.

If offset is 0 and limit is 10, the method will retrieve items 1-10 from the list of items returned, if offset is 10 and limit is 10, the method will retrieve items 11 thru 20 from the list of items returned.

Valid Values: 0-10,000 (inclusive)

Default: 0

Maximum number of items returned: 10,000

sort
string

The order and field name that is used to sort the items.

You can sort items by price, distance, or listing date. To sort in descending order, insert a hyphen (-) before the name of the sorting option. If no sort parameter is submitted, the result set is sorted by "Best Match".

Here are some examples showing how to use the sort query parameter:

  • sort=distance - This sorts by distance in ascending order (shortest distance first). This sorting option is only applicable if the pickup filters are used, and only ascending order is supported.
  • sort=-price - This sorts by price + shipping cost in descending order (highest price first). This sorting option (by price) is only guaranteed to work correctly if the X-EBAY-C-ENDUSERCTX request header is used, with the contextualLocation parameter being used to set the delivery country and postal code. Here is an example of how this header would be used to do this (note the URL encoding):

    X-EBAY-C-ENDUSERCTX: contextualLocation=country%3DUS%2Czip%3D19406
  • sort=newlyListed - This sorts by listing date (most recently listed/newest items first).
  • sort=endingSoonest - This sorts by date/time the listing ends (listings nearest to end date/time first).
Default: Ascending For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/cos:SortField

Request Body schema: application/json

The container for the image information fields.

image
string

The Base64 string of the image.

Responses

Request samples

Content type
application/json
{
  • "image": "string"
}

item

getItem

This method retrieves the details of a specific item, such as description, price, category, all item aspects, condition, return policies, seller feedback and score, shipping options, shipping costs, estimated delivery, and other information the buyer needs to make a purchasing decision.

The Buy APIs are designed to let you create an eBay shopping experience in your app or website. This means you will need to know when something, such as the availability, quantity, etc., has changed in any eBay item you are offering. You can do this easily by setting the fieldgroups URI parameter. This parameter lets you control what is returned in the response.

Setting fieldgroups to COMPACT reduces the response to only those fields that you need in order to check if any item detail has changed. Setting fieldgroups to PRODUCT, adds additional fields to the default response that return information about the product of the item. You can use either COMPACT or PRODUCT but not both. For more information, see fieldgroups.

URLs for this method

  • Production URL: https://api.ebay.com/buy/browse/v1/item/{item_id}
  • Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/item/{item_id}

Request headers

This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide.

Restrictions

For a list of supported sites and other restrictions, see API Restrictions.

eBay Partner Network: In order to be commissioned for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.
Authorizations:
Client_Credentials
path Parameters
item_id
required
string

The eBay RESTful identifier of an item. This ID is returned by the Browse and Feed API methods.

RESTful Item ID Format: v1|#|#
For example: v1|22|0 or v1|12|4**********2

For more information about item ID for RESTful APIs, see the Legacy API compatibility section of the Buy APIs Overview.

query Parameters
fieldgroups
string

This parameter lets you control what is returned in the response. If you do not set this field, the method returns all the details of the item.

Valid Values:

  • PRODUCT - This adds the additionalImages, additionalProductIdentities, aspectGroups, description, gtins, image, and title product fields to the response, which describe the product associated with the item. See Product for more information about these fields.
  • COMPACT - This returns only the following fields, which let you quickly check if the availability or price of the item has changed, if the item has been revised by the seller, or if an item's top-rated plus status has changed for items you have stored.
    • itemId - The identifier of the item.
    • bidCount - This integer value indicates the total number of bids that have been placed against an auction item.
    • currentBidPrice - This container shows the current highest bid for an auction item. This container will only be returned for auction items.
    • eligibleForInlineCheckout - This parameter returns items based on whether or not the items can be purchased using the Buy Order API.
      • If the value of this field is true, this indicates that the item can be purchased using the Order API.
      • If the value of this field is false, this indicates that the item cannot be purchased using the Order API and must be purchased on the eBay site.
    • estimatedAvailabilities - Returns the item availability information, which is based on the item's quantity. Note: Changes in quantity are not tracked by sellerItemRevision.
    • itemAffiliateWebURL - The URL of the View Item page of the item, which includes the affiliate tracking ID. This field is only returned if the eBay partner enables affiliate tracking for the item by including the X-EBAY-C-ENDUSERCTX request header in the method.
    • itemCreationDate - This is a timestamp that indicates the date and time an item listing was created.
    • itemEndDate - This is the scheduled end time of the listing.
    • ItemWebURL - The URL of the View Item page of the item. This enables you to include a "Report Item on eBay" link that takes the buyer to the View Item page on eBay. From there they can report any issues regarding this item to eBay.
    • legacyItemId - The unique identifier of the eBay listing that contains the item. This is the traditional/legacy ID that is often seen in the URL of the listing View Item page.
    • minimumPriceToBid - This container shows the minimum bid amount that would be accepted as a qualifying bid in an auction listing. This container will only be returned for auction items.
    • price - This is tracked by the revision ID but is returned here to enable you to quickly verify the price of the item.
    • priorityListing - This field is returned as true if the listing is part of a Promoted Listing campaign. Promoted Listings are available to Above Standard and Top Rated sellers with recent sales activity.
    • reservePriceMet - This field indicates whether or not an auction's reserve price (if set by the seller) has been met yet. This field will only be returned for auction items.
    • sellerItemRevision - An identifier generated/incremented when a seller revises the item. The following are the two types of item revisions:
      • Seller changes, such as changing the title
      • eBay system changes, such as changing the quantity when an item is purchased.
      This ID is changed only when the seller makes a change to the item. This means you cannot use this value to determine if the quantity has changed. To check if the quantity has changed, use estimatedAvailabilities.
    • shippingOptions - A container for the cost, carrier, and other details of shipping options.
    • taxes - A container for the tax information for the item, such as the tax jurisdiction, the tax percentage, and the tax type.
    • topRatedBuyingExperience - A boolean value indicating if this item is a top-rated plus item. A change in the item's top rated plus standing is not tracked by the revision ID. See topRatedBuyingExperience for more information.
    • uniqueBidderCount - This integer value indicates the number of different eBay users who have placed one or more bids on an auction item. This field is only applicable to auction items.
    For Example

    To check if a stored item's information is current, do following.
    1. Pass in the item ID and set fieldgroups to COMPACT.

      item/v1|4**********8|0?fieldgroups=COMPACT
    2. Do one of the following:
      • If the sellerItemRevision field is returned and you haven't stored a revision number for this item, record the number and pass in the item ID in the getItem method to get the latest information.
      • If the revision number is different from the value you have stored, update the value and pass in the item ID in the getItem method to get the latest information.
      • If the sellerItemRevision field is not returned or has not changed, where needed, update the item information with the information returned in the response.

Maximum value: 1
If more than one values is specified, the first value will be used.

Responses

getItemByLegacyId

This method is a bridge between the eBay legacy APIs, such as Shopping, and Finding and the eBay Buy APIs. There are differences between how legacy APIs and RESTful APIs return the identifier of an "item" and what the item ID represents. This method lets you use the legacy item ids retrieve the details of a specific item, such as description, price, and other information the buyer needs to make a purchasing decision. It also returns the RESTful item ID, which you can use with all the Buy API methods.

For more information about how to use legacy ids with the Buy APIs, see Legacy API compatibility in the Buying Integration guide.

This method returns the item details and requires you to pass in either the item ID of a non-variation item or the item ids of both the parent and child of an item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.

When an item group is created, one of the item variations, such as the red shirt size L, is chosen as the "parent". All the other items in the group are the children, such as the blue shirt size L, red shirt size M, etc.

The fieldgroups URI parameter lets you control what is returned in the response. Setting fieldgroups to PRODUCT, adds additional fields to the default response that return information about the product of the item. For more information, see fieldgroups.

URLs for this method

  • Production URL: https://api.ebay.com/buy/browse/v1/item/get_item_by_legacy_id?
  • Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/item/get_item_by_legacy_id?

Request headers

This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide.

Restrictions

For a list of supported sites and other restrictions, see API Restrictions.

eBay Partner Network: In order to be commissioned for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.
Authorizations:
Client_Credentials
query Parameters
fieldgroups
string

This field lets you control what is returned in the response. If you do not set this field, the method returns all the details of the item. Note: In this method, the only value supported is PRODUCT.

Valid Values:

PRODUCT - This adds the additionalImages, additionalProductIdentities, aspectGroups, description, gtins, image, and title fields to the response, which describe the item's product. See Product for more information about these fields.

Code so that your app gracefully handles any future changes to this list.

legacy_item_id
required
string

Specifies either:

  • The legacy item ID of an item that is not part of a group.
  • The legacy item ID of a group, which is the ID of the "parent" of the group of items.

    Note: If you pass in a group ID, you must also use the legacy_variation_id field and pass in the legacy ID of the specific item variation (child ID).
Legacy ids are returned by APIs, such as the Finding API.

The following is an example of using the value of the ItemID field for a specific item from Finding to get the RESTful itemId value.

    browse/v1/item/get_item_by_legacy_id?legacy_item_id=1**********9

Maximum: 1

legacy_variation_id
string

Specifies the legacy item ID of a specific item in an item group, such as the red shirt size L.

Legacy ids are returned by APIs, such as the Finding API.

Maximum: 1
Requirement: You must always pass in the legacy_item_id with the legacy_variation_id

legacy_variation_sku
string

Specifics the legacy SKU of the item. SKU are item ids created by the seller.

Legacy SKUs are returned by eBay the Shopping API.

The following is an example of using the value of the ItemID and SKU fields to get the RESTful itemId value.

    browse/v1/item/get_item_by_legacy_id?legacy_item_id=19&legacy_variation_sku=VM

Maximum: 1
Requirement: You must always pass in the legacy_item_id with the legacy_variation_sku

Responses

getItems

This method retrieves the details of specific items that the buyer needs to make a purchasing decision.

Note: This is a Limited Release(Limited Release) available only to select Partners.

For this method, only the following fields are returned: bidCount, currentBidPrice, eligibleForInlineCheckout, enabledForGuestCheckout, estimatedAvailabilities, itemAffiliateWebUrl, itemCreationDate, itemId, itemWebUrl, legacyItemId, minimumPriceToBid, price, priorityListing, reservePriceMet, sellerItemRevision, taxes, topRatedBuyingExperience, and uniqueBidderCount.

The array shippingOptions, which comprises multiple fields, is also returned.

URLs for this method

Request headers

This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide.

Restrictions

For a list of supported sites and other restrictions, see API Restrictions.

eBay Partner Network: In order to be commissioned for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.

Authorizations:
Client_Credentials
query Parameters
item_ids
string

A list of item IDs. Item IDs are the eBay RESTful identifier of items.

RESTful Item ID Format: v1|#|#
For example: v1|22|0 or v1|12|4**********2

In any given request, either item_ids or item_group_ids can be retrieved. Attempting to retrieve both will result in an error.

In a request, multiple item_ids can be passed as comma separated values.

Maximum allowed itemIDs: 20

For more information about item IDs for RESTful APIs, see the Legacy API compatibility section of the Buy APIs Overview.

item_group_ids
string

A list of item group IDs. Item group IDs are the eBay RESTful identifier of item groups.

RESTful Group Item ID Format: ############
For example: 3**********9

In any given request, either item_ids or item_group_ids can be retrieved. Attempting to retrieve both will result in an error.

In a request, multiple item_group_ids can be passed as comma separated values.

Maximum allowed itemGroupIDs: 10

Responses

getItemsByItemGroup

This method retrieves the details of the individual items in an item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.

You pass in the item group ID as a URI parameter. You use this method to show the item details of items with multiple aspects, such as color, size, storage capacity, etc.

This method returns two main containers; items and commonDescriptions. The items container has an array of containers with the details of each item in the group. The commonDescriptions container has an array of containers for a description and the item ids of all the items that have this exact description. Because items within an item group often have the same description, this decreases the size of the response.

URLs for this method

  • Production URL: https://api.ebay.com/buy/browse/v1/item/get_items_by_item_group?
  • Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/item/get_items_by_item_group?

Request headers

This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide.

Restrictions

For a list of supported sites and other restrictions, see API Restrictions.

eBay Partner Network: In order to be commissioned for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.
Authorizations:
Client_Credentials
query Parameters
item_group_id
required
string

Identifier of the item group to return. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.

This ID is returned in the itemGroupHref field of the search and getItem methods.

For Example: https://api.ebay.com/buy/browse/v1/item/get_items_by_item_group?item_group_id=3**********6

Responses

Response samples

Content type
application/json
{
  • "commonDescriptions": [
    ],
  • "items": [
    ],
  • "warnings": [
    ]
}

checkCompatibility

This method checks if a product is compatible with the specified item. You can use this method to check the compatibility of cars, trucks, and motorcycles with a specific part listed on eBay.

For example, to check the compatibility of a part, you pass in the item ID of the part as a URI parameter and specify all the attributes used to define a specific car in the compatibilityProperties container. If the call is successful, the response will be COMPATIBLE, NOT_COMPATIBLE, or UNDETERMINED. See compatibilityStatus for details.

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

To find the attributes and values for a specific marketplace, you can use the compatibility methods in the Taxonomy API. You can use this data to create menus to help buyers specify the product, such as their car.

For more details and a list of the required attributes for the US marketplace that describe motor vehicles, see Check compatibility in the Buy Integration Guide.

For an example, see the Samples section.

URLs for this method

Production URL: https://api.ebay.com/buy/browse/v1/item/{item_id}/check_compatibility

Note: This method is supported only on Production.

Restrictions

For a list of supported sites and other restrictions, see API Restrictions.

Authorizations:
Client_Credentials
path Parameters
item_id
required
string

The eBay RESTful identifier of an item (such as a part you want to check). This ID is returned by the Browse and Feed API methods.

RESTful Item ID Format: v1|#|#
For example: v1|22|0 or v1|12|4**********2

For more information about item ID for RESTful APIs, see the Legacy API compatibility section of the Buy APIs Overview.

header Parameters
X-EBAY-C-MARKETPLACE-ID
required
string

The ID of the eBay marketplace you want to use. Note: This value is case sensitive.

For example:
  X-EBAY-C-MARKETPLACE-ID = EBAY_US

For a list of supported sites see, API Restrictions.

Request Body schema: application/json
Array of objects (AttributeNameValue)

An array of attribute name/value pairs used to define a specific product. For example: If you wanted to specify a specific car, one of the name/value pairs would be
"name" : "Year",
"value" : "2019"

For a list of the attributes required for cars and trucks and motorcycles see Check compatibility in the Buy Integration Guide.

Responses

Request samples

Content type
application/json
{
  • "compatibilityProperties": [
    ]
}

shopping_cart

addItem

Note: Experimental Release This is an Experimental method that is available as a Limited Release(Limited Release) to select developers approved by business units.

This method creates an eBay cart for the eBay member, if one does not exist, and adds items to that cart. Because a cart never expires, any item added to the cart will remain in the cart until it is removed.

To use this method, you must submit a RESTful item ID and the quantity of the item. If the quantity value is greater than the number of available, the quantity value is changed to the number available and a warning is returned. For example, if there are 15 baseballs available and you set the quantity value to 50, the service automatically changes the value of quantity to 15.

The response returns all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. The quantity and state of an item changes often. If the item becomes "unavailable" such as, when the listing has ended or the item is out of stock, whether it has just been added to the cart or has been in the cart for some time, the item will be returned in the unavailableCartItems container.

Note: There are differences between how legacy APIs, such as Finding, and RESTful APIs, such as Browse, return the identifier of an "item" and what the item ID represents. If you have an item ID from one of the legacy APIs, you can use the legacy item ID with the getItemByLegacyId method to retrieve the RESTful ID for that item. For more information about how to use legacy IDs with the Buy APIs, see Legacy API compatibility in the Buying Integration guide.

URLs for this method

Restrictions

  • This method can be used only for eBay members.
  • You can only add FIXED_PRICE items.

For a list of supported sites and other restrictions, see API Restrictions.

Authorizations:
Authorization_Code
Request Body schema: application/json
itemId
string

The eBay RESTful identifier of the item you want added to the cart.

RESTful Item ID Format: v1|#|#
For example:
v1|22|0
v1|12|4**********2

For more information about item ID for RESTful APIs, see the Legacy API compatibility section of the Buy APIs Overview.

Maximum number of items in a cart: 100

quantity
integer

The number of this item the buyer wants to purchase. If this value is greater than the number available, the service will change this value to the number available. If this happens, a warning is returned.

Maximum: number available

Responses

Request samples

Content type
application/json
{
  • "itemId": "string",
  • "quantity": 0
}

getShoppingCart

Note: Experimental Release This is an experimental method that is available as a Limited Release(Limited Release) to select developers approved by business units.

This method retrieves all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. There are no URI parameters or request payload.

The response returns the summary details of all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. If the cart is empty, the response is HTTP 204.



The quantity and state of an item changes often. If the item becomes "unavailable" such as, when the listing has ended or the item is out of stock, the item will be returned in the unavailableCartItems container.

URLs for this method

Restrictions

This method can be used only for eBay members. For a list of supported sites and other restrictions, see API Restrictions.

Authorizations:
Authorization_Code

Responses

removeItem

Note: Experimental Release This is an experimental method that is available as a Limited Release(Limited Release) to select developers approved by business units.

This method removes a specific item from the eBay member's cart. You specify the ID of the item in the cart (cartItemId) that you want to remove.

The response returns all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. If you remove the last item in the cart, the response is HTTP 204.

The quantity and state of an item changes often. If the item becomes "unavailable" such as, when the listing has ended or the item is out of stock, the item will be returned in the unavailableCartItems container.

Note: The cartItemId is not the same as the item ID. The cartItemId is the identifier of a specific item in the cart and is generated when the item was added to the cart.

URLs for this method

Restrictions

This method can be used only for eBay members. For a list of supported sites and other restrictions, see API Restrictions.

Authorizations:
Authorization_Code
Request Body schema: application/json
cartItemId
string

The identifier of the item in the cart to be removed. This ID is generated when the item was added to the cart.

Responses

Request samples

Content type
application/json
{
  • "cartItemId": "string"
}

updateQuantity

Note: Experimental Release This is an experimental method that is available as a Limited Release(Limited Release) to select developers approved by business units.

This method updates the quantity value of a specific item in the eBay member's cart. You specify the ID of the item in the cart (cartItemId) and the new value for the quantity. If the quantity value is greater than the number of available, the quantity value is changed to the number available and a warning is returned. For example, if there are 15 baseballs available and you set the quantity value to 50, the service automatically changes the value of quantity to 15.

The response returns all the items in the eBay member's cart; items added to the cart while on ebay.com as well as items added to the cart using the Browse API. The quantity and state of an item changes often. If the item becomes "unavailable" such as, the listing has ended or the item is out of stock, the item will be returned in the unavailableCartItems container.

Note: The cartItemId is not the same as the item ID. The cartItemId is the identifier of a specific item in the cart and is generated when the item was added to the cart.

URLs for this method

Restrictions

This method can be used only for eBay members. For a list of supported sites and other restrictions, see API Restrictions.

Authorizations:
Authorization_Code
Request Body schema: application/json
cartItemId
string

The identifier of the item in the cart to be updated. This ID is generated when the item was added to the cart.

quantity
integer

The new quantity for the item that is being updated.

Responses

Request samples

Content type
application/json
{
  • "cartItemId": "string",
  • "quantity": 0
}