GET/category_tree/{category_tree_id}/get_compatibility_properties
This call retrieves the compatible vehicle aspects that are used to define a motor vehicle that is compatible with a motor vehicle part or accessory. The values that are retrieved here might include motor vehicle aspects such as 'Make', 'Model', 'Year', 'Engine', and 'Trim', and each of these aspects are localized for the eBay marketplace.
The category_tree_id value is passed in as a path parameter, and this value identifies the eBay category tree. The category_id value is passed in as a query parameter, as this parameter is also required. The specified category must be a category that supports parts compatibility.
At this time, this operation only supports parts and accessories listings for cars, trucks, and motorcycles (not boats, power sports, or any other vehicle types). Only the following eBay marketplaces support parts compatibility:
- eBay US (Motors and non-Motors categories)
- eBay Canada (Motors and non-Motors categories)
- eBay UK
- eBay Germany
- eBay Australia
- eBay France
- eBay Italy
- eBay Spain
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 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 |
| 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 |
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 |
|---|---|---|
| compatibilityProperties | array of CompatibilityProperty | This container consists of an array of all compatible vehicle properties applicable to the specified eBay marketplace and eBay category ID. Occurrence: Always |
| compatibilityProperties.name | string | This is the actual name of the compatible vehicle property as it is known on the specified eBay marketplace and in the eBay category. This is the string value that should be used in the compatibility_property and filter query parameters of a getCompatibilityPropertyValues request URI. Occurrence: Always |
| compatibilityProperties.localizedName | string | This is the localized name of the compatible vehicle property. The language that is used will depend on the user making the call, or based on the language specified if the Content-Language HTTP header is used. 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. |
| 62101 | API_TAXONOMY | REQUEST | This category ID is disabled for parts compatibility. |
| 62103 | API_TAXONOMY | REQUEST | The CategoryTreeId is not supported. |
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 compatibility properties for US
This sample retrieves the compatible vehicle aspects 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.
GEThttps://api.ebay.com/commerce/taxonomy/v1/category_tree/100/get_compatibility_properties?category_id=33733
Output
A successful call returns an array of all compatible vehicle properties applicable to eBay US and eBay category '33733'. The name fields show the actual names of the compatible vehicle properties on the specified eBay marketplace and eBay category. These are the string values that should be used in the compatibility_property and filter query parameters of a getCompatibilityPropertyValues request URI.
Typical vehicle properties on the eBay US marketplace are 'Year', 'Make', 'Model', 'Trim', and 'Engine'.
The localizedName fields show the localized versions of the compatible vehicle properties. The language that is used will depend on the user making the call, or based on the language specified if the Content-Language HTTP header is used.
In some instances, the string value in the localizedName field may be the same as the string in the corresponding name field.
Sample 2: Get compatibility properties for Italy
This sample retrieves the compatible vehicle aspects that are used on the eBay Italy 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.
GEThttps://api.ebay.com/commerce/taxonomy/v1/category_tree/101/get_compatibility_properties?category_id=33559
Output
A successful call returns an array of all compatible vehicle properties applicable to the eBay Italy and eBay category '33559'. The name fields show the actual names of the compatible vehicle properties on the specified eBay marketplace and eBay category. These are the string values that should be used in the compatibility_property and filter query parameters of a getCompatibilityPropertyValues request URI.
Typical vehicle properties on the eBay Italy marketplace are 'Year', 'IT_Make', 'IT_Model', 'IT_Type', and 'IT_Engine'.
The localizedName fields show the localized versions of the compatible vehicle properties (Italian localization). The language that is used will depend on the user making the call, or based on the language specified if the Content-Language HTTP header is used.
In some instances, the string value in the localizedName field may be the same as the string in the corresponding name field.