--- name: catalog-api description: "Catalog API skill. Use when working with Catalog for product, product_summary. Covers 2 endpoints." version: 1.0.0 generator: lapsh --- # Catalog API API version: v1_beta.5.3 ## Auth OAuth2 ## Base URL https://api.ebay.com/commerce/catalog/v1_beta ## Setup 1. Configure auth: OAuth2 2. GET /product_summary/search -- 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, and category aspects. to see the full details of a selected product, use the getproduct call. in addition to product summaries, this method can also be used to identify refinements, which help you to better pinpoint the product you're looking for. a refinement consists of one or more aspect values and a count of the number of times that each value has been used in previous ebay listings. an aspect is a property (e.g. color or size) of an ebay category, used by sellers to provide details about the items they're listing. the refinement container is returned when you include the fieldgroups query parameter in the request with a value of aspect_refinements or full. example a seller wants to find a product that is "gray" in color, but doesn't know what term the manufacturer uses for that color. it might be silver, brushed nickel, pewter, or even grey. the returned refinement container identifies all aspects that have been used in past listings for products that match your search criteria, along with all of the values those aspects have taken, and the number of times each value was used. you can use this data to present the seller with a histogram of the values of each aspect. the seller can see which color values have been used in the past, and how frequently they have been used, and selects the most likely value or values for their product. you issue the search method again with those values in the aspect_filter parameter to narrow down the collection of products returned by the call. 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 more than one of these parameters, they will be combined with a logical and to further refine the returned collection of matching products. note: this method requires that certain special characters in the query parameters be percent-encoded:     (space) = %20       , = %2c       : = %3a       [ = %5b       ] = %5d       { = %7b       | = %7c       } = %7d this requirement applies to all query parameter values. however, for readability, method examples and samples in this documentation will not use the encoding. this method returns product summaries rather than the full details of the products. to retrieve the full details of a product, use the getproduct method with an epid. 3. Explore available endpoints below ## Endpoints 2 endpoints across 2 groups. See references/api-spec.lap for full details. ### Product | Method | Path | Description | |--------|------|-------------| | GET | /product/{epid} | This method retrieves details of the catalog product identified by the eBay product identifier (ePID) specified in the request. These details include the product's title and description, aspects and their values, associated images, applicable category IDs, and any recognized identifiers that apply to the product. For a new listing, you can use the search method to identify candidate products on which to base the listing, then use the getProduct method to present the full details of those candidate products to the seller to make a a final selection. | ### Product_summary | Method | Path | Description | |--------|------|-------------| | GET | /product_summary/search | 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, and category aspects. To see the full details of a selected product, use the getProduct call. In addition to product summaries, this method can also be used to identify refinements, which help you to better pinpoint the product you're looking for. A refinement consists of one or more aspect values and a count of the number of times that each value has been used in previous eBay listings. An aspect is a property (e.g. color or size) of an eBay category, used by sellers to provide details about the items they're listing. The refinement container is returned when you include the fieldGroups query parameter in the request with a value of ASPECT_REFINEMENTS or FULL. Example A seller wants to find a product that is "gray" in color, but doesn't know what term the manufacturer uses for that color. It might be Silver, Brushed Nickel, Pewter, or even Grey. The returned refinement container identifies all aspects that have been used in past listings for products that match your search criteria, along with all of the values those aspects have taken, and the number of times each value was used. You can use this data to present the seller with a histogram of the values of each aspect. The seller can see which color values have been used in the past, and how frequently they have been used, and selects the most likely value or values for their product. You issue the search method again with those values in the aspect_filter parameter to narrow down the collection of products returned by the call. 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 more than one of these parameters, they will be combined with a logical AND to further refine the returned collection of matching products. Note: This method requires that certain special characters in the query parameters be percent-encoded:     (space) = %20       , = %2C       : = %3A       [ = %5B       ] = %5D       { = %7B       | = %7C       } = %7D This requirement applies to all query parameter values. However, for readability, method examples and samples in this documentation will not use the encoding. This method returns product summaries rather than the full details of the products. To retrieve the full details of a product, use the getProduct method with an ePID. | ## Common Questions Match user requests to endpoints in references/api-spec.lap. Key patterns: - "Get product details?" -> GET /product/{epid} - "Search search?" -> GET /product_summary/search - "How to authenticate?" -> See Auth section above ## Response Tips - Check response schemas in references/api-spec.lap for field details - Paginated endpoints accept limit/offset or cursor parameters - Error responses include status codes and descriptions in the spec ## References - Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas > Generated from the official API spec by [LAP](https://lap.sh)