Parts compatibility is supported by the following APIs:
- Trading API
-
Product Services:
- Product API
- Product Metadata API
- Finding API
Trading API
Parts compatibility is supported in select Parts & Accessories categories only for the following marketplaces:
- eBay US Motors (100)
- Canada (2)
- UK (3)
- Australia (15)
- Germany (77)
The Trading API provides the calls needed 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 marketplace support parts compatibility. Refer to Category Support for additional information.
Listing items with parts compatibility is supported by the following calls:
- AddFixedPriceItem
- AddItem
- AddItems
- RelistFixedPriceItem
- RelistItem
- ReviseFixedPriceItem
- ReviseItem
- VerifyAddItem
- VerifyRelistItem
Use GetItem to retrieve parts compatibility information for an active item listing.
Refer to Create a Listing for more information.
Product Services
Product Services provides 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.
eBay Product Services comprises two APIs:
-
Product API
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.
For complete information about using the Product API refer to the Product API reference documentation.
-
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.
For complete information about using the Product Metadata API refer to the Product Metadata API reference documentation.
Refer to Create a Listing for more information about how the Product API and the Product Metadata API support listing items with parts compatibility.
Finding API
The Finding API supports parts compatibility. When buyers search for parts with keyword queries that include compatibility information (e.g., vehicle year, make, or model,) or part specifications (e.g., tire section width, aspect ratio of the sidewall, 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.
Refer to Search for compatible parts for additional information about how parts compatibility is supported in item searches.
Refer to the Finding API User Guide for complete information about using the Finding API.