{ "opencollection": "1.0.0", "info": { "name": "eBay Account Advertising_eligibility Product_summary API", "version": "v1.9.2" }, "items": [ { "info": { "name": "Product_summary", "type": "folder" }, "items": [ { "info": { "name": "search", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/product_summary/search", "headers": [ { "name": "X-EBAY-C-MARKETPLACE-ID", "value": "" } ], "params": [ { "name": "aspect_filter", "value": "", "type": "query", "description": "An eBay category and one or more aspects of that category, with the values that can be used to narrow down the collection of products returned by this call.

Aspects are product attributes that can represent different types of information for different products. Every product has aspects, but different products have different sets of aspects.

You can determine appropriate values for the aspects by first submitting this method without this parameter. It will return either the productSummaries.aspects container, the refinement.aspectDistributions container, or both, depending on the value of the fieldgroups parameter in the request. The productSummaries.aspects container provides the category aspects and their values that are associated with each returned product. The refinement.aspectDistributions container provides information about the distribution of values of the set of category aspects associated with the specified categories. In both cases sellers can select from among the returned aspects to use with this parameter.

Note: You can also use the Taxonomy API's getItemAspectsForCategory method to retrieve detailed information about aspects and their values that are appropriate for your selected category.

The syntax for the aspect_filter parameter is as follows (on several lines for readability; categoryId is required):

aspect_filter=categoryId:category_id,
aspect1:{valueA|valueB|...},
aspect2:{valueC|valueD|...},.

A matching product must be within the specified category, and it must have least one of the values identified for every specified aspect.

Note: Aspect names and values are case sensitive.

Here is an example of an aspect_filter parameter in which 9355 is the category ID, Color is an aspect of that category, and Black and White are possible values of that aspect (on several lines for readability):

GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search?
aspect_filter=categoryId:9355,Color:{White|Black}

Here is the aspect_filter with required URL encoding and a second aspect (on several lines for readability):

GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search?
aspect_filter=categoryId:9355,Color:%7BWhite%7CBlack%7D,
Storage%20Capacity:%128GB%7C256GB%7D

Note: You cannot use the aspect_filter parameter in the same method with either the gtin parameter or the mpn parameter. For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/commerce/catalog/types/catal:AspectFilter" }, { "name": "category_ids", "value": "", "type": "query", "description": " Important: Currently, only the first category_id value is accepted.

One or more comma-separated category identifiers for narrowing down the collection of products returned by this call.

Note: This parameter requires a valid category ID value. You can use the Taxonomy API's getCategorySuggestions method to retrieve appropriate category IDs for your product based on keywords.

The syntax for this parameter is as follows:

category_ids=category_id1,category_id2,.

Here is an example of a method with the category_ids parameter:

GET https://api.ebay.com/commerce/catalog/v1_beta/product_summary/search?
category_ids=178893

Note: Although all query parameters are optional, this method must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value.

If you provide only the category_ids parameter, you cannot specify a top-level (L1) category. " }, { "name": "fieldgroups", "value": "", "type": "query", "description": "The type of information to return in the response.

Important: This parameter may not produce valid results if you also provide more than one value for the category_ids parameter. It is recommended that you avoid using this combination.

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

Default: MATCHING_PRODUCTS" }, { "name": "gtin", "value": "", "type": "query", "description": "A string consisting of one or more comma-separated Global Trade Item Numbers (GTINs) that identify products to search for. Currently the GTIN values can include EAN, ISBN, and UPC identifier types.

Note: Although all query parameters are optional, this method must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value.

You cannot use the gtin parameter in the same method with either the q parameter or the aspect_filter parameter. " }, { "name": "limit", "value": "", "type": "query", "description": "The number of product summaries to return. This is the result set, a subset of the full collection of products that match the search or filter criteria of this call.

Maximum: 200
Default: 50" }, { "name": "mpn", "value": "", "type": "query", "description": "A string consisting of one or more comma-separated Manufacturer Part Numbers (MPNs) that identify products to search for. This method will return all products that have one of the specified MPNs.

MPNs are defined by manufacturers for their own products, and are therefore certain to be unique only within a given brand. However, many MPNs do turn out to be globally unique.

Note: Although all query parameters are optional, this method must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value.

You cannot use the mpn parameter in the same method with either the q parameter or the aspect_filter parameter. " }, { "name": "offset", "value": "", "type": "query", "description": "This parameter is reserved for internal or future use." }, { "name": "q", "value": "", "type": "query", "description": "A string consisting of one or more keywords to use to search for products in the eBay catalog.

Note: This method searches the following product record fields: title, description, brand, and aspects.localizedName, which do not include product IDs. Wildcard characters (e.g. *) are not allowed.

The keywords are handled as follows: Note: Although all query parameters are optional, this method must include at least the q parameter, or the category_ids, gtin, or mpn parameter with a valid value.

You cannot use the q parameter in the same method with either the gtin parameter or the mpn parameter. " } ], "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": "This method searches for and retrieves summaries of one or more products in the eBay catalog that match the search criteria provided by a seller. The seller can use the summaries to select the product in the eBay catalog that corresponds to the item that the seller wants to offer for sale. When a corresponding product is found and adopted by the seller, eBay will use the product information to populate the item listing. The criteria supported by search include keywords, product categories" } ] } ], "bundled": true }