getCompatibilitySearchNames

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 the product compatibility property names (i.e., the assembly/vehicle to which the item applies). These names can be used to retrieve search values that can be used to search for products.

Compatibility search names 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.

Site and Category Dependencies

Compatibility metadata is both site and category dependent. For example, if the input category is brake pads (Pads & Shoes, #33567) on the eBay Motors US site (global ID, EBAY-MOTOR), then the response would return the following properties:

• Year
• Make
• Model
• Trim
• Engine

If the input category is brake shoes (Bremsbacken, #61739) on the eBay Germany site (global ID EBAY-DE), then the response would return the following properties:

• Make
• Model
• Platform
• Type
• Engine
• Production Period

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.

Related Information

See also the reference documentation for these calls:

• getCompatibilitySearchDataVersion - Get the metadata version for the specified category.
• getCompatibilitySearchValues - Retrieves all available values and their dependencies for a given compatibility property or a group of compatibility properties.
• getCompatibilitySearchValuesBulk - Retrieves property values for multiple fields (up to 10).

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"?>
<getCompatibilitySearchNamesRequest xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services">
 <!-- Call-specific Input Fields -->
 <categoryId> string </categoryId>
 <dataset> token </dataset>
 <!-- ... more dataset values allowed here ... -->
</getCompatibilitySearchNamesRequest>

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"?>
<getCompatibilitySearchNamesResponse xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services">
 <!-- Call-specific Output Fields -->
 <categoryId> string </categoryId>
 <properties> Properties
 <dataset> token </dataset>
 <metadataVersion> string </metadataVersion>
 <propertyName> Property
 <propertyDisplayName> string </propertyDisplayName>
 <propertyName> string </propertyName>
 <propertyNameMetadata> PropertyNameMetadata
 <displaySequence> int </displaySequence>
 </propertyNameMetadata>
 </propertyName>
 <!-- ... more propertyName nodes allowed here ... -->
 </properties>
 <!-- ... more properties nodes allowed here ... -->
 <!-- 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>
</getCompatibilitySearchNamesResponse>

Samples

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

Change History