getCompatibilitySearchValues

Note: All calls in the Product Metadata API have been deprecated and will be decommissioned on April 27th, 2026. Current users of this API are recommended to migrate to the compatibilities methods of the Metadata API.

Use this call to find property values for the specified category and application property (e.g., Make or Model). The required input consists of the category ID of the compatibility-enabled category and the property of the application (i.e., assembly or vehicle) for the item or product you want to list. This call retrieves search values for a single property name only.

Compatibility search values can be used to:

• Specify compatibility manually by application when listing an item

  When you list at item with parts compatibility, you specify the properties and corresponding values that describe the assembly (vehicle) with which your item is compatible. You may only use the compatibility search names and values supported by the primary category of your listing request.

• Find compatible products

  The easiest way to list an item with parts compatibility is to list with an eBay catalog product that has compatibilities. Use compatibility search names and values to construct filters for the findProductsByCompatibility call in the Product API to find products with specific compatibilities.

See Parts Compatibility for more information about the purpose of parts compatibility and how to use the API to include parts compatibility into your listings.

See also the reference documentation for these calls:

• getCompatibilitySearchDataVersion - Get the metadata version for the specified category.
• getCompatibilitySearchNames - Returns all properties available for a given catalog enabled category.
• getCompatibilitySearchValuesBulk - Retrieves property values for multiple fields (up to 10).

See also the reference documentation for this call (in the Product API Reference):

• findProductsByCompatibility - Finds products for the specified category, catalog property name-value pairs, and compatibility property name-value pairs.

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"?>
<getCompatibilitySearchValuesRequest xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services">
 <!-- Call-specific Input Fields -->
 <propertyName> string </propertyName>
 <!-- Standard Input Fields -->
 <categoryId> string </categoryId>
 <listFormatOnly> boolean </listFormatOnly>
 <propertyFilter> 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 ... -->
 </propertyFilter>
 <!-- ... more propertyFilter nodes allowed here ... -->
 <sortOrder> SortOrder
 <order> OrderType </order>
 <propertyName> string </propertyName>
 </sortOrder>
 <!-- ... more sortOrder nodes allowed here ... -->
</getCompatibilitySearchValuesRequest>

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"?>
<getCompatibilitySearchValuesResponse xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services">
 <!-- Call-specific Output Fields -->
 <metadataVersion> string </metadataVersion>
 <propertyValues> 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 ... -->
 </propertyValues>
 <!-- ... more propertyValues nodes allowed here ... -->
 <propertyValuesTree> PropertyNameValue
 <childPropertyNameValue> PropertyNameValue
 <childPropertyNameValue> PropertyNameValue
 <childPropertyNameValue> PropertyNameValue </childPropertyNameValue>
 <!-- >>> childPropertyNameValue can be nested within itself an unlimited number of times >>> -->
 <!-- ... more childPropertyNameValue nodes allowed here ... -->
 <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>
 </childPropertyNameValue>
 <!-- ... more childPropertyNameValue nodes allowed here ... -->
 <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>
 </childPropertyNameValue>
 <!-- ... more childPropertyNameValue nodes allowed here ... -->
 <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>
 </propertyValuesTree>
 <treeFormat> boolean </treeFormat>
 <!-- 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>
</getCompatibilitySearchValuesResponse>

Samples

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

Change History