API Support for Parts Compatibility
Parts compatibility is supported by the following APIs:
- Trading API
- Product Services: Product API and Product Metadata API
- Search API: Finding API
Parts compatibility is supported in select Parts & Accessories categories for eBay Motors (site ID 100) only. The Trading API provides the calls you need to identify the categories that support parts compatibility, list (or revise) items with parts compatibility, and retrieve item compatibility information for items listed with parts compatibility.
Use GetCategoryFeatures to determine which categories on the eBay Motors US site support parts compatibility. See Parts Compatibility Supported Categories for more information.
Listing items with parts compatibility is supported by the following:
Use GetItem to retrieve parts compatibility information for an active item listing.
See Listing Compatible Parts for more information.
eBay Product Services consists of two separate APIs, the Product API and Product Metadata API. Product Services provides the information sellers need to list items with parts compatibility by application. Items can be listed with parts compatibility by application either using a product that has compatibilities or by manually specifying the compatibilities.
See Listing Compatible Parts for more information on how the Product API and the Product Metadata API support listing items with parts compatibility.
The Product API consists of calls that return product information. For example, you can use the Product API to identify products that have associated compatibilities. Listing an item with a product that has compatibilities (e.g., specific vehicle applications, such as a 2004 Honda Accord) is one way to list an item with parts compatibility information.
Product API Reference
Product Metadata API
The Product Metadata API consists of calls that return product metadata for specific categories. For example, you can use the Product Metadata API to retrieve the compatibility search names (e.g., Make and Model) and values (e.g., Honda and Accord) that are allowed for a given category. You can use this compatibility metadata to construct compatible applications (Item.ItemCompatibilityList) for a specific category. Listing an item with compatible applications (e.g., a fender that fits specific cars) is one way to list an item with parts compatibility information. This is known as listing with compatibility by application.
Product Metadata API Reference
The Finding API supports parts compatibility. When buyers search for parts with keywords queries that include compatibility information (e.g., vehicle year, make, or model) or part specifications (e.g., tire section width, aspect ratio, or rim diameter), the queries are run against the parts compatibility information. When there are matches, the matching compatibility or specification terms are returned with the matching item in a compatibility field.
Although parts compatibility is supported for listing items on the eBay Motors US site only. Parts compatibility for searching is supported on the both the core eBay US site and the eBay Motors US site.
See Searching for Compatible Parts for more information on how parts compatibility is supported in item searches.
Copyright © 2005–2016 eBay Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.