getCompatibilitySearchNames
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
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.
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).
Output Samples Change History |
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>
Argument | Type | Occurrence | Meaning |
---|
categoryId | string | Required |
Specifies the category from which you want to retrieve compatibility property names that can be used to search for products. Provide the interface category ID. For example, to get the cars properties, provide tires category ID. The category must be compatibility- enabled. If a specified category ID doesn't match an existing compatibility- enabled category for the site, eBay returns an error. To determine valid compatibility-enabled categories, use the Trading API GetCategoryFeatures call. Max length: 10. |
dataset | token | Optional,
repeatable: [0..*] |
This will define what are properties that will be returned for this catelog-enabled category.
Default: DisplayableSearchResults. |
Input Samples Change History |
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>
Return Value | Type | Occurrence | Meaning |
---|
Call-specific Output Fields [Jump to standard fields] |
categoryId | string | Always |
The category specified in the request. Max length: 10. |
properties | Properties | Always,
repeatable: [1..*] |
This contains all the properties for the specified category, as well as the dataset from which the properties are returned (e.g., DisplayableSearchResults). The properties container also includes the metatdata version associated with the most recent update of the properties. |
properties.dataset | token | Conditionally |
This will define what are properties that will be returned for this catelog-enabled category.
|
properties.metadataVersion | string | Conditionally | Version information reflects the latest update of the properties or values. |
properties.propertyName | Property | Conditionally,
repeatable: [0..*] |
This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. |
properties.propertyName .propertyDisplayName |
string | Conditionally | This will be the display name of the property |
properties.propertyName .propertyName |
string | Conditionally | This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to. |
properties.propertyName .propertyNameMetadata |
PropertyNameMetadata | Conditionally | Metadata for the property. |
properties.propertyName .propertyNameMetadata .displaySequence |
int | Conditionally | A numeric value indicating the ordering position for the property. |
Standard Output Fields |
ack | AckValue | Always |
Indicates whether or not errors or warnings were generated during the processing of the request.
Applicable values: |
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: |
errorMessage.error.domain | string | Conditionally |
Name of the domain in which the error occurred.
|
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: |
errorMessage.error.subdomain | string | Conditionally |
Name of the subdomain in which the error occurred.
|
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. |
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. |
Input Output Change History |
Samples
Code samples not yet added for this call's documentation.
Input Output Samples |
Change History
Change Date | Description |
---|---|
1.1.0 3/3/2010 |
|