getCompatibilitiesBySpecification

The unique identifier of the eBay leaf category for which compatibility details are being retrieved. This category must be a valid eBay category on the specified eBay marketplace, and the category must support parts compatibility for cars, trucks, or motorcycles.

Use the getAutomotivePartsCompatibilityPolicies method to retrieve a list of categories that support parts compatibility by specification. For the categories in the response that support compatibility by specification, you’ll see SPECIFICATIONS as the value for the compatibilityBasedOn field

Occurrence: Required

This comma-delimited array can be used to restrict the number of compatible application name-value pairs returned in the response by specifying the properties that the seller wishes to be included in the response.

Only compatible applications with the specified properties will be returned. Properties that can be specified here include make, model, year, and trim.

Occurrence: Optional

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

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

The unit of measurement of the property being described, if applicable.

Occurrence: Optional

The URL associated with the property being described, if applicable.

Occurrence: Optional

This field can be used to define the type of properties that will be returned in the response.

For example, if you specify Searchable, the compatibility details will contain properties that can be used to search for products, such as make or model.

Note: This field cannot be used alongside dataPropertyName. If both are used, an error will occur.
Valid values:

• DisplayableProductDetails: Properties for use in a user interface to describe products.
• DisplayableSearchResults: Properties for use in results for product searches.
• Searchable: Properties for use in searches.
• Sortable: Properties that are suitable for sorting.

Occurrence: Optional

This comma-delimited array can be used to define the specific property name(s) that will be returned in the response.

For example, if you specify Engine, the result set will only contain engines that are compatible with the input criteria.

Note: This array cannot be used alongside dataset. If both are used, an error will occur.

Occurrence: Optional

This boolean can be used to specify that the compatibilities returned in the response are to be defined by an exact match on the input value of specification properties.

By default, an expanded compatibility match is done when it applies, such as for Load Index, where a compatible vehicle is one that has a load index requirement that is less than or equal to the input. By specifying this field as true, only exact matches are returned.

Occurrence: Optional

Occurrence: Optional

The max number of items, from the current result set, returned on a single page.

Note: For getProductCompatibilities, the max value is 100. If no limit is specified, this field defaults to the max value.

Occurrence: Optional

The number of items that will be skipped in the result set before returning the first item in the paginated response.

Combine offset with limit to control the items returned in the response. For example, if you supply an offset of 10 and a limit of 20, the first page of the response contains items 11-30 from the complete result set.

Default: 0

Occurrence: Optional

This array specifies the sorting order of the compatibility properties. Any of the searchable properties can be used to specify search order. Up to 5 levels of sort order may be specified.

Note: If no sort order is specified through this field, the default sort order of popularity descending is applied.

Occurrence: Optional

This container is used to define the property to be used in the sorting.

Occurrence: Conditional

Defines the order of the sort.

Valid values:

• Ascending
• Descending

Occurrence: Conditional

The name of the searchable property to be used for sorting.

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.

Occurrence: Conditional

The priority of the specified sort order provided.

For example, when a property is assigned Sort1, its values are sorted first. Values for the property assigned Sort2 are sorted second, and so on.

Valid values:

• Sort1
• Sort2
• Sort3
• Sort4
• Sort5

Occurrence: Conditional

This array defines the specifications of the part, in the form of name-value pairs, for which compatible applications will be retrieved.

Occurrence: Required

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

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

The unit of measurement of the property being described, if applicable.

Occurrence: Optional

The URL associated with the property being described, if applicable.

Occurrence: Optional