getProductCompatibilities: eBay Metadata API

POST/compatibilities/get_product_compatibilities

This method is used to retrieve all available item compatibility details for the specified product.

Item compatibility details can be used to see the properties for which an item is compatible. For example, if you are searching for a part for a specific vehicle, you can use this method to see the years, engine, and/or trim for which the part is compatible. Item compatibility details are returned as name-value pairs.

The product for which to retrieve item compatibility details must be provided through the productIdentifier field. This value can be either an eBay specific identifier (such as an ePID) or an external identifier (such as a UPC).

By default, all available item compatibility details for the specified product are returned. You can limit the size of the result set using the dataset or datasetPropertyName fields to specify the types of properties you want returned in the response. The applicationPropertyFilter array can also be used so that only parts compatible with the specified name-value pairs are returned.

Input

Resource URI

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

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

{ /* ProductRequest */

"applicationPropertyFilters" : [

{ /* PropertyFilterInner */

"propertyName" : "string",

"propertyValue" : "string",

"unitOfMeasurement" : "string",

"url" : "string"

}

"dataset" : [

"string"

"datasetPropertyName" : [

"string"

"disabledProductFilter" :

{ /* DisabledProductFilter */

"excludeForEbayReviews" : "boolean",

"excludeForEbaySelling" : "boolean"

"paginationInput" :

{ /* PaginationInput */

"limit" : "integer",

"offset" : "integer"

"productIdentifier" :

{ /* ProductIdentifier */

"ean" : "string",

"epid" : "string",

"isbn" : "string",

"productId" : "string",

"upc" : "string"

"sortOrders" : [

{ /* SortOrderInner */

"sortOrder" :

{ /* SortOrderProperties */

"order" : "string",

"propertyName" : "string"

"sortPriority" : "string"

}

]

}

Request fields

Input container/field	Type	Description
applicationPropertyFilters	array of PropertyFilterInner	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. Occurrence: Optional
applicationPropertyFilters.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
applicationPropertyFilters.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
applicationPropertyFilters.unitOfMeasurement	string	The unit of measurement of the property being described, if applicable. Occurrence: Optional
applicationPropertyFilters.url	string	The URL associated with the property being described, if applicable. Occurrence: Optional
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` Occurrence: Optional
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. Occurrence: Optional
disabledProductFilter	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. Occurrence: Optional
disabledProductFilter.excludeForEbayReviews	boolean	Specifies whether to filter out products excluded for eBay reviews. If set to `true`, items excluded from eBay reviews are not returned. Occurrence: Optional
disabledProductFilter.excludeForEbaySelling	boolean	Specifies whether to filter out products excluded for eBay selling. If set to `true`, items excluded from eBay selling are not returned. Occurrence: Optional
paginationInput	PaginationInput	This container controls the pagination of the result set. Occurrence: Optional
paginationInput.limit	integer	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
paginationInput.offset	integer	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
productIdentifier	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. Occurrence: Required
productIdentifier.ean	string	The EAN of the item, if applicable. EAN is the European Article Number, a barcode standard for retail product labeling primarily used outside of North America. Occurrence: Conditional
productIdentifier.epid	string	The ePID (eBay Product Identifier) of the item, if applicable. ePID is a unique identifier used by eBay to track products in its catalog. Use the getProduct method of the Catalog API to retrieve the ePID of an item. Occurrence: Conditional
productIdentifier.isbn	string	The ISBN of the item, if applicable. ISBN is the International Standard Book Number, a unique identifier for books. Occurrence: Conditional
productIdentifier.productId	string	The product ID of the item, if applicable. The product ID is a general term for a unique identifier assigned to a product. Occurrence: Conditional
productIdentifier.upc	string	The UPC of the item, if applicable. UPC stands for Universal Product Code, a unique identifier for products, primarily in North America. Occurrence: Conditional
sortOrders	array of SortOrderInner	This array controls the sort order of compatibility properties. Occurrence: Optional
sortOrders.sortOrder	SortOrderProperties	This container is used to define the property to be used in the sorting. Occurrence: Conditional
sortOrders.sortOrder.order	string	Defines the order of the sort. Valid values: `Ascending` `Descending` Occurrence: Conditional
sortOrders.sortOrder.propertyName	string	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
sortOrders.sortPriority	string	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

Output

HTTP response headers

This call has no response headers.

Response payload

Copy complete valid JSON to clipboard

{ /* ProductResponse */

"compatibilityDetails" : [

{ /* ProductResponseCompatibilityDetails */

"noteDetails" : [

{ /* PropertyFilterInner */

"propertyName" : "string",

"propertyValue" : "string",

"unitOfMeasurement" : "string",

"url" : "string"

}

"productDetails" : [

{ /* PropertyValues */

"propertyName" : "string",

"propertyValue" : "string"

}

]

}

"pagination" :

{ /* */

"count" : "integer",

"limit" : "integer",

"offset" : "integer",

"total" : "integer"

}

Response fields

Output container/field	Type	Description
compatibilityDetails	array of ProductResponseCompatibilityDetails	This container provides compatibility details for the specified product. Occurrence: Always
compatibilityDetails.noteDetails	array of PropertyFilterInner	This array returns additional comments about the corresponding product in the form of name-value pairs. Occurrence: Conditional
compatibilityDetails.noteDetails.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
compatibilityDetails.noteDetails.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
compatibilityDetails.noteDetails.unitOfMeasurement	string	The unit of measurement of the property being described, if applicable. Occurrence: Conditional
compatibilityDetails.noteDetails.url	string	The URL associated with the property being described, if applicable. Occurrence: Conditional
compatibilityDetails.productDetails	array of PropertyValues	This array returns details about the product in the form of name-value pairs. Occurrence: Conditional
compatibilityDetails.productDetails.propertyName	string	The name of the property. 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
compatibilityDetails.productDetails.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`. Occurrence: Conditional
pagination	Pagination	This container returns the pagination settings for the result set. Occurrence: Conditional
pagination.count	integer	The number of results showing on the current page of results. Occurrence: Conditional
pagination.limit	integer	The max number of entries that can be returned on a single page. Occurrence: Conditional
pagination.offset	integer	The number of items that will be skipped in the result set before returning the first item in the paginated response. Occurrence: Conditional
pagination.total	integer	The total number of results in a result set. Occurrence: Conditional

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.
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 item compatibility details for a product

This method will retrieve all available item compatibility details for a specified product.

Input

The product identifier of the item for which to retrieve compatibility details must be provided in the request body. In this sample, the epid of the item is provided.

Various filters to constrain the result set are available for this method. In this sample, the applicationPropertyFilters array is set so that only parts compatible with Chrysler model vehicles from the year 2005 will be returned. The dataset array can also be also set; in this sample, DisplayableSearchResults is defined, which means that properties for use in results for product searches are returned.

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

Output

If the call is successful, item compatiblity details for the specified product are returned (within the confines of the provided filters).

Note that the response shown is only a sample of a much larger response.

{
  "pagination": {
    "total": 7,
    "count": 7,
    "offset": 0,
    "limit": 100
  },
  "compatibilityDetails": [
    {
      "productDetails": [
        {
          "propertyName": "Engine - Liter_Display",
	  "propertyValue": "3.3L"
        },
        {
	  "propertyName": "Engine",
	  "propertyValue": "3.3L 3301CC 201Cu. In. V6 GAS OHV Naturally Aspirated"
        },
        {
          "propertyName": "Submodel",
          "propertyValue": "LX"
        },
        {
	  "propertyName": "Make",
	  "propertyValue": "Chrysler"
        },
        {
	  "propertyName": "Trim",
	  "propertyValue": "LX Mini Passenger Van 4-Door"
        },
        {
	  "propertyName": "Year",
	  "propertyValue": "2005"
        },
        {
	  "propertyName": "Model",
	  "propertyValue": "Town & Country"
        }
      ],
      "noteDetails": [
        {
	  "propertyName": "Mfrlabel",
	  "propertyValue": "ThermoQuiet Reman Loaded Caliper w/ Ceramic Pads"
        },
        {
	  "propertyName": "Position",
	  "propertyValue": "Front Left"
        },
        {
	  "propertyName": "Note",
	  "propertyValue": "FWD, Front Disc, Rear Drum, 4-Wheel ABS"
        },
        {
	  "propertyName": "PartType",
	  "propertyValue": "Disc Brake Caliper"
        }
      ]
    },
    {
      "productDetails": [
        {
	  "propertyName": "Engine - Liter_Display",
	  "propertyValue": "3.8L"
        },
        {
	  "propertyName": "Engine",
	  "propertyValue": "3.8L 3778CC 231Cu. In. V6 GAS OHV Naturally Aspirated"
        },
        {
	  "propertyName": "Submodel",
	  "propertyValue": "LX"
	},
	{
	  "propertyName": "Make",
	  "propertyValue": "Chrysler"
	},
	{
	  "propertyName": "Trim",
	  "propertyValue": "LX Mini Passenger Van 4-Door"
	},
	{
	  "propertyName": "Year",
	  "propertyValue": "2005"
	},
	{
	  "propertyName": "Model",
	  "propertyValue": "Town & Country"
	}
      ],
      "noteDetails": [
        {
	  "propertyName": "Mfrlabel",
	  "propertyValue": "ThermoQuiet Reman Loaded Caliper w/ Ceramic Pads"
	},
	{
	  "propertyName": "Position",
	  "propertyValue": "Front Left"
	},
	{
	  "propertyName": "Note",
	  "propertyValue": "FWD, Front Disc, Rear Drum, 4-Wheel ABS"
	},
	{
	  "propertyName": "PartType",
	  "propertyValue": "Disc Brake Caliper"
	}
      ]
    }
  ]
}