{ "opencollection": "1.0.0", "info": { "name": "eBay Account Advertising_eligibility Item_sales API", "version": "v1.9.2" }, "items": [ { "info": { "name": "Item_sales", "type": "folder" }, "items": [ { "info": { "name": "search", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/item_sales/search", "headers": [ { "name": "X-EBAY-C-ENDUSERCTX", "value": "" }, { "name": "X-EBAY-C-MARKETPLACE-ID", "value": "" } ], "params": [ { "name": "aspect_filter", "value": "", "type": "query", "description": "This query parameter 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. The results are returned in the refinement container.

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

/buy/marketplace_insights/v1_beta/item_sales/search?q=shirt&category_ids=15724&aspect_filter=categoryId:15724,Color:{Red|Blue}

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

/buy/marketplace_insights/v1_beta/item_sales/search?q=shirt&category_ids=15724&fieldgroups=ASPECT_REFINEMENTS

Format: aspectName:{value1|value2}

Required: The category ID is required twice; once as a URI parameter and as part of the aspect_filter parameter. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/marketplace_insights/types/gct:AspectFilter" }, { "name": "category_ids", "value": "", "type": "query", "description": "This query parameter specifies the category ID used to limit the result set. For example, if you search for 'shirt' the result set will be very large. But if you also include the category ID 137084, the results will be limited to 'Men's Athletic Apparel'. For example:

/buy/marketplace-insights/v1_beta/item_sales/search?q=shirt&category_ids=137084

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:

Usage: Restrictions: Maximum number of categories: 4" }, { "name": "epid", "value": "", "type": "query", "description": "The ePID is the eBay product identifier of a product from the eBay product catalog. This query parameter limits the results to only items in the specified ePID.

/buy/marketplace-insights/v1_beta/item_sales/search?epid=241986085&category_ids=168058

You can use the product_summary/search method in the Catalog API to search for the ePID of the product.

Required: At least 1 category_ids

Maximum: 1 epid

Optional: Any combination of epid, gtin, or q" }, { "name": "fieldgroups", "value": "", "type": "query", "description": "This query parameter lets you control what is to be returned in the response and accepts a comma separated list of values.

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. For code examples see, aspect_filter.

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

Default: MATCHING_ITEMS " }, { "name": "filter", "value": "", "type": "query", "description": "This query parameter supports multiple field filters that can be used to limit/customize the result set.

The following lists the supported filters. For details and examples for all the filters, see Buy API Field Filters.


The following example filters the result set by price.

Note: To filter by price, price and priceCurrency must always be used together.
/buy/marketplace-insights/v1_beta/item_sales/search?q=iphone&category_ids=15724&filter=price:[50..500],priceCurrency:USD For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/marketplace_insights/types/cos:FilterField" }, { "name": "gtin", "value": "", "type": "query", "description": "This query parameter lets you search by the Global Trade Item Number of the item as defined by https://www.gtin.info. This can be a UPC (Universal Product Code), EAN (European Article Number), or an ISBN (International Standard Book Number) value.

/buy/marketplace-insights/v1_beta/item_sales/search?gtin=241986085&category_ids=9355

Required: At least 1 category_ids

Maximum: 1 gtin

Optional: Any combination of epid, gtin, or q" }, { "name": "limit", "value": "", "type": "query", "description": "This query parameter specifies 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.
Note: This method can return a maximum of 10,000 items in one results set.
Min: 1

Max: 200

Default: 50" }, { "name": "offset", "value": "", "type": "query", "description": "This query parameter 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 error is returned for invalid values of offset.
Note: This method can return a maximum of 10,000 items in one results set.
Min: 0

Max: 9,999

Default: 0" }, { "name": "q", "value": "", "type": "query", "description": "A string consisting of one or more keywords that are used to search for items on eBay. The keywords are handled as follows:
Restriction: The * wildcard character is not allowed in this field.

Required: At least 1 category_ids

Optional: Any combination of epid, gtin, or q " }, { "name": "sort", "value": "", "type": "query", "description": "This query parameter specifies the order and the field name to use to sort the items. To sort in descending order use - before the field name. Currently, you can only sort by price (in ascending or descending order).

If no sort parameter is submitted, the result set is sorted by "Best Match".

The following are examples of using the sort query parameter.

SortResult
&sort=price Sorts by price in ascending order (lowest price first)
&sort=-price Sorts by price in descending order (highest price first)

Default: ascending For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/buy/marketplace_insights/types/cos:SortField" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Note: This is a \"Limited(Limited Release) API available only to select developers approved by business units. For information on how to obtain access to this API in production, see the Buy APIs Requirements