Skip to main content

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

GET https://api.ebay.com/commerce/taxonomy/v1/category_tree/{category_tree_id}/get_compatibility_property_values?
compatibility_property=string&
category_id=string&
filter=ConstraintFilter

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

ParameterTypeDescription
category_tree_idstringThis 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.

  • eBay US: 0
  • eBay Motors US: 100
  • eBay Canada: 2
  • eBay UK: 3
  • eBay Germany: 77
  • eBay Australia: 15
  • eBay France: 71
  • eBay Italy: 101
  • eBay Spain: 186

Occurrence: Required

compatibility_propertystringOne 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:

GET https://api.ebay.com/commerce/
taxonomy/v1/category_tree/100/
get_compatibility_property_values?
category_id=6016&compatibility_property=Trim
&filter=Year:2018,Make:Toyota,Model:Camry

Occurrence: Required

category_idstringThe 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

filterConstraintFilterOne 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:
  • Set the compatibility_property filter to compatibility_property=Trim
  • Include the following name/value filters using one filter parameter:
    • Year:2022
    • Make:Audi
    • Model:A4
    • BodyStyle:AWD B9 8W5\,8WD
The resulting comma-separated filter query parameter is:
filter=Year:2022,Make:Audi,Model:A4,BodyStyle:AWD B9 8W5\,8WD

The following sample shows the same filter but with URL encoding for the blank spaces.
GET https://api.ebay.com/commerce/
taxonomy/v1/category_tree/100/
get_compatibility_property_values?category_id=6016&compatibility_property=Trim&filter=Year:2022,Make:Audi,Model:A4,BodyStyle:AWD%20B9%208W5%5C%2C8WD

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/fieldTypeDescription
compatibilityPropertyValuesarray 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 filter query parameter of the request, and also based on the eBay marketplace and category specified in the call request.

Occurrence: Always

compatibilityPropertyValues.valuestring

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.

StatusMeaning
200Success
204No content
400Bad Request
404Not found
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
62000API_TAXONOMYAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
62004API_TAXONOMYREQUESTThe specified category tree ID was not found.
62005API_TAXONOMYREQUESTThe specified category ID does not belong to specified category tree.
62006API_TAXONOMYREQUESTMissing category ID.
62100API_TAXONOMYREQUESTThe filter format is invalid. For more information, see the API call reference documentation.
62101API_TAXONOMYREQUESTThis category ID is disabled for parts compatibility.
62102API_TAXONOMYREQUESTThe compatibility property is invalid.
62103API_TAXONOMYREQUESTThe CategoryTreeId is not supported.
62104API_TAXONOMYREQUESTMissing compatibility property.

Warnings

This call has no warnings.

Samples

This call has no samples.