This type provides the properties and specifications to use to search for compatibilities.
Types that use SpecificationRequest
Not used by any types.
Call that uses SpecificationRequest
Fields
categoryId
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
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 compatibilityPropertyFilters
array of PropertyFilterInner
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.
Only compatible applications with the specified properties will be returned. Properties that can be specified here include make, model, year, and trim.
dataset
This field can be used to define the type of properties that will be returned in the response.
For example, if you specify
Note: This field cannot be used alongside dataPropertyName. If both are used, an error will occur.
Valid values:
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.
DisplayableSearchResults
datasetPropertyName
array of string
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
Note: This array cannot be used alongside dataset. If both are used, an error will occur.
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.
exactMatch
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
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.paginationInput
Important! Pagination is not yet supported by this method. If this container is included in the request, it will be ignored.
sortOrders
array of SortOrderInner
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.
Note: If no sort order is specified through this field, the default sort order of popularity descending is applied.
specifications
array of PropertyFilterInner
This array defines the specifications of the part, in the form of name-value pairs, for which compatible applications will be retrieved.