getCompatibilityPropertyValues: eBay Metadata API

POST/compatibilities/get_compatibility_property_values

This method is used to retrieve product compatibility property values associated with a single property name, in the specified category.

Compatibility property values can be used alongside the corresponding compatibility property name (retrieved using the getCompatibilityPropertyNames method) to describe the assembly for which an item is compatible.

The categoryId of the compatibility-enabled category for which to retrieve compatibility property values is required in the request body, as well as the propertyName for which you wish to retrieve associated values.

By default, all property values associated with the specified propertyName are returned. You can limit the size of the result set by using the propertyFilter array. Only property values associated with the specified name-value pairs will be returned.

Input

Resource URI

POST https://api.ebay.com/sell/metadata/v1/compatibilities/get_compatibility_property_values

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

This method has no URI parameters.

HTTP request headers

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

The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.

Header Type Description

Header	Type	Description
Content-Type	string	This header indicates the format of the request body provided by the client. Its value should be set to `application/json`. For more information, refer to HTTP request headers in the Using eBay RESTful APIs guide. Occurrence: Required
X-EBAY-C-MARKETPLACE-ID	string	This header identifies the seller's eBay marketplace. See Metadata API requirements and restrictions for supported values. Occurrence: Required

Content-Type

string

This header indicates the format of the request body provided by the client.

Its value should be set to application/json.

For more information, refer to HTTP request headers in the Using eBay RESTful APIs guide.

Occurrence: Required

X-EBAY-C-MARKETPLACE-ID

string

This header identifies the seller's eBay marketplace.

See Metadata API requirements and restrictions for supported values.

Occurrence: Required

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

Copy complete valid JSON to clipboard

{ /* PropertyValuesRequest */

"categoryId" : "string",

"propertyFilters" : [

{ /* PropertyFilterInner */

"propertyName" : "string",

"propertyValue" : "string",

"unitOfMeasurement" : "string",

"url" : "string"

}

"propertyName" : "string",

"sortOrder" : "string"

}

Request fields

Input container/field	Type	Description
categoryId	string	The unique identifier of the eBay leaf category for which to retrieve compatibility property values. This category must be a valid eBay category on the specified eBay marketplace, and the category must support parts compatibility. Use the getAutomotivePartsCompatibilityPolicies method to retrieve a list of categories that support parts compatibility. Occurrence: Required
propertyFilters	array of PropertyFilterInner	This array can be used to specify the compatibility properties used limit the result set. Only values associated with the specified name-value pairs will be returned in the response. For example, if the propertyName is set to `Make` and the propertyValue is set to `Honda`, only compatible Honda vehicles will be returned. Occurrence: Optional
propertyFilters.propertyName	string	The name of the property being described. For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category. Use the getCompatibilityPropertyNames method to retrieve valid property names for a specified category. Occurrence: Conditional
propertyFilters.propertyValue	string	The value for the property specified in the properyName field. For example, if the propertyName is `Make`, then the propertyValue will be the specific make of the vehicle, such as `Toyota`. Use the getCompatibilityPropertyValues to retreive valid property values associated with a specified property name. Occurrence: Conditional
propertyFilters.unitOfMeasurement	string	The unit of measurement of the property being described, if applicable. Occurrence: Optional
propertyFilters.url	string	The URL associated with the property being described, if applicable. Occurrence: Optional
propertyName	string	This field specifies the name of the property for which to retrieve associated property values. For example, typical vehicle property names are 'Make', 'Model', 'Year', 'Engine', and 'Trim', but will vary based on the eBay marketplace and the eBay category. Use the getCompatibilityPropertyNames method to retrieve valid property names for a specified category. Occurrence: Required
sortOrder	string	This field specifies the sort order for the property values in the result set. Valid values: `Ascending` Descending Note: If no search order is specified, values are sorted in ascending order. Occurrence: Optional

Output

HTTP response headers

This call has no response headers.

Response payload

Copy complete valid JSON to clipboard

{ /* PropertyValuesResponse */

"metadataVersion" : "string",

"propertyName" : "string",

"propertyValues" : [

"string"

]

}

Response fields

Output container/field	Type	Description
metadataVersion	string	The version number of the metadata. This version is upticked whenever there are compatibility name changes for the specified marketplace. Occurrence: Always
propertyName	string	The name of the property specified in the request. Occurrence: Always
propertyValues	array of string	This array specifies the property values associated with the specified propertyName, in the specified category. Occurrence: Always

Output container/field

Type

Description

metadataVersion

string

The version number of the metadata. This version is upticked whenever there are compatibility name changes for the specified marketplace.

Occurrence: Always

propertyName

string

The name of the property specified in the request.

Occurrence: Always

propertyValues

array of string

This array specifies the property values associated with the specified propertyName, in the specified category.

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
401	Unauthorized
500	Internal Server Error

Error codes

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

Code	Domain	Category	Meaning
46000	API	APPLICATION	There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
47000	API	REQUEST	Item compatibilities are not enabled for category ID {{category_id}} or invalid propertyFilter.
47002	API	REQUEST	The category {{category_id}} specified in the request does not support compatibilities.
47003	API	REQUEST	A required field is missing from the request.
47004	API	REQUEST	Invalid data supplied in the request.
47005	API	REQUEST	The marketplace id {{marketplaceId}} specified in the request is invalid.
47006	API	REQUEST	The marketplace id {{marketplaceId}} specified in the request does not support compatibility.

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: Retrieve product compatibility values associated with a property name

This method will retrieve product compatibility property values for a specified property name, in the specified category.

Input

The category ID for which to retrieve compatibility property names must be provided in the request body. In addition, the property name for which to retrieve property values must be specified through the propertyName field in the request. The propertyFilters array can also be input to specify the compatibility properties used to limit the result set. Only values associated with the specified name-value pairs will be returned in the response.

In this sample, all property values associated with the Model property name (in the specified category) will be returned in the response, as long as they are associated with the Make-Honda name-value pair specified in the propertyFilters field.

POSThttps://api.ebay.com/sell/metadata/v1/compatibilities/get_compatibility_property_values

Output

If the call is successful, all property values (within the confines of the specified propertyFilters) for the specified property name are returned.