eBay Product APIVersion 1.4.0

findCompatibilitiesBySpecification

Use this call to find all compatible applications for the provided specification. You can constrain the output further by specifiying the compatibility propertiesthat they are interested in.

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.



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"?>
<findCompatibilitiesBySpecificationRequest xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services">
  <!-- Call-specific Input Fields -->
  <categoryId> string </categoryId>
  <compatibilityPropertyFilter> PropertyValue
    <propertyName> string </propertyName>
    <value> Value
      <number> NumericValue
        <value> string </value>
      </number>
      <text> StringValue
        <value> string </value>
      </text>
      <URL> URIValue
        <value> anyURI </value>
      </URL>
    </value>
    <!-- ... more value nodes allowed here ... -->
  </compatibilityPropertyFilter>
  <!-- ... more compatibilityPropertyFilter nodes allowed here ... -->
  <dataSet> token </dataSet>
  <!-- ... more dataSet values allowed here ... -->
  <datasetPropertyName> string </datasetPropertyName>
  <!-- ... more datasetPropertyName values allowed here ... -->
  <exactMatch> boolean </exactMatch>
  <paginationInput> PaginationInput
    <entriesPerPage> int </entriesPerPage>
    <pageNumber> int </pageNumber>
  </paginationInput>
  <sortOrder> CompatibilitySort
    <sortOrder> SortOrder
      <order> OrderType </order>
      <propertyName> string </propertyName>
    </sortOrder>
    <sortPriority> SortPriority </sortPriority>
  </sortOrder>
  <!-- ... more sortOrder nodes allowed here ... -->
  <specification> PropertyValue
    <propertyName> string </propertyName>
    <value> Value
      <number> NumericValue
        <value> string </value>
      </number>
      <text> StringValue
        <value> string </value>
      </text>
      <URL> URIValue
        <value> anyURI </value>
      </URL>
    </value>
    <!-- ... more value nodes allowed here ... -->
  </specification>
  <!-- ... more specification nodes allowed here ... -->
</findCompatibilitiesBySpecificationRequest>
Argument Type Occurrence Meaning
categoryId string Optional Category ID for which we want to find out the compatibility details
compatibilityPropertyFilter PropertyValue Optional,
repeatable: [0..*]
This filter is used to restrict the number of compatible vehicles that can be returned. Properties that can be used here include Make, Model, Year and Trim
compatibilityPropertyFilter
  .propertyName
string Optional This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to.
compatibilityPropertyFilter
  .value
Value Optional,
repeatable: [0..*]
A value for the property.
compatibilityPropertyFilter
  .value.number
NumericValue Optional For numeric value type.
compatibilityPropertyFilter
  .value.number.value
string Optional A numeric value.
compatibilityPropertyFilter
  .value.text
StringValue Optional For string value type.
compatibilityPropertyFilter
  .value.text.value
string Optional A string value.
compatibilityPropertyFilter
  .value.URL
URIValue Optional For URL value type.
compatibilityPropertyFilter
  .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 Picture Services (EPS).
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.
User can either enter dataset name or enter individual property names (datasetPropertyName) from the dataset. Only one should be preset at a time.
datasetPropertyName string Optional,
repeatable: [0..*]
User can either enter dataset name or enter individual property names from the dataset. Only one should be preset at a time.
exactMatch boolean Optional For certain specification properties the compatibility is defined not by an exact match but by an expanded match on the input value by greater or lesser values as well. E.g For Load Index a compatible vehicle is the one which has a load index requirement which is less than or equal to the input. By default we will do an expanded compatibility match whenever it applies. However if you need to do only exact match then you can specify that using this input.
Default: false.
paginationInput PaginationInput Optional Controls the pagination of the result set. Child elements specify the maximum number of products to return per call and the page of data to return. Controls the number of products returned in the response, but does not specify the amount of data to return for each product.

Note: No more than 10,000 products can be retrieved for a given search, regardless of how many matches are found. This limit is enforced by the maximum page number allowed (100) and the maximum entries per page allowed (20).
paginationInput.entriesPerPage int Optional Specifies the maximum number of entries to return in a single call. If the number of entries found on the specified pageNumber is less than the value specified here, the number of items returned will be less than the value of entriesPerPage. This indicates the end of the result set.

If entriesPerPage is set to a number greater than 100, the default value, 100, will be used.
Max: 100. Default: 100.
paginationInput.pageNumber int Optional Specifies which subset of data (or "page") to return in the call response. The number of data pages is determined by the total number of items matching the request search criteria (returned in paginationOutput.totalEntries) divided by the number of entries to display in each response (entriesPerPage). You can return up to the first 100 pages of the result set by issuing multiple requests and specifying, in sequence, the pages to return.
Max: 100. Default: 1.
sortOrder CompatibilitySort Optional,
repeatable: [0..*]
Sort Order for the result set. Any of the searchable property can be used to specify the sort order. If no sort order is specified then default sort order(popularity descending) will be applied.
sortOrder.sortOrder SortOrder Optional The property with its associated sort order, ascending or descending.
sortOrder.sortOrder.order OrderType Optional Order of the sort, either Ascending or Descending.
Default: Descending.

Applicable values:

Ascending
The results will be sorted by the specified attribute in ascending (low to high) order.
Descending
The results will be sorted by the specified attribute in descending (high to low) order.

sortOrder.sortOrder
  .propertyName
