getCompatibilitySearchDataVersion
Use this call to find the version and update time for compatibility search metadata of the specified category. Separate version and update time information is maintained for search names and search values. Use this call to check for changes when you retrieve and store compatibility search metadata locally.
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:
- getCompatibilitySearchNames - Returns all properties available for a given catalog enabled category.
- getCompatibilitySearchValues - Retrieves all available values and their dependencies for a given product property or a group of properties (of the product catalog).
- 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"?> <getCompatibilitySearchDataVersionRequest xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services"> <!-- Call-specific Input Fields --> <categoryId> string </categoryId> </getCompatibilitySearchDataVersionRequest>
Argument | Type | Occurrence | Meaning |
---|
categoryId | string | Required |
Specifies the category for which you want to retrieve version information about the product metadata. 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. |
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"?> <getCompatibilitySearchDataVersionResponse xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services"> <!-- Call-specific Output Fields --> <namesDetails> VersionDetails <updateTime> dateTime </updateTime> <version> string </version> </namesDetails> <valueDetails> VersionDetails <updateTime> dateTime </updateTime> <version> string </version> </valueDetails> <!-- 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> </getCompatibilitySearchDataVersionResponse>
Return Value | Type | Occurrence | Meaning |
---|
Call-specific Output Fields [Jump to standard fields] |
namesDetails | VersionDetails | Conditionally | Time and version for the most recent update of catalog property names for the specified category. |
namesDetails.updateTime | dateTime | Always | Indicates the date and time the current search metadata was updated. |
namesDetails.version | string | Always | Version number for the current search metadata (product or compatibility). If you are maintaining search metadata locally, compare this value to the version of the search metadata you last downloaded to determine whether the data may have changed. |
valueDetails | VersionDetails | Conditionally | Time and version for the most recent update of catalog property values for the specified category. |
valueDetails.updateTime | dateTime | Always | Indicates the date and time the current search metadata was updated. |
valueDetails.version | string | Always | Version number for the current search metadata (product or compatibility). If you are maintaining search metadata locally, compare this value to the version of the search metadata you last downloaded to determine whether the data may have changed. |
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 |
|