taxonomy APIv1_beta.4.0

getCompatibilityPropertyValues

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 (production)

GET https://api.ebay.com/commerce/taxonomy/v1_beta/category_tree/{category_tree_id}/get_compatibility_property_values?

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 motorcyles.

  • 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, your URI would look something like this:

GET https://api.ebay.com/commerce/
taxonomy/v1_beta/category_tree/100/
get_compatibility_property_values?
category_id=6016&compatibility_property=Trim
&filter=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 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.

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 (,).

For example, if you wanted to retrieve all vehicle trims for a 2018 Toyota Camry, you would set the compatibility_property 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, your URI would look something like this:

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

Occurrence: Optional

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

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.

Output

HTTP response headers

Output container/fieldTypeDescription
compatibilityPropertyValuesarray of CompatibilityPropertyValueThis 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.valuestringEach 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.

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.
GET
https://api.ebay.com/commerce/taxonomy/v1_beta/category_tree/0/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.
GET
https://api.ebay.com/commerce/taxonomy/v1_beta/category_tree/0/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.