Download OpenAPI specification:Download
The Catalog API allows users to search for and locate an eBay catalog product that is a direct match for the product that they wish to sell. Listing against an eBay catalog product helps insure that all listings (based off of that catalog product) have complete and accurate information. In addition to helping to create high-quality listings, another benefit to the seller of using catalog information to create listings is that much of the details of the listing will be prefilled, including the listing title, the listing description, the item specifics, and a stock image for the product (if available). Sellers will not have to enter item specifics themselves, and the overall listing process is a lot faster and easier.
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.
| epid required | string The ePID of the product being requested. This value can be discovered by issuing the search method and examining the value of the productSummaries.epid field for the desired returned product summary. |
| X-EBAY-C-MARKETPLACE-ID | string This method also uses the |
{- "additionalImages": [
- {
- "height": 0,
- "imageUrl": "string",
- "width": 0
}
], - "aspects": [
- {
- "localizedName": "string",
- "localizedValues": [
- "string"
]
}
], - "brand": "string",
- "description": "string",
- "ean": [
- "string"
], - "epid": "string",
- "gtin": [
- "string"
], - "image": {
- "height": 0,
- "imageUrl": "string",
- "width": 0
}, - "isbn": [
- "string"
], - "mpn": [
- "string"
], - "otherApplicableCategoryIds": [
- "string"
], - "primaryCategoryId": "string",
- "productWebUrl": "string",
- "title": "string",
- "upc": [
- "string"
], - "version": "string"
}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.
| aspect_filter | string 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. |
| category_ids | string Important: Currently, only the first category_id value is accepted. |
| fieldgroups | string The type of information to return in the response.
Default: MATCHING_PRODUCTS
|
| gtin | string 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. |
| limit | string 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. |
| mpn | string 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. |
| offset | string This parameter is reserved for internal or future use. |
| q | string A string consisting of one or more keywords to use to search for products in the eBay catalog.
You cannot use the q parameter in the same method with either the gtin parameter or the mpn parameter. |
| X-EBAY-C-MARKETPLACE-ID | string This method also uses the |
{- "href": "string",
- "limit": 0,
- "next": "string",
- "offset": 0,
- "prev": "string",
- "productSummaries": [
- {
- "additionalImages": [
- {
- "height": 0,
- "imageUrl": "string",
- "width": 0
}
], - "aspects": [
- {
- "localizedName": "string",
- "localizedValues": [
- "string"
]
}
], - "brand": "string",
- "ean": [
- "string"
], - "epid": "string",
- "gtin": [
- "string"
], - "image": {
- "height": 0,
- "imageUrl": "string",
- "width": 0
}, - "isbn": [
- "string"
], - "mpn": [
- "string"
], - "productHref": "string",
- "productWebUrl": "string",
- "title": "string",
- "upc": [
- "string"
]
}
], - "refinement": {
- "aspectDistributions": [
- {
- "aspectValueDistributions": [
- {
- "localizedAspectValue": "string",
- "matchCount": 0,
- "refinementHref": "string"
}
], - "localizedAspectName": "string"
}
], - "dominantCategoryId": "string"
}, - "total": 0
}