Product Metadata API1.3.0

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:

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:

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:

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:



Back to top

getCompatibilitySearchNames Input

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).

See also Samples.

<?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.
Dataset values:
DisplayableProductDetails
Properies for use in a user interface to describe products.
DisplayableSearchResults
Properties for use in results for product searches.
Searchable
Properties for use in searches.
Sortable
Properties that are suitable for sorting.

Default: DisplayableSearchResults.



Back to top

getCompatibilitySearchNames Output

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).

See also Samples.

<?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.
Dataset values:
DisplayableProductDetails
Properies for use in a user interface to describe products.
DisplayableSearchResults
Properties for use in results for product searches.
Searchable
Properties for use in searches.
Sortable
Properties that are suitable for sorting.
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:

•   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 The name of the input parameter returned with the error. Inspecting the parameter (or its input value) will often aid in understanding the cause of the error. Not all error messages contain this value.
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.


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.
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.



Back to top

getCompatibilitySearchNames Samples

New to making API calls? Please see Making an API Call.

Note: Some data in these samples might no longer be active. If necessary, you can substitute current data in your requests.

Sample: Basic Call

Retrieves the compatibility property names for describing a compatible product application in the given category.

Description

Retrive compatibility property names for use in searches to identify the property for which search values to retrieve and for use as filters for the associated result set. This sample retrieves compatibility search names from the eBay US Motors site (global ID EBAY-MOTOR).

Input

Retrieve compatibility search names that can be used in searches (dataset set to Searchable) from the Other Parts category (categoryId set to 6763).

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="UTF-8"?>
<getCompatibilitySearchNamesRequest xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services">
   <categoryId>6763</categoryId>
   <dataset>Searchable</dataset>
</getCompatibilitySearchNamesRequest>

Output

The response consists of an array of property name (propertyName) nodes containing the values for use in searches (propertyName.propertyName) along with their display name (if you are building a UI) and their ordering position (displaySequence) of each name.

XML format. Also available is the .txt version of this XML.

<getCompatibilitySearchNamesResponse xsi:type="GetProductSearchNamesResponse" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services">
   <ack>Success</ack>
   <version>1.2.0</version>
   <timestamp>2011-04-20T21:40:56.775Z</timestamp>
   <categoryId>6763</categoryId>
   <properties>
      <propertyName>
         <propertyName>Year</propertyName>
         <propertyNameMetadata>
            <displaySequence>1</displaySequence>
         </propertyNameMetadata>
         <propertyDisplayName>Year</propertyDisplayName>
      </propertyName>
      <propertyName>
         <propertyName>Make</propertyName>
         <propertyNameMetadata>
            <displaySequence>2</displaySequence>
         </propertyNameMetadata>
         <propertyDisplayName>Make</propertyDisplayName>
      </propertyName>
      <propertyName>
         <propertyName>Model</propertyName>
         <propertyNameMetadata>
            <displaySequence>3</displaySequence>
         </propertyNameMetadata>
         <propertyDisplayName>Model</propertyDisplayName>
      </propertyName>
      <propertyName>
         <propertyName>Trim</propertyName>
         <propertyNameMetadata>
            <displaySequence>4</displaySequence>
         </propertyNameMetadata>
         <propertyDisplayName>Trim</propertyDisplayName>
      </propertyName>
      <propertyName>
         <propertyName>Engine</propertyName>
         <propertyNameMetadata>
            <displaySequence>5</displaySequence>
         </propertyNameMetadata>
         <propertyDisplayName>Engine</propertyDisplayName>
      </propertyName>
      <dataset>Searchable</dataset>
   </properties>
</getCompatibilitySearchNamesResponse>



Back to top

getCompatibilitySearchNames Change History

Version Description
1.1.0
3/3/2010
  • (added) New call.

Back to top

User-Contributed Notes

 

Copyright © 2009–2014 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.