Skip to main content

This type defines the request fields for the getProductCompatibilities method.

Types that use ProductRequest

Not used by any types.

Call that uses ProductRequest

Fields

Field
Type
Description
applicationPropertyFilters
This array is used to filter the properties of an application, such as a vehicle's make or model, that will be returned in the response.

Application property filters are specified as name-value pairs. Only products compatible with these name-value pairs will be returned.
dataset
array of string
This array defines the type of properties that are returned for the catalog-enabled category.

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.

Default: DisplayableSearchResults
datasetPropertyName
array of string
This comma-delimted 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.
disabledProductFilter
This container can be used to specify whether or not to filter out products which are disabled for selling on eBay and/or disabled for product review.
paginationInput
This container controls the pagination of the result set.
productIdentifier
This container is used to provide unique identifier for the product. The product identifier consists of an identifier type and value, and are unique across all sites.
sortOrders
This array controls the sort order of compatibility properties.