getProductCompatibilities

Note: This call has been deprecated and will be decommissioned on April 27th, 2026. Users are recommended to migrate to the getProductCompatibilities method of the Metadata API.

This call retrieves all available item compatibility details for the specified product. Item compatibility properties are returned as name-value pairs. The request requires a product identifier, either an eBay-specific identifier (e.g., ePID) or an external identifier, such as a Universal Part Code (UPC). Use this call to get complete compatibility details for products you find using findProductsByCompatibility. For example, if you searched for parts that fit a Honda Accord, you can use this call to see the years, engine, and trim for which the part is compatible, as well as any other compatibilities for the product.

Use either dataset or datasetPropertyName to restrict the name-value pairs returned in the response. The dataset value specifies the type of compatibility properties you want back. For example, if you specify Searchable, your compatibility details will be contain properties that can be used to search for products, such as Make and Model. Some compatibility properties, such as FitmentComments, are not intended for product searches.

Input

See also Samples.

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

<?xml version="1.0" encoding="utf-8"?>
<getProductCompatibilitiesRequest xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services">
 <!-- Call-specific Input Fields -->
 <applicationPropertyFilter> PropertyValue
 <propertyName> string </propertyName>
 <value> Value
 <number> NumericValue
 <unitOfMeasurement> token </unitOfMeasurement>
 <value> string </value>
 </number>
 <text> StringValue
 <value> string </value>
 </text>
 <URL> URIValue
 <value> anyURI </value>
 </URL>
 </value>
 <!-- ... more value nodes allowed here ... -->
 </applicationPropertyFilter>
 <!-- ... more applicationPropertyFilter nodes allowed here ... -->
 <dataset> token </dataset>
 <!-- ... more dataset values allowed here ... -->
 <datasetPropertyName> string </datasetPropertyName>
 <!-- ... more datasetPropertyName values allowed here ... -->
 <disabledProductFilter> ProductStatus
 <excludeForeBayReviews> boolean </excludeForeBayReviews>
 <excludeForeBaySelling> boolean </excludeForeBaySelling>
 <excludeForHalfSelling> boolean </excludeForHalfSelling>
 </disabledProductFilter>
 <paginationInput> PaginationInput
 <entriesPerPage> int </entriesPerPage>
 <pageNumber> int </pageNumber>
 </paginationInput>
 <productIdentifier> ProductIdentifier
 <EAN> string </EAN>
 <ePID> string </ePID>
 <ISBN> string </ISBN>
 <productId> string </productId>
 <UPC> string </UPC>
 </productIdentifier>
 <sortOrder> CompatibilitySort
 <sortOrder> SortOrder
 <order> OrderType </order>
 <propertyName> string </propertyName>
 </sortOrder>
 <sortPriority> SortPriority </sortPriority>
 </sortOrder>
 <!-- ... more sortOrder nodes allowed here ... -->
</getProductCompatibilitiesRequest>

Output

See also Samples.

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

<?xml version="1.0" encoding="utf-8"?>
<getProductCompatibilitiesResponse xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services">
 <!-- Call-specific Output Fields -->
 <compatibilityDetails> Product
 <compatibilityCount> int </compatibilityCount>
 <notes> Notes
 <noteDetails> PropertyValue
 <propertyName> string </propertyName>
 <value> Value
 <number> NumericValue
 <value> string </value>
 </number>
 <text> StringValue
 <value> string </value>
 </text>
 <URL> URIValue
 <value> anyURI </value>
 </URL>
 </value>
 <!-- ... more value nodes allowed here ... -->
 </noteDetails>
 <!-- ... more noteDetails nodes allowed here ... -->
 </notes>
 <productDetails> PropertyValue
 <propertyName> string </propertyName>
 <value> Value
 <number> NumericValue
 <value> string </value>
 </number>
 <text> StringValue
 <value> string </value>
 </text>
 <URL> URIValue
 <value> anyURI </value>
 </URL>
 </value>
 <!-- ... more value nodes allowed here ... -->
 </productDetails>
 <!-- ... more productDetails nodes allowed here ... -->
 <productIdentifier> ProductIdentifier
 <EAN> string </EAN>
 <ePID> string </ePID>
 <ISBN> string </ISBN>
 <productId> string </productId>
 <UPC> string </UPC>
 </productIdentifier>
 <productStatus> ProductStatus
 <excludeForeBayReviews> boolean </excludeForeBayReviews>
 <excludeForeBaySelling> boolean </excludeForeBaySelling>
 <excludeForHalfSelling> boolean </excludeForHalfSelling>
 </productStatus>
 <stockPhotoURL> StockPhotoURL
 <standard> URIValue
 <value> anyURI </value>
 </standard>
 <thumbnail> URIValue
 <value> anyURI </value>
 </thumbnail>
 </stockPhotoURL>
 <type> string </type>
 </compatibilityDetails>
 <!-- ... more compatibilityDetails nodes allowed here ... -->
 <paginationOutput> PaginationOutput
 <entriesPerPage> int </entriesPerPage>
 <pageNumber> int </pageNumber>
 <totalEntries> int </totalEntries>
 <totalPages> int </totalPages>
 </paginationOutput>
 <!-- Standard Output Fields -->
 <ack> AckValue </ack>
 <errorMessage> ErrorMessage
 <error> ErrorData
 <category> ErrorCategory </category>
 <domain> string </domain>
 <errorId> long </errorId>
 <exceptionId> token </exceptionId>
 <message> string </message>
 <parameter name="string"> ErrorParameter (string) </parameter>
 <!-- ... more parameter values allowed here ... -->
 <severity> ErrorSeverity </severity>
 <subdomain> string </subdomain>
 </error>
 <!-- ... more error nodes allowed here ... -->
 </errorMessage>
 <timestamp> dateTime </timestamp>
 <version> string </version>
</getProductCompatibilitiesResponse>

Samples

Code samples not yet added for this call's documentation.

Change History