getCompatibilitySearchValues

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.

Note: Parts Compatibility is supported in limited Parts & Accessories categories for the eBay US Motors (site ID 100) and eBay Germany (site ID 77) sites only.

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

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">
  <!-- (No call-specific Output fields) -->

  <!-- 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>
  <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>
        <!-- >>> 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>
  </propertyValuesTree>
  <timestamp> dateTime </timestamp>
  <treeFormat> boolean </treeFormat>
  <version> string </version>
</getCompatibilitySearchValuesResponse>

Return Value	Type	Occurrence	Meaning

(No call-specific fields)

Standard Output Fields

ack	AckValue	Always	Indicates whether or not errors or warnings were generated during the processing of the request. Applicable values: Failure The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data. PartialFailure The request that triggered the error was processed successfully but with some warnings. Success The request was processed successfully, but something occurred that may affect your application or the user. Warning The request that triggered the error was processed successfully but with some warnings.
errorMessage	ErrorMessage	Conditionally	Description of an error or warning that occurred when eBay processed the request. Not returned if the ack value is Success.
errorMessage.error	ErrorData	Conditionally, repeatable: [0..*]	Details about a single error.
errorMessage.error.category	ErrorCategory	Conditionally	There are three categories of errors: request errors, application errors, and system errors. Applicable values: Application An error occurred due to a problem with the request, with the most likely source being the application sending the request. For example, the request is missing a required data element or it contains an invalid field. The problem must be corrected before the request can be resent. Inspect the error message to find the cause of the problem. If the problem is due to an application error, modify the application and resend the request. If the error is due to invalid data, the source of the data must be corrected before you resend the resend request to eBay. Request An error occurred due to a problem with the request, with the most likely source being missing or invalid data in the request. The problem must be corrected before the request can be retried. Inspect the error message to find the cause of the problem. If the problem is a result of end-user data, alert the end-user to the problem and provide the means for them to correct the problem. Once the problem is resolved, resend the request to eBay. System Indicates that an error has occurred on the eBay system side. For example, a database or server could be down. Inspect the error message to find the cause of the problem. If the problem is on the eBay side, an application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
errorMessage.error.domain	string	Conditionally	Name of the domain in which the error occurred. domain values: Marketplace A business or validation error occurred in the service. SOA An exception occurred in the Service Oriented Architecture (SOA) framework.
errorMessage.error.errorId	long	Conditionally	A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
errorMessage.error.exceptionId	token	Conditionally	Unique identifier for an exception associated with an error.
errorMessage.error.message	string	Conditionally	A detailed description of the condition that caused in the error.
errorMessage.error.parameter	ErrorParameter (string)	Conditionally, repeatable: [0..*]	Various warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error.
errorMessage.error.parameter [ attribute name ]	string	Conditionally	Various warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error.
errorMessage.error.severity	ErrorSeverity	Conditionally	Indicates whether the reported problem is fatal (an error) or is less- severe (a warning). Review the error message details for information on the cause. If the request fails and the application is the source of the error (for example, a required element is missing), update the application before you retry the request. If the problem is due to incorrect user data, alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, re-send the request to eBay. If the source of the problem is on eBay's side, you can retry the request a reasonable number of times (eBay recommends you try the request twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, you can resend the request in its original form. If a warning occurs, warning information is returned in addition to the business data. Normally, you do not need to resend the request (as the original request was successful). However, depending on the cause of the warning, you might need to contact the end user, or eBay, to effect a long term solution to the problem. Applicable values: Error eBay encountered a fatal error during the processing of the request, causing the request to fail. When eBay encounters an error, it returns error data instead of the requested business data. Inspect the error details and resolve the problem before resubmitting the request. Warning The request was successfully processed, but eBay encountered a non-fatal error during the processing that could affect the data returned. For example, eBay might have changed the value of an input field. In this case, eBay returns a successful response, but it also returns a warning. For best results, requests should return without warnings. Inspect the warning details and resolve the problem before resubmitting the request. Code so that your app gracefully handles any future changes to this list.
errorMessage.error.subdomain	string	Conditionally	Name of the subdomain in which the error occurred. subdomain values: MarketplaceCatalog The error is specific to the Marketplace Catalog subdomain. MarketplaceCommon The error is common to all Marketplace services.
metadataVersion	string	Conditionally	Version information reflects the last update of the values within the dependency graph.
propertyValues	PropertyValue	Conditionally, repeatable: [0..*]	This will be populated for the non-fitment enabled category
propertyValues.propertyName	string	Conditionally	This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to.
propertyValues.value	Value	Conditionally, repeatable: [0..*]	A value for the property.
propertyValues.value.number	NumericValue	Conditionally	For numeric value type.
propertyValues.value.number .unitOfMeasurement	token	Conditionally	Unit of measure for a numeric value. Allowed values: bps Bits per second. A unit of data transmission. kbps Kilobits per second. A unit of data transmission. bit Binary digit. A unit of information storage. byte An ordered collection of bits. A unit of information storage equal to 8 bits in most contexts. kb Kilobit. A unit of information storage equal to 1024 bits. MB Megabyte. A unit of information storage equal to one million bytes. mW Megawatt. A unit of power equal to one million watts. W Watt. The base SI unit of power. Hz Hertz. A unit of frequency equal to one cycle per second. kHz Kilohertz. A unit of frequency equal to 1,000 cycles per second. m Meter. The base unit of distance. mm Megameter. A unit of distance equal to one million meters. rph Revolutions per hour. A unit of frequency. hr Hour. A unit of time equal to 3,600 seconds. min Minute. A unit of time equal to 60 seconds. ms Microsecond. A unit of time equal to one millionth of a second. ns Nanosecond. A unit of time equal to 10^-9 seconds. sec Seconds. The base unit of time. g Grams. A unit of mass equal to one one-thousandth of the SI base unit, the kilogram. lbs Pounds. The base Imperial unit of mass. The allowed units of measure do not apply to all numeric values. For example, when specifying the number of doors, unitOfMeasurement is not needed.
propertyValues.value.number .value	string	Conditionally	A number value.
propertyValues.value.text	StringValue	Conditionally	For string value type.
propertyValues.value.text .value	string	Conditionally	A string value.
propertyValues.value.URL	URIValue	Conditionally	For URL value type.
propertyValues.value.URL.value	anyURI	Conditionally	As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay.
propertyValuesTree	PropertyNameValue	Conditionally	This will be populated for non-fitment enabled category
propertyValuesTree .childPropertyNameValue	PropertyNameValue	Conditionally, repeatable: [0..*]	Property name value pairs that are children to other properties. Only returned when the response is returned as a propertyValuesTree.
propertyValuesTree .childPropertyNameValue .childPropertyNameValue	PropertyNameValue	Conditionally, repeatable: [0..*]	Property name value pairs that are children to other properties. Only returned when the response is returned as a propertyValuesTree. Recursion: Whatever the depth of data returned, the deepest level does not include childPropertyNameValue.
propertyValuesTree .childPropertyNameValue .childPropertyNameValue .childPropertyNameValue	PropertyNameValue	Conditionally, repeatable: [0..*]	Property name value pairs that are children to other properties. Only returned when the response is returned as a propertyValuesTree. Recursion: Whatever the depth of data returned, the deepest level does not include childPropertyNameValue.
propertyValuesTree .childPropertyNameValue .childPropertyNameValue .propertyName	string	Conditionally	This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to.
propertyValuesTree .childPropertyNameValue .childPropertyNameValue.value	Value	Conditionally	A value for the property.
propertyValuesTree .childPropertyNameValue .childPropertyNameValue.value .number	NumericValue	Conditionally	For numeric value type.
propertyValuesTree .childPropertyNameValue .childPropertyNameValue.value .number.unitOfMeasurement	token	Conditionally	Unit of measure for a numeric value. Allowed values: bps Bits per second. A unit of data transmission. kbps Kilobits per second. A unit of data transmission. bit Binary digit. A unit of information storage. byte An ordered collection of bits. A unit of information storage equal to 8 bits in most contexts. kb Kilobit. A unit of information storage equal to 1024 bits. MB Megabyte. A unit of information storage equal to one million bytes. mW Megawatt. A unit of power equal to one million watts. W Watt. The base SI unit of power. Hz Hertz. A unit of frequency equal to one cycle per second. kHz Kilohertz. A unit of frequency equal to 1,000 cycles per second. m Meter. The base unit of distance. mm Megameter. A unit of distance equal to one million meters. rph Revolutions per hour. A unit of frequency. hr Hour. A unit of time equal to 3,600 seconds. min Minute. A unit of time equal to 60 seconds. ms Microsecond. A unit of time equal to one millionth of a second. ns Nanosecond. A unit of time equal to 10^-9 seconds. sec Seconds. The base unit of time. g Grams. A unit of mass equal to one one-thousandth of the SI base unit, the kilogram. lbs Pounds. The base Imperial unit of mass. The allowed units of measure do not apply to all numeric values. For example, when specifying the number of doors, unitOfMeasurement is not needed.
propertyValuesTree .childPropertyNameValue .childPropertyNameValue.value .number.value	string	Conditionally	A number value.
propertyValuesTree .childPropertyNameValue .childPropertyNameValue.value .text	StringValue	Conditionally	For string value type.
propertyValuesTree .childPropertyNameValue .childPropertyNameValue.value .text.value	string	Conditionally	A string value.
propertyValuesTree .childPropertyNameValue .childPropertyNameValue.value .URL	URIValue	Conditionally	For URL value type.
propertyValuesTree .childPropertyNameValue .childPropertyNameValue.value .URL.value	anyURI	Conditionally	As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay.
propertyValuesTree .childPropertyNameValue .propertyName	string	Conditionally	This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to.
propertyValuesTree .childPropertyNameValue.value	Value	Conditionally	A value for the property.
propertyValuesTree .childPropertyNameValue.value .number	NumericValue	Conditionally	For numeric value type.
propertyValuesTree .childPropertyNameValue.value .number.unitOfMeasurement	token	Conditionally	Unit of measure for a numeric value. Allowed values: bps Bits per second. A unit of data transmission. kbps Kilobits per second. A unit of data transmission. bit Binary digit. A unit of information storage. byte An ordered collection of bits. A unit of information storage equal to 8 bits in most contexts. kb Kilobit. A unit of information storage equal to 1024 bits. MB Megabyte. A unit of information storage equal to one million bytes. mW Megawatt. A unit of power equal to one million watts. W Watt. The base SI unit of power. Hz Hertz. A unit of frequency equal to one cycle per second. kHz Kilohertz. A unit of frequency equal to 1,000 cycles per second. m Meter. The base unit of distance. mm Megameter. A unit of distance equal to one million meters. rph Revolutions per hour. A unit of frequency. hr Hour. A unit of time equal to 3,600 seconds. min Minute. A unit of time equal to 60 seconds. ms Microsecond. A unit of time equal to one millionth of a second. ns Nanosecond. A unit of time equal to 10^-9 seconds. sec Seconds. The base unit of time. g Grams. A unit of mass equal to one one-thousandth of the SI base unit, the kilogram. lbs Pounds. The base Imperial unit of mass. The allowed units of measure do not apply to all numeric values. For example, when specifying the number of doors, unitOfMeasurement is not needed.
propertyValuesTree .childPropertyNameValue.value .number.value	string	Conditionally	A number value.
propertyValuesTree .childPropertyNameValue.value .text	StringValue	Conditionally	For string value type.
propertyValuesTree .childPropertyNameValue.value .text.value	string	Conditionally	A string value.
propertyValuesTree .childPropertyNameValue.value .URL	URIValue	Conditionally	For URL value type.
propertyValuesTree .childPropertyNameValue.value .URL.value	anyURI	Conditionally	As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay.
propertyValuesTree .propertyName	string	Conditionally	This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to.
propertyValuesTree.value	Value	Conditionally	A value for the property.
propertyValuesTree.value .number	NumericValue	Conditionally	For numeric value type.
propertyValuesTree.value .number.unitOfMeasurement	token	Conditionally	Unit of measure for a numeric value. Allowed values: bps Bits per second. A unit of data transmission. kbps Kilobits per second. A unit of data transmission. bit Binary digit. A unit of information storage. byte An ordered collection of bits. A unit of information storage equal to 8 bits in most contexts. kb Kilobit. A unit of information storage equal to 1024 bits. MB Megabyte. A unit of information storage equal to one million bytes. mW Megawatt. A unit of power equal to one million watts. W Watt. The base SI unit of power. Hz Hertz. A unit of frequency equal to one cycle per second. kHz Kilohertz. A unit of frequency equal to 1,000 cycles per second. m Meter. The base unit of distance. mm Megameter. A unit of distance equal to one million meters. rph Revolutions per hour. A unit of frequency. hr Hour. A unit of time equal to 3,600 seconds. min Minute. A unit of time equal to 60 seconds. ms Microsecond. A unit of time equal to one millionth of a second. ns Nanosecond. A unit of time equal to 10^-9 seconds. sec Seconds. The base unit of time. g Grams. A unit of mass equal to one one-thousandth of the SI base unit, the kilogram. lbs Pounds. The base Imperial unit of mass. The allowed units of measure do not apply to all numeric values. For example, when specifying the number of doors, unitOfMeasurement is not needed.
propertyValuesTree.value .number.value	string	Conditionally	A number value.
propertyValuesTree.value.text	StringValue	Conditionally	For string value type.
propertyValuesTree.value.text .value	string	Conditionally	A string value.
propertyValuesTree.value.URL	URIValue	Conditionally	For URL value type.
propertyValuesTree.value.URL .value	anyURI	Conditionally	As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay.
timestamp	dateTime	Always	This value represents the date and time when eBay processed the request. This value is returned in GMT, the ISO 8601 date and time format (YYYY- MM- DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone.
treeFormat	boolean	Always	Indicates whether the response is flat or in a hierarchical tree format. Default: false.
version	string	Always	The release version that eBay used to process the request. Developer Technical Support may ask you for the version value if you work with them to troubleshoot issues. Note: The version in use is normally the latest release version, as specified in the release notes. Note that eBay releases the API to international sites about a week after the API version is released to the US site.

Samples

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

Change History

Change Date	Description
1.2.0 04/28/2010	sortOrder.propertyName, sortOrder.order (added): The sortOrder fields specify the order, ascending or descending, of property values returned for a specific property name.
1.1.0 03/03/2010	(added) New call.

categoryId	string	Required	Specifies the category from which you want to retrieve property values that can be used to search for products. If a specified category ID doesn't match an existing category for the site, eBay returns an invalid-category error message. To determine valid categories, use the Trading API GetCategories call. Max length: 10.
listFormatOnly	boolean	Optional	Return properties for a given catalog enabled category. We will throw an error if the category is not catalog enabled. Default: false.
propertyFilter	PropertyValue	Optional, repeatable: [0..*]	Constrains the output of values for the given PropertyLiteral (or group of properties) as per given ConstrainingPropertyLiteral:ConstrainingValueLiteral pair (or pairs) according to the respective dependency graph. AND-logic will be applied within the constraint.
propertyFilter.propertyName	string	Optional	This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to.
propertyFilter.value	Value	Optional, repeatable: [0..*]	A value for the property.
propertyFilter.value.number	NumericValue	Optional	For numeric value type.
propertyFilter.value.number .unitOfMeasurement	token	Optional	Unit of measure for a numeric value. Allowed values: bps Bits per second. A unit of data transmission. kbps Kilobits per second. A unit of data transmission. bit Binary digit. A unit of information storage. byte An ordered collection of bits. A unit of information storage equal to 8 bits in most contexts. kb Kilobit. A unit of information storage equal to 1024 bits. MB Megabyte. A unit of information storage equal to one million bytes. mW Megawatt. A unit of power equal to one million watts. W Watt. The base SI unit of power. Hz Hertz. A unit of frequency equal to one cycle per second. kHz Kilohertz. A unit of frequency equal to 1,000 cycles per second. m Meter. The base unit of distance. mm Megameter. A unit of distance equal to one million meters. rph Revolutions per hour. A unit of frequency. hr Hour. A unit of time equal to 3,600 seconds. min Minute. A unit of time equal to 60 seconds. ms Microsecond. A unit of time equal to one millionth of a second. ns Nanosecond. A unit of time equal to 10^-9 seconds. sec Seconds. The base unit of time. g Grams. A unit of mass equal to one one-thousandth of the SI base unit, the kilogram. lbs Pounds. The base Imperial unit of mass. The allowed units of measure do not apply to all numeric values. For example, when specifying the number of doors, unitOfMeasurement is not needed.
propertyFilter.value.number .value	string	Optional	A number value.
propertyFilter.value.text	StringValue	Optional	For string value type.
propertyFilter.value.text .value	string	Optional	A string value.
propertyFilter.value.URL	URIValue	Optional	For URL value type.
propertyFilter.value.URL.value	anyURI	Optional	As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay.
sortOrder	SortOrder	Optional, repeatable: [0..*]	Sort order for property values in the result set. You can sort by any of the searchable properties, such as Year, Make, or Model. If no sort order is specified then values are sorted in ascending order. Sorting can be applied only when the response is in list format (i.e., treeFormat in the response is false). For sorting, characters are compared at each position (i.e., first character, second character, etc.). When values are sorted in ascending order, numbers (0-9) sort before uppercase letters (A-Z), which sort before lowercase letters (a-z). For example, 268 precedes 3, CTS comes before Camry, and 911 comes before A3. Descending order is the opposite of ascending, with lowercase letters (z-a) before uppercase letters (Z-A) and numbers last (9-0).
sortOrder.order	OrderType	Optional	Order of the sort, either Ascending or Descending. Applicable values: Ascending Sorts results in ascending (low to high) order. Descending Sorts results in descending (high to low) order.
sortOrder.propertyName	string	Optional	Output can be sorted by one or more (for bulk calls) property names. You can look up valid values using either the getProductSearchNames call or the getCompatibilitySearchNames call.