Retrieve parts compatibilities for listed items

When an item is listed with parts compatibility information, the compatibilities are displayed on the eBay marketplace in a Compatibility tab on the View Item page. This allows buyers to confirm compatibilities before purchasing an item.

Items listed with parts compatibility by application, either manually or with a product, automatically populate the table with applicable compatibilities, either with compatibilities that match the buyer's search or a complete, paginated list of compatibilities. Items listed with parts compatibility by specification, let you search for compatibilities, using the Year, Make, and Model dropdowns.

Figure: Search for items by compatibility

Retrieve compatibilities for items listed with compatibilities by application

To retrieve compatibilities for items that have had parts compatibilities specified manually by application, call GetItem with the IncludeItemCompatibilityList field set to true.

Request: Return item compatibility list with GetItem

<?xml version="1.0" encoding="utf-8"?>
<GetItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>AVC...123</eBayAuthToken>
  </RequesterCredentials>
  <ErrorLanguage>en_US</ErrorLanguage>
  <WarningLevel>High</WarningLevel>
  <Version>663</Version>
  <ItemID>1**********5</ItemID>
  <IncludeItemCompatibilityList>true</IncludeItemCompatibilityList>
  <DetailLevel>ReturnAll</DetailLevel>
</GetItemRequest>
		

Response: Item compatibility list in a GetItem

<GetItemResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2018-04-28T05:12:43.380Z</Timestamp>
  <Ack>Success</Ack>
  <Version>1067</Version>
  <Build>E1067_CORE_BUNDLED_11079705_R1</Build>
  <Item>
    ...
    <ItemID>1**********5</ItemID>
    ...
    <ItemCompatibilityList>
      <Compatibility>
        <NameValueList>
          <Name>Year</Name>
          <Value>2001</Value>
        </NameValueList>
        <NameValueList>
          <Name>Make</Name>
          <Value>Ford</Value>
        </NameValueList>
        <NameValueList>
          <Name>Model</Name>
          <Value>F-150</Value>
        </NameValueList>
        <NameValueList>
          <Name>Trim</Name>
          <Value>Harley-Davidson Edition Crew Cab Pickup 4-Door</Value>
        </NameValueList>
        <NameValueList>
          <Name>Engine</Name>
          <Value>5.4L 330Cu. In. V8 GAS SOHC Naturally Aspirated</Value>
        </NameValueList>
        <NameValueList/>
        <CompatibilityNotes>Relation Per Car Quantity:1&lt;br></CompatibilityNotes>
      </Compatibility>
      ...
    </ItemCompatibilityList>
  </Item>
</GetItemResponse>
		

Find compatibilities by specification

To find compatibilities for an item listed with parts compatibility by specification, call findCompatibilitiesBySpecification in the Product API. You must provide a specification for each of the dimensions or characteristics required to list the item.

For example, if you are searching for compatibilities for a tire, you must provide specification values for:

• Aspect Ratio (for sidewall)
• Load Index
• Rim Diameter
• Section Width
• Speed Index

Use getProductSearchNames to retrieve valid property names for use in the specification field.

To constrain the result set, specify a compatibilityPropertyFilter.

Request: findCompatibilitiesBySpecification for tires

<?xml version="1.0" encoding="utf-8"?>
<findCompatibilitiesBySpecificationRequest xmlns="https://www.ebay.com/marketplace/
marketplacecatalog/v1/services">
  <categoryId>170578</categoryId>
  <compatibilityPropertyFilter>
    <propertyName>Make</propertyName>
    <value>
      <text>
        <value>Honda</value>
      </text>
    </value>
  </compatibilityPropertyFilter>
  <compatibilityPropertyFilter>
    <propertyName>Model</propertyName>
    <value>
      <text>
        <value>Accord</value>
      </text>
    </value>
  </compatibilityPropertyFilter>
  <compatibilityPropertyFilter>
    <propertyName>Year</propertyName>
    <value>
      <text>
        <value>2006</value>
      </text>
    </value>
  </compatibilityPropertyFilter>
  <specification>
    <propertyName>Section Width</propertyName>
    <value>
      <text>
        <value>225.0</value>
      </text>
    </value>
  </specification>
  <specification>
    <propertyName>Aspect Ratio</propertyName>
    <value>
      <text>
        <value>45.0</value>
      </text>
    </value>
  </specification>
  <specification>
    <propertyName>Rim Diameter</propertyName>
    <value>
      <text>
        <value>18.0</value>
      </text>
    </value>
  </specification>
  <specification>
    <propertyName>Load Index</propertyName>
    <value>
      <text>
        <value>91.0</value>
      </text>
    </value>
  </specification>
  <specification>
    <propertyName>Speed Rating</propertyName>
    <value>
      <text>
        <value>H</value>
      </text>
    </value>
  </specification>
  <datasetPropertyName>Make</datasetPropertyName>
  <datasetPropertyName>Model</datasetPropertyName>
  <datasetPropertyName>Year</datasetPropertyName>
  <datasetPropertyName>Trim</datasetPropertyName>
  <datasetPropertyName>Engine</datasetPropertyName>
</findCompatibilitiesBySpecificationRequest>