FindCompatibilitiesBySpecificationRequest ( BaseServiceRequest )

This operation returns all the compatiblilities for a given specification. User can constrain the output further by specifiying the compatibility propertiesthat they are interested in.

Call that uses FindCompatibilitiesBySpecificationRequest:

findCompatibilitiesBySpecification

Fields

categoryId ( string )

compatibilityPropertyFilter ( PropertyValue )

dataSet ( token )

datasetPropertyName ( string )

exactMatch ( boolean )

paginationInput ( PaginationInput )

sortOrder ( CompatibilitySort )

specification ( PropertyValue )

categoryId ( string ) [1]

Category ID for which we want to find out the compatibility details

See the Field Index to learn which calls use categoryId.

compatibilityPropertyFilter ( PropertyValue ) [0..*]

This filter is used to restrict the number of compatible vehicles that can be returned. Properties that can be used here include Make, Model, Year and Trim

See the Field Index to learn which calls use compatibilityPropertyFilter.

dataSet ( token ) [0..*]

This will define what are properties that will be returned for this catelog-enabled category.

Dataset values:
DisplayableProductDetails: Properies 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.

User can either enter dataset name or enter individual property names (datasetPropertyName) from the dataset. Only one should be preset at a time.

See the Field Index to learn which calls use dataSet.

datasetPropertyName ( string ) [0..*]

User can either enter dataset name or enter individual property names from the dataset. Only one should be preset at a time.

See the Field Index to learn which calls use datasetPropertyName.

exactMatch ( boolean ) [0..1]

For certain specification properties the compatibility is defined not by an exact match but by an expanded match on the input value by greater or lesser values as well. E.g For Load Index a compatible vehicle is the one which has a load index requirement which is less than or equal to the input. By default we will do an expanded compatibility match whenever it applies. However if you need to do only exact match then you can specify that using this input.

See the Field Index to learn which calls use exactMatch.

paginationInput ( PaginationInput ) [0..1]

Controls the pagination of the result set. Child elements specify the maximum number of products to return per call and the page of data to return. Controls the number of products returned in the response, but does not specify the amount of data to return for each product.

Note: No more than 10,000 products can be retrieved for a given search, regardless of how many matches are found. This limit is enforced by the maximum page number allowed (100) and the maximum entries per page allowed (20).

See the Field Index to learn which calls use paginationInput.

sortOrder ( CompatibilitySort ) [0..*]

Sort Order for the result set. Any of the searchable property can be used to specify the sort order. If no sort order is specified then default sort order(popularity descending) will be applied.

See the Field Index to learn which calls use sortOrder.

specification ( PropertyValue ) [0..*]

The specifications for which we need the compatibility. Examples include Aspect Ratio, Section Width etc.

See the Field Index to learn which calls use specification.