GET/category_tree/{category_tree_id}/get_compatibility_property_values
This call retrieves applicable compatible vehicle property values based on the specified eBay marketplace, specified eBay category, and filters used in the request. Compatible vehicle properties are returned in the compatibilityProperties.name field of a getCompatibilityProperties response.
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.
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com
URI parameters
| Parameter | Type | Description |
|---|---|---|
| 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 motorcycles.
Occurrence: Required |
| 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: compatibility_property=Trim and then include the following three name/value filters through one filter parameter: filter=Year:2018,Make:Toyota,Model:Camry.So, putting this all together, the URI would look something like this: Occurrence: Required |
| 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 motorcycles. The getAutomotivePartsCompatibilityPolicies method of the Selling Metadata API can be used to retrieve all eBay categories for an eBay marketplace that support parts compatibility for vehicles. Occurrence: Required |
| 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 filter=Year:2018, and multiple compatible vehicle property name/value pairs are delimited with a comma (,).Note: Commas are used as delimiters between filter values. If a value includes a comma (e.g., BodyStyle:AWD B9 8W5,C8WD) you must include a backslash (\) immediately before the comma to prevent it from being evaluated as a delimiter.As with all query parameter values, the filter parameters must be URL encoded. For more information about encoding request parameters, refer to URL encoding query parameter values. For example, to retrieve all vehicle trims for a 2022 Audi A4:
The following sample shows the same filter but with URL encoding for the blank spaces. Note: While not required, it is strongly recommended that users limit the size of the result set by using the filter query parameter. Failure to do so may result in a timeout error if too much data is attempted to be returned. Occurrence: Optional |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
OAuth scope
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):
https://api.ebay.com/oauth/api_scope
See OAuth access tokens for more information.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| 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 Occurrence: Always |
| 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. Occurrence: Always |
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
| Status | Meaning |
|---|---|
| 200 | Success |
| 204 | No content |
| 400 | Bad Request |
| 404 | Not found |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 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. |
Warnings
This call has no warnings.
Samples
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.
Sample 1: Get 2018 Honda Models
This sample retrieves the available Honda models for 2018 that are used on the eBay US marketplace to define a motor vehicle that is compatible with a motor vehicle part or accessory.
Input
The category_tree_id value is passed in as a path parameter, and this value identifies the eBay marketplace. The category_id value is passed in as a query parameter, and the eBay category must be a category that supports parts compatibility. 'Model' is specified as the compatibility_property, and '2018' and 'Honda' are specified as the 'Year' and 'Make' values, respectively.
GEThttps://api.ebay.com/commerce/taxonomy/v1/category_tree/100/get_compatibility_property_values?compatibility_property=Model&category_id=33559&filter=Year:2018,Make:Honda
Output
A successful call returns an array of all available 2018 Honda models for eBay US and eBay category '33559'. The value fields show the actual names that should be used for 'Model' when searching for or defining a motor vehicle that is compatible with a motor vehicle part or accesory.
Sample 2: Get 2018 Ferrari Trims
This sample retrieves the available Ferrari trims for 2018 that are used on the eBay US Motors marketplace to define a motor vehicle that is compatible with a motor vehicle part or accessory.
Input
The category_tree_id value is passed in as a path parameter, and this value identifies the eBay marketplace. The category_id value is passed in as a query parameter, and the eBay category must be a category that supports parts compatibility. 'Trim' is specified as the compatibility_property, and '2018' and 'Ferrari' are specified as the 'Year' and 'Make' values, respectively.
GEThttps://api.ebay.com/commerce/taxonomy/v1/category_tree/100/get_compatibility_property_values?compatibility_property=Trim&category_id=6030&filter=Year:2018,Make:Ferrari
Output
A successful call returns an array of all available 2018 Ferrari trims for eBay US Motors and eBay category '6030'. The value fields show the actual names that should be used for 'Trim' when searching for or defining a motor vehicle that is compatible with a motor vehicle part or accesory.