string Optional Output can be sorted by one or more property names. You can look these values up using the getProductSearchNames call in the Product Metadata API.
sortOrder.sortPriority SortPriority Optional Indicates where in the sequence of ordering the property should ordered. There are five sorting steps, Sort1 through Sort5. When a property is assigned Sort1 as its sort priority, its values are sorted first. Values for the property assigned Sort2, are sorted second, and so on.

Applicable values:

Sort1
Specifies that the associated property should be sorted first.
Sort2
Specifies that the associated property should be sorted second.
Sort3
Specifies that the associated property should be sorted third.
Sort4
Specifies that the associated property should be sorted fourth.
Sort5
Specifies that the associated property should be sorted fifth.

specification PropertyValue Required,
repeatable: [1..*]
The specifications for which we need the compatibility. Examples include Aspect Ratio, Section Width etc.
specification.propertyName string Required This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to.
specification.value Value Required,
repeatable: [1..*]
A value for the property.
specification.value.number NumericValue Optional For numeric value type.
specification.value.number
  .value
string Optional A numeric value.
specification.value.text StringValue Optional For string value type.
specification.value.text.value string Optional A string value.
specification.value.URL URIValue Optional For URL value type.
specification.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 Picture Services (EPS).



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"?>
<findCompatibilitiesBySpecificationResponse xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services">
  <!-- Call-specific Output Fields -->
  <compatibilityDetails> CompatibilityDetails
    <compatibilityProperty> PropertyValue
      <propertyName> string </propertyName>
      <value> Value
        <number> NumericValue
          <value> string </value>
        </number>
        <text> StringValue
          <value> string </value>
        </text>
        <URL> URIValue
          <value> anyURI </value>
        </URL>
      </value>
      <!-- ... more value nodes allowed here ... -->
    </compatibilityProperty>
    <!-- ... more compatibilityProperty nodes allowed here ... -->
  </compatibilityDetails>
  <!-- ... more compatibilityDetails nodes allowed here ... -->
  <paginationOutput> PaginationOutput
    <entriesPerPage> int </entriesPerPage>
    <pageNumber> int </pageNumber>
    <totalEntries> int </totalEntries>
    <totalPages> int </totalPages>
  </paginationOutput>
  <!-- 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 nodes allowed here ... -->
      <severity> ErrorSeverity </severity>
      <subdomain> string </subdomain>
    </error>
    <!-- ... more error nodes allowed here ... -->
  </errorMessage>
  <timestamp> dateTime </timestamp>
  <version> string </version>
</findCompatibilitiesBySpecificationResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
compatibilityDetails CompatibilityDetails Always,
repeatable: [1..*]
List of compatibilties.
compatibilityDetails
  .compatibilityProperty
PropertyValue Always,
repeatable: [1..*]
Name-Value pairs for each compatiblility property.
compatibilityDetails
  .compatibilityProperty
  .propertyName
string Conditionally This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to.
compatibilityDetails
  .compatibilityProperty.value
Value Conditionally,
repeatable: [0..*]
A value for the property.
compatibilityDetails
  .compatibilityProperty.value
  .number
NumericValue Conditionally For numeric value type.
compatibilityDetails
  .compatibilityProperty.value
  .number.value
string Conditionally A numeric value.
compatibilityDetails
  .compatibilityProperty.value
  .text
StringValue Conditionally For string value type.
compatibilityDetails
  .compatibilityProperty.value
  .text.value
string Conditionally A string value.
compatibilityDetails
  .compatibilityProperty.value
  .URL
URIValue Conditionally For URL value type.
compatibilityDetails
  .compatibilityProperty.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 Picture Services (EPS).
paginationOutput PaginationOutput Always Sort Order for the result set. Any of the searchable property can be used to specify the sort order. If no sort order is specified then default sort order(popularity descending) will be applied.
paginationOutput
  .entriesPerPage
int Conditionally The maximum number of items that can be returned in the response. This number is always equal to the value input for paginationInput.entriesPerPage.

The end of the result set has been reached if the number specified for entriesPerPage is greater than the number of items found on the specified pageNumber. In this case, there will be fewer items returned than the number specified in entriesPerPage. This can be determined by comparing the entriesPerPage value with the value returned in the count attribute for the searchResult field.
paginationOutput.pageNumber int Conditionally The subset of item data returned in the current response. Search results are divided into sets, or "pages," of item data. The number of pages is equal to the total number of items matching the search criteria divided by the value specified for entriesPerPage in the request. The response for a request contains one "page" of item data.

This returned value indicates the page number of item data returned (a subset of the complete result set). If this field contains 1, the response contains the first page of item data (the default). If the value returned in totalEntries is less than the value for entriesPerPage, pageNumber returns 1 and the response contains the entire result set.

The value of pageNumber is normally equal to the value input for paginationInput.pageNumber. However, if the number input for pageNumber is greater than the total possible pages of output, eBay returns the last page of item data in the result set, and the value for pageNumber is set to the respective (last) page number.
paginationOutput.totalEntries int Conditionally The total number of items found that match the search criteria in your request. Depending on the input value for entriesPerPage, the response might include only a portion (a page) of the entire result set. A value of "0" is returned if eBay does not find any items that match the search criteria.
paginationOutput.totalPages int Conditionally The total number of pages of data that could be returned by repeated search requests. Note that if you modify the value of inputPagination.entriesPerPage in a request, the value output for totalPages will change. A value of "0" is returned if eBay does not find any items that match the search criteria.
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 was processed successfully, but something occurred that may affect your application or the user.
PartialFailure
The request that triggered the error was processed successfully but with some warnings.
Success
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.
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.

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.



Samples

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



Change History

Change Date Description
1.2.0
1/20/2010
  • (added) New call.