One compatible vehicle property applicable to the specified eBay marketplace and eBay category is specified through the required compatibility_property filter. Then, the user has the option of further restricting the compatible vehicle property values that are returned in the response by specifying one or more compatible vehicle property name/value pairs through the filter query parameter.
See the documentation in URI parameters section for more information on using the compatibility_property and filter query parameters together to customize the data that is retrieved.
Resource URI (production)
|category_tree_id||string||This is the unique identifier of the category tree. The following is the list of category_tree_id values and the eBay marketplaces that they represent. One of these ID values must be passed in as a path parameter, and the category_id value, that is passed in as query parameter, must be a valid eBay category on that eBay marketplace that supports parts compatibility for cars, trucks, or motorcyles.|
|compatibility_property||string||One compatible vehicle property applicable to the specified eBay marketplace and eBay category is specified in this required filter. Compatible vehicle properties are returned in the compatibilityProperties.name field of a getCompatibilityProperties response. |
For example, if you wanted to retrieve all vehicle trims for a 2018 Toyota Camry, you would set this filter as follows:
|category_id||string||The unique identifier of an eBay category. This eBay category must be a valid eBay category on the specified eBay marketplace, and the category must support parts compatibility for cars, trucks, or motorcyles. The getAutomotivePartsCompatibilityPolicies method of the Selling Metadata API can be used to retrieve all eBay categories for an eBay marketplace that supports parts compatibility cars, trucks, or motorcyles. The getAutomotivePartsCompatibilityPolicies method can also be used to see if one or more specific eBay categories support parts compatibility. |
|filter||ConstraintFilter||One or more compatible vehicle property name/value pairs are passed in through this query parameter. The compatible vehicle property name and corresponding value are delimited with a colon (:), such as |
For example, if you wanted to retrieve all vehicle trims for a 2018 Toyota Camry, you would set the compatibility_property filter as follows:
HTTP request headers
This request requires an access token created with the client credentials grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
See OAuth access tokens for more information.
|compatibilityPropertyValues||array of CompatibilityPropertyValue||This array contains all compatible vehicle property values that match the specified eBay marketplace, specified eBay category, and filters in the request. If the compatibility_property parameter value in the request is 'Trim', each value returned in each value field will be a different vehicle trim, applicable to any filters that are set in the |
|compatibilityPropertyValues.value||string||Each value field shows one applicable compatible vehicle property value. The values that are returned will depend on the specified eBay marketplace, specified eBay category, and filters in the request. |
For more on errors, plus the codes of other common errors, see Handling errors.
|62000||API_TAXONOMY||APPLICATION||There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.|
|62004||API_TAXONOMY||REQUEST||The specified category tree ID was not found.|
|62005||API_TAXONOMY||REQUEST||The specified category ID does not belong to specified category tree.|
|62006||API_TAXONOMY||REQUEST||Missing category ID.|
|62100||API_TAXONOMY||REQUEST||The filter format is invalid. For more information, see the API call reference documentation.|
|62101||API_TAXONOMY||REQUEST||This category ID is disabled for parts compatibility.|
|62102||API_TAXONOMY||REQUEST||The compatibility property is invalid.|
|62103||API_TAXONOMY||REQUEST||The CategoryTreeId is not supported.|
|62104||API_TAXONOMY||REQUEST||Missing compatibility property.|
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.