openapi-directory/api/ebay.com/buy-browse.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"contact":{"name":"eBay Inc,","x-twitter":"ebay"},"description":"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.  (Experimental) search_by_image: 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.  (Experimental) shopping_cart: 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.","license":{"name":"eBay API License Agreement","url":"https://go.developer.ebay.com/api-license-agreement"},"title":"Browse API","version":"v1.1.0","x-apisguru-categories":["ecommerce"],"x-logo":{"backgroundColor":"#FFFFFF","url":"https://twitter.com/ebay/profile_image?size=original"},"x-origin":[{"format":"swagger","url":"https://developer.ebay.com/api-docs/master/buy/browse/openapi/2/buy_browse_v1_beta_oas2.json","version":"2.0"}],"x-providerName":"ebay.com","x-serviceName":"buy-browse"},"paths":{"/item/":{"get":{"description":"This method retrieves the details of specific items that the buyer needs to make a purchasing decision. Note: This is a (Limited Release) available only to select Partners. For this method, only the following fields are returned: eligibleForInlineCheckout, estimatedAvailabilities, itemAffiliateWebURL, itemID, ItemWebURL, legacyItemID, price, sellerItemRevision, and topRatedBuyingExperience. URLs for this method Production URL: https://api.ebay.com/buy/browse/v1/item/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/item/ 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.","operationId":"getItems","parameters":[{"description":"A list of item IDs. Item IDs are the eBay RESTful identifier of items. RESTful Item ID Format: v1|#|# For example: v1|272394640372|0 or v1|162846450672|461882996982 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.","in":"query","name":"item_ids","required":false,"schema":{"type":"string"}},{"description":"A list of item group IDs. Item group IDs are the eBay RESTful identifier of item groups. RESTful Group Item ID Format: ############ For example: 330017835749 or 330017835740 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","in":"query","name":"item_group_ids","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","x-response-codes":{"errors":{"11001":{"category":"REQUEST","description":"The specified item ID was not found.","domain":"API_BROWSE"},"11002":{"category":"REQUEST","description":"The specified item group was not found.","domain":"API_BROWSE"},"11004":{"category":"REQUEST","description":"The item group is not available. This can be for many reasons, such as when the listing is being updated by the seller. Wait a few minutes and try the call again.","domain":"API_BROWSE"},"11005":{"category":"REQUEST","description":"The item group ID is invalid. Use {itemHref} to get the item details.","domain":"API_BROWSE"},"11008":{"category":"REQUEST","description":"The item group is not available. This can be for many reasons, such as when the listing is being updated by the seller. Wait a few minutes and try the call again.","domain":"API_BROWSE"},"11502":{"category":"APPLICATION","description":"There was a problem extracting product information for this item. Please try again.","domain":"API_BROWSE"},"11508":{"category":"APPLICATION","description":"This seller is currently away. If you make a purchase, please allow additional time for your order to be processed.","domain":"API_BROWSE"},"11509":{"category":"APPLICATION","description":"This seller is currently away until {sellerReturnDate}. If you make a purchase, please allow additional time for your order to be processed.","domain":"API_BROWSE"}}},"content":{"*/*":{"schema":{"$ref":"#/components/schemas/Items"}}}},"400":{"description":"Bad Request","x-response-codes":{"errors":{"11011":{"category":"REQUEST","description":"The marketplace value is not supported. The supported values are: {allowedMarketplaces}","domain":"API_BROWSE"},"11012":{"category":"REQUEST","description":"The specified item IDs are invalid, or the format of the specified values are invalid.","domain":"API_BROWSE"},"11013":{"category":"REQUEST","description":"The specified group IDs are invalid, or the format of the specified values are invalid.","domain":"API_BROWSE"},"11014":{"category":"REQUEST","description":"An item_ids and an item_group_ids list cannot be used at same time. Please use only one of these lists.","domain":"API_BROWSE"},"11015":{"category":"REQUEST","description":"The maximum number of item IDs has been exceeded. Please reduce the number of item IDs to {maxAllowedItemIds} or less.","domain":"API_BROWSE"},"11016":{"category":"REQUEST","description":"The maximum number of item group IDs has been exceeded. Please reduce the number of item group ids to {maxAllowedItemGroupIds} or less.","domain":"API_BROWSE"},"11017":{"category":"REQUEST","description":"An item_ids or an item_group_ids list is required. Please use one of these lists.","domain":"API_BROWSE"}}}},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"11000":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.","domain":"API_BROWSE"}}}}},"security":[{"Client_Credentials":["https://api.ebay.com/oauth/api_scope/buy.item.bulk"]}],"tags":["item"]}},"/item/get_item_by_legacy_id":{"get":{"description":"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.","operationId":"getItemByLegacyId","parameters":[{"description":"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.","in":"query","name":"fieldgroups","required":false,"schema":{"type":"string"}},{"description":"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=110039490209 Maximum: 1","in":"query","name":"legacy_item_id","required":true,"schema":{"type":"string"}},{"description":"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","in":"query","name":"legacy_variation_id","required":false,"schema":{"type":"string"}},{"description":"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=110039490209&legacy_variation_sku=V-00031-WHM Maximum: 1 Requirement: You must always pass in the legacy_item_id with the legacy_variation_sku","in":"query","name":"legacy_variation_sku","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","x-response-codes":{"errors":{"11502":{"category":"APPLICATION","description":"There was a problem extracting product information for this Item. Please try again.","domain":"API_BROWSE"},"11508":{"category":"APPLICATION","description":"This seller is currently away. If you make a purchase, please allow additional time for your order to be processed.","domain":"API_BROWSE"},"11509":{"category":"APPLICATION","description":"This seller is currently away until {sellerReturnDate}. If you make a purchase, please allow additional time for your order to be processed.","domain":"API_BROWSE"}}},"content":{"*/*":{"schema":{"$ref":"#/components/schemas/Item"}}}},"400":{"description":"Bad Request","x-response-codes":{"errors":{"11003":{"category":"REQUEST","description":"The specified legacy item ID was not found.","domain":"API_BROWSE"},"11004":{"category":"REQUEST","description":"The item is not available for purchase. This can be for many reasons, such as when the listing is being updated by the seller. Wait a few minutes and try the call again.","domain":"API_BROWSE"},"11006":{"category":"REQUEST","description":"The legacy ID is invalid. Use {itemGroupHref} to get the item group details.","domain":"API_BROWSE"},"11009":{"category":"REQUEST","description":"The legacy variation sku is invalid.","domain":"API_BROWSE"},"11010":{"category":"REQUEST","description":"You cannot submit legacy_variation_sku and legacy_variation_id in the same request. For help, see the documentation.","domain":"API_BROWSE"},"11011":{"category":"REQUEST","description":"The marketplace value {marketplaceId} is not supported. The supported values are: {allowedMarketplaces}","domain":"API_BROWSE"}}}},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"11000":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.","domain":"API_BROWSE"}}}}},"security":[{"Client_Credentials":["https://api.ebay.com/oauth/api_scope"]}],"tags":["item"]}},"/item/get_items_by_item_group":{"get":{"description":"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.","operationId":"getItemsByItemGroup","parameters":[{"description":"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=351825690866","in":"query","name":"item_group_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","x-response-codes":{"errors":{"11508":{"category":"APPLICATION","description":"This seller is currently away. If you make a purchase, please allow additional time for your order to be processed.","domain":"API_BROWSE"},"11509":{"category":"APPLICATION","description":"This seller is currently away until {sellerReturnDate}. If you make a purchase, please allow additional time for your order to be processed.","domain":"API_BROWSE"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemGroup"}}}},"400":{"description":"Bad Request","x-response-codes":{"errors":{"11002":{"category":"REQUEST","description":"The specified item group was not found.","domain":"API_BROWSE"},"11005":{"category":"REQUEST","description":"Item Group Id is invalid. Use {itemHref} to get the item details.","domain":"API_BROWSE"},"11008":{"category":"REQUEST","description":"The item group is not available. This can be for many reasons, such as when the listing is being updated by the seller. Wait a few minutes and try the call again.","domain":"API_BROWSE"},"11011":{"category":"REQUEST","description":"The marketplace value {marketplaceId} is not supported. The supported values are: {allowedMarketplaces}","domain":"API_BROWSE"}}}},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"11000":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.","domain":"API_BROWSE"}}}}},"tags":["item"]}},"/item/{item_id}":{"get":{"description":"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 the five 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/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/item/ 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.","operationId":"getItem","parameters":[{"description":"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. 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. 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. sellerItemRevision - An identifier generated/incremented when a seller revises the item. The follow 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. 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. price - This is tracked by the revision ID but is returned here to enable you to quickly verify the price of the item. estimatedAvailabilities - Returns the item availability information, which is based on the item's quantity. Note: Changes in quantity are not tracked by sellerItemRevision. itemEndDate - This is the scheduled end time of the listing. 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. For Example To check if a stored item's information is current, do following. Pass in the item ID and set fieldgroups to COMPACT. item/v1|46566502948|0?fieldgroups=COMPACT 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.","in":"query","name":"fieldgroups","required":false,"schema":{"type":"string"}},{"description":"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|272394640372|0 or v1|162846450672|461882996982 For more information about item ID for RESTful APIs, see the Legacy API compatibility section of the Buy APIs Overview.","in":"path","name":"item_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","x-response-codes":{"errors":{"11001":{"category":"REQUEST","description":"The specified item ID was not found.","domain":"API_BROWSE"},"11002":{"category":"REQUEST","description":"The specified item group was not found.","domain":"API_BROWSE"},"11004":{"category":"REQUEST","description":"The item is not available for purchase. This can be for many reasons, such as when the listing is being updated by the seller. Wait a few minutes and try the call again.","domain":"API_BROWSE"},"11005":{"category":"REQUEST","description":"The item group ID is invalid. Use {itemHref} to get the item details.","domain":"API_BROWSE"},"11008":{"category":"REQUEST","description":"The item group is not available. This can be for many reasons, such as when the listing is being updated by the seller. Wait a few minutes and try the call again.","domain":"API_BROWSE"},"11502":{"category":"APPLICATION","description":"There was a problem extracting product information for this Item. Please try again.","domain":"API_BROWSE"},"11508":{"category":"APPLICATION","description":"This seller is currently away. If you make a purchase, please allow additional time for your order to be processed.","domain":"API_BROWSE"},"11509":{"category":"APPLICATION","description":"This seller is currently away until {sellerReturnDate}. If you make a purchase, please allow additional time for your order to be processed.","domain":"API_BROWSE"}}},"content":{"*/*":{"schema":{"$ref":"#/components/schemas/Item"}}}},"400":{"description":"Bad Request","x-response-codes":{"errors":{"11011":{"category":"REQUEST","description":"The marketplace value {marketplaceId} is not supported. The supported values are: {allowedMarketplaces}","domain":"API_BROWSE"},"11012":{"category":"REQUEST","description":"The specified item IDs are invalid, or the format of the specified values are invalid.","domain":"API_BROWSE"},"11013":{"category":"REQUEST","description":"The specified group IDs are invalid, or the format of the specified values are invalid.","domain":"API_BROWSE"},"11014":{"category":"REQUEST","description":"An item_ids and an item_group_ids list cannot be used at same time. Please use only one of these lists.","domain":"API_BROWSE"},"11015":{"category":"REQUEST","description":"The maximum number of item ids has been exceeded. Please reduce the number of item ids to {maxAllowedItemIds} or less.","domain":"API_BROWSE"},"11016":{"category":"REQUEST","description":"The maximum number of item group IDs has been exceeded. Please reduce the number of item group ids to {maxAllowedItemGroupIds} or less.","domain":"API_BROWSE"},"11501":{"category":"REQUEST","description":"The 'fieldgroups' value {fieldgroups} is invalid. The supported fieldgroups are: {supportedFieldgroups}","domain":"API_BROWSE"}}}},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"11000":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.","domain":"API_BROWSE"}}}}},"security":[{"Client_Credentials":["https://api.ebay.com/oauth/api_scope"]}],"tags":["item"]}},"/item/{item_id}/check_compatibility":{"post":{"description":"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/ Note: This method is supported only on Production. Restrictions For a list of supported sites and other restrictions, see API Restrictions.","operationId":"checkCompatibility","parameters":[{"description":"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|272394640372|0 or v1|162846450672|461882996982 For more information about item ID for RESTful APIs, see the Legacy API compatibility section of the Buy APIs Overview.","in":"path","name":"item_id","required":true,"schema":{"type":"string"}},{"description":"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.","in":"header","name":"X-EBAY-C-MARKETPLACE-ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompatibilityPayload"}}}},"responses":{"200":{"description":"OK","x-response-codes":{"errors":{"11504":{"category":"REQUEST","description":"The following compatibilityProperties (attributes name/value pairs) are missing: {attributes}","domain":"API_BROWSE"}}},"content":{"*/*":{"schema":{"$ref":"#/components/schemas/CompatibilityResponse"}}}},"400":{"description":"Bad Request","x-response-codes":{"errors":{"11001":{"category":"REQUEST","description":"The specified item ID was not found.","domain":"API_BROWSE"},"11011":{"category":"REQUEST","description":"The marketplace value {marketplaceId} is not supported. The supported values are: {allowedMarketplaces}","domain":"API_BROWSE"},"11503":{"category":"REQUEST","description":"The request is either empty or incomplete. For help, see the documentation for this call.","domain":"API_BROWSE"},"11505":{"category":"REQUEST","description":"The item is not valid for compatibility validation.","domain":"API_BROWSE"},"11506":{"category":"REQUEST","description":"The 'name' {compatibilityNames} appears more than once in the request.","domain":"API_BROWSE"},"11507":{"category":"REQUEST","description":"The following name(s) in the request are not supported {attributes}.","domain":"API_BROWSE"}}}},"404":{"description":"Not Found"},"409":{"description":"Conflict"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"11000":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.","domain":"API_BROWSE"}}}}},"security":[{"Client_Credentials":["https://api.ebay.com/oauth/api_scope"]}],"tags":["item"]}},"/item_summary/search":{"get":{"description":"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 FIXED_PRICE (Buy It Now) items are returned by default. However, this method does return items where both FIXED_PRICE and AUCTION are available as a buying option. After a bid has been placed, items become active auction items and are no longer returned by default, but they remain accessible by filtering for the AUCTION buying option. 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/ Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/item_summary/ 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.","operationId":"search","parameters":[{"description":"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 aspects 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 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","in":"query","name":"aspect_filter","required":false,"schema":{"type":"string"}},{"description":"A query parameter that enables auto correction. Valid Values: KEYWORD","in":"query","name":"auto_correct","required":false,"schema":{"type":"string"}},{"description":"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)","in":"query","name":"category_ids","required":false,"schema":{"type":"string"}},{"description":"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","in":"query","name":"charity_ids","required":false,"schema":{"type":"string"}},{"description":"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. 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 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 the best compatibility results, submit all the attributes used to define the product. Best Practice: Submit all the product attributes for the specific product. For more details, see Check compatibility in the Buy Integration Guide. Note: The only products supported are cars, trucks, and motorcycles. For an example, see the Samples section. 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) a 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","in":"query","name":"compatibility_filter","required":false,"schema":{"type":"string"}},{"description":"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)","in":"query","name":"epid","required":false,"schema":{"type":"string"}},{"description":"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 and FIXED_PRICE (Buy It Now) items. Note: Classified items are not supported and only "Buy It Now" (non-auction) items are returned. 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","in":"query","name":"fieldgroups","required":false,"schema":{"type":"string"}},{"description":"This field supports multiple 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} The following are the supported filters. For details and examples for all the filters, see Buy API Field Filters. buyingOptions charityOnly conditionIds conditions deliveryCountry deliveryOptions deliveryPostalCode excludeCategoryIds excludeSellers guaranteedDeliveryInDays itemEndDate itemLocationCountry itemStartDate paymentMethods pickupCountry pickupPostalCode pickupRadius pickupRadiusUnit price priceCurrency qualifiedPrograms maxDeliveryCost (free shipping) returnsAccepted sellerAccountTypes sellers For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/cos:FilterField","in":"query","name":"filter","required":false,"schema":{"type":"string"}},{"description":"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)","in":"query","name":"gtin","required":false,"schema":{"type":"string"}},{"description":"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","in":"query","name":"limit","required":false,"schema":{"type":"string"}},{"description":"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. 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","in":"query","name":"offset","required":false,"schema":{"type":"string"}},{"description":"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 comma, 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 separated by a space, 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=iphone, ipad 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)","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"Specifies the order and the field name to use to sort the items. You can sort items by price (in ascending or descending order) or by distance (only applicable if the "pickup" filters are used, and only ascending order is supported). You can also sort items by listing date, with the most recently listed (newest) items appearing first. Note: To sort in descending order, insert a hyphen (-) before the field name. If no sort parameter is submitted, the result set is sorted by "Best Match". The following are examples of using the sort query parameter. Sort Result sort=price Sorts by price in ascending order (lowest price first) sort=-price Sorts by price in descending order (highest price first) sort=distance Sorts by distance in ascending order (shortest distance first) sort=newlyListed Sorts by listing date (most recently listed/newest items first) Default: Ascending For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/browse/types/cos:SortField","in":"query","name":"sort","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","x-response-codes":{"errors":{"12002":{"category":"REQUEST","description":"The {filterName} value is invalid. For the valid values, refer to the API call documentation.","domain":"API_BROWSE"},"12003":{"category":"REQUEST","description":"A seller 'username' provided in the request filters is invalid.","domain":"API_BROWSE"},"12008":{"category":"REQUEST","description":"The 'sort' value is invalid. For the valid values, refer to the API call documentation.","domain":"API_BROWSE"},"12009":{"category":"REQUEST","description":"The 'category_ids' query parameter is invalid.","domain":"API_BROWSE"},"12010":{"category":"REQUEST","description":"There are four filters required for local pickup. 'pickupPostalCode','pickupCountry','pickupRadiusUnit','pickupRadius'. One or more is missing or invalid.","domain":"API_BROWSE"},"12011":{"category":"REQUEST","description":"'deliveryCountry' is a mandatory filter to provide a delivery location. 'deliveryPostalCode' is optional.","domain":"API_BROWSE"},"12012":{"category":"REQUEST","description":"A valid 'price' filter and a valid 'priceCurrency' filter is necessary to filter based on price.","domain":"API_BROWSE"},"12014":{"category":"BUSINESS","description":"The 'sellerAccountTypes' filter is not supported for the marketplace {marketplaceId}. Valid marketplaces are: {validMarketplaces}","domain":"API_BROWSE"},"12015":{"category":"REQUEST","description":"The postal code filter value is invalid for the specified country and this filter was ignored.","domain":"API_BROWSE"},"12016":{"category":"REQUEST","description":"The 'fieldgroups' value {fieldgroups} is invalid. For the valid values, refer to the API call reference documentation","domain":"API_BROWSE"},"12017":{"category":"REQUEST","description":"The 'aspect_filter' query parameter must include a categoryId. For information, see the API call reference documentation.","domain":"API_BROWSE"},"12018":{"category":"REQUEST","description":"The {aspectFilter} aspect_filter value is invalid. For information, see the API call reference documentation.","domain":"API_BROWSE"},"12021":{"category":"REQUEST","description":"The 'epid' value {epid} is invalid. For information, see the API call reference documentation.","domain":"API_BROWSE"},"12022":{"category":"REQUEST","description":"The 'gtin' value {gtin} is invalid. For information, see the API call reference documentation.","domain":"API_BROWSE"},"12024":{"category":"REQUEST","description":"The 'charity_ids' value {charity_id} is invalid. For more information see the API call reference documentation.","domain":"API_BROWSE"},"12502":{"category":"REQUEST","description":"The {compatibilityFilter} compatibility_filter is invalid. For information, see the API call reference documentation.","domain":"API_BROWSE"},"12511":{"category":"REQUEST","description":"Either 'deliveryCountry' or 'deliveryPostalCode' is invalid, hence 'guaranteedDeliveryInDays' filter was ignored.","domain":"API_BROWSE"}}},"content":{"*/*":{"schema":{"$ref":"#/components/schemas/SearchPagedCollection"}}}},"400":{"description":"Bad Request","x-response-codes":{"errors":{"12001":{"category":"REQUEST","description":"The call must have a valid 'q', 'category_ids', 'epid' or 'gtin' query parameter.","domain":"API_BROWSE"},"12004":{"category":"REQUEST","description":"The 'offset' value cannot be negative.","domain":"API_BROWSE"},"12005":{"category":"REQUEST","description":"The 'offset' value must be an integer.","domain":"API_BROWSE"},"12006":{"category":"REQUEST","description":"The 'limit' value should be between 1 and 200 (inclusive).","domain":"API_BROWSE"},"12007":{"category":"REQUEST","description":"The 'limit' value must be an integer value.","domain":"API_BROWSE"},"12023":{"category":"REQUEST","description":"This keyword search results in a response that is too large to return. Either change the keyword or add additional query parameters and/or filters.","domain":"API_BROWSE"},"12025":{"category":"REQUEST","description":"The 'charity_ids' field has exceeded the maximum limit of 20.","domain":"API_BROWSE"},"12026":{"category":"REQUEST","description":"The 'charity_ids' field is not supported for the marketplace {marketplaceId}. Valid marketplaces are: {validMarketplaces}.","domain":"API_BROWSE"},"12027":{"category":"REQUEST","description":"The 'auto_correct' value is invalid. For the valid values, refer to the API call documentation.","domain":"API_BROWSE"},"12028":{"category":"REQUEST","description":"The 'auto_correct' is not supported for the marketplace {marketplaceId}. Valid marketplaces are: {validMarketplaces}","domain":"API_BROWSE"},"12029":{"category":"REQUEST","description":"The number of sellers in the filter has exceeded the limit. Please reduce the number of sellers to 250 or fewer.","domain":"API_BROWSE"},"12030":{"category":"REQUEST","description":"The number of categories in the request has exceeded the limit. Please reduce the number of categories to {allowedMaxCategories} or less.","domain":"API_BROWSE"},"12503":{"category":"REQUEST","description