Listing Compatible Parts


The AddItem family of calls allows you to list with parts compatibility in the following ways:

The following sections are covered here:

Use GetItem to confirm the number of compatibilities specified for a given listing (Item.ItemCompatibilityCount), or to retrieve all parts compatibility details for the item (Item.ItemCompatibilityList). For details, see Specifying Parts Compatibility Manually.

Specifying Parts Compatibility by Product

The easiest way to list an item with parts compatibility is to list with an eBay catalog product that has compatibilities.

To list an item with parts compatibility using a catalog product:

  1. Call findProducts in the Product API to locate your product and its eBay Product ID (ePID).

    The ePID value is used as input to AddItem to list your item by product. The findProducts call lets you search by keywords (keywords) and/or you can specify product filters (propertyFilter) to refine your results.

    The following request and response samples show how to find a product and its ePID.

    Figure: findProducts request with keywords and propertyFilter
    <?xml version="1.0" encoding="UTF-8"?>
    <findProductsRequest xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/
    services">
      <productSearch>
        <invocationId>1234567890</invocationId>
        <categoryId>33707</categoryId>
        <keywords>headlight</keywords>
        <propertyFilter>
          <propertyName>Supplier Name</propertyName>
          <value>
            <text>
              <value>Maxzone Auto Parts</value>
            </text>
          </value>
        </propertyFilter>
      </productSearch>
    </findProductsRequest>
    
    Figure: findProducts response, showing ePID
    <findProductsResponse xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services">
      <ack>Success</ack>
      <version>1.3.0</version>
      <timestamp>2010-04-28T02:29:30.796Z</timestamp>
      <productSearchResult>
        <products>
          <productIdentifier>
            <ePID>81391542</ePID>
            <productId>110562:2:2106:3215887382:238213712:3796824651c739bf59ecdd19a0f833b6:1:1:1:1400646370</productId>
          </productIdentifier>
          <productDetails>
            <propertyName>Type</propertyName>
            <value>
              <text>
                <value>Sealed Beams, Lamps, Flashers, Fuses</value>
              </text>
            </value>
          </productDetails>
          ...
        </products>
        <paginationOutput>
          <pageNumber>1</pageNumber>
          <entriesPerPage>20</entriesPerPage>
          <totalPages>78</totalPages>
          <totalEntries>1547</totalEntries>
        </paginationOutput>
        <invocationId>1234567890</invocationId>
      </productSearchResult>
    </findProductsResponse>
    

  2. Call getProductCompatibilities in the Product API to confirm the parts compatibilities for the product.

    The following getProductCompatibilities request and response indicate the eBay catalog product with ePID value 74311312 does have compatibilities.

    Figure: getProductCompatibilities request, Ford make vehicles only
    <getProductCompatibilitiesRequest xmlns="http://www.ebay.com/marketplace/
    marketplacecatalog/v1/services">
      <productIdentifier>
        <ePID>74311312</ePID>
      </productIdentifier>
      <applicationPropertyFilter>
        <propertyName>Make</propertyName>
        <value>
          <text>
            <value>Ford</value>
          </text>
        </value>
      </applicationPropertyFilter>
      <sortOrder>
        <sortOrder>
          <propertyName>Model</propertyName>
          <order>Ascending</order>
        </sortOrder>
        <sortPriority>Sort1</sortPriority>
      </sortOrder>
    </getProductCompatibilitiesRequest>
    
    Figure: getProductCompatibilities response
    <getProductCompatibilitiesResponse xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services">
      <ack>Success</ack>
      <version>1.3.0</version>
      <timestamp>2010-04-28T02:48:08.129Z</timestamp>
      <paginationOutput>
        <pageNumber>1</pageNumber>
        <entriesPerPage>20</entriesPerPage>
        <totalPages>3</totalPages>
        <totalEntries>48</totalEntries>
      </paginationOutput>
      <compatibilityDetails>
        <productDetails>
          <propertyName>Engine</propertyName>
          <value>
            <text>
              <value>5.4L 330Cu. In. V8 GAS SOHC Naturally Aspirated</value>
            </text>
          </value>
        </productDetails>
        ...
        <notes>
          <noteDetails>
            <propertyName>Relation Per Car Quantity</propertyName>
            <value>
              <text>
                <value>1</value>
              </text>
            </value>
          </noteDetails>
        </notes>
      </compatibilityDetails>
      ...
    </getProductCompatibilitiesResponse>
    

  3. Use AddItem (or a related listing call) to list your item using the product.

    The ePID value from the findProducts call is plugged into the ProductReferenceID field (ProductListingDetails.ProductReferenceID) in the AddItem request.

    Figure: AddItem request, listing by product
    <?xml version="1.0" encoding="utf-8"?>
    <AddItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
      <RequesterCredentials>
        <eBayAuthToken>ABC...123</eBayAuthToken>
      </RequesterCredentials>
      <Item>
        ...
        <PrimaryCategory>
          <CategoryID>33708</CategoryID>
        </PrimaryCategory>
        <ProductListingDetails>
          <ProductReferenceID>81391542</ProductReferenceID>
          <IncludePrefilledItemInformation>true</IncludePrefilledItemInformation>
        </ProductListingDetails>
        ...
      </Item>
    </AddItemRequest>
    
    Figure: AddItem response, listing by product
    <AddItemResponse xmlns="urn:ebay:apis:eBLBaseComponents">
       <Timestamp>2010-04-28T05:19:48.152Z</Timestamp>
       <Ack>Success</Ack>
       <Version>665</Version>
       <Build>E665_CORE_BUNDLED_11079705_R1</Build>
       <ItemID>110045056625</ItemID>
       <StartTime>2010-04-28T05:19:47.355Z</StartTime>
       <EndTime>2010-05-05T05:19:47.355Z</EndTime>
       <Fees>
          ...
          <Fee>
             <Name>ListingFee</Name>
             <Fee currencyID="USD">0.5</Fee>
          </Fee>
          ...
       </Fees>
    </AddItemResponse>
    

See Retrieving Parts Compatibilities for Listed Items for information about confirming your parts compatibilities.

Specifying Parts Compatibility Manually

Manual parts compatibility is used when your part does not correspond to a catalog product in the compatibility-enabled category in which you want to list.

Relationships between parts and products can be specified manually in the following ways:

Manual Parts Compatibility by Specification

When you list an item with parts compatibility by specification, use item specifics (Item.ItemSpecifics) to specify the part's relevant dimensions and characteristics. These specifications match the part with compatible applications. For example, when listing tires, the parts compatibility is specified by describing the tire's dimensions (e.g., Section Width, Aspect Ratio, Rim Diameter, Load Index, and Speed Rating for a tire) using item specifics.

To manually specify parts compatibility by specification:

  1. Call GetCategoryFeatures to determine if the category supports compatibility by specification.

    See Parts Compatibility Supported Categories for information on how to check if a category supports parts compatibility.

  2. Call GetCategorySpecifics to look up the item specifics that apply to the part you are listing.

    Parts compatibility by specification is supported in categories for products like rims and tires. For example:

    Rims require item specifics for the following dimensions or characteristics, at a minimum, to list with parts compatibility:

    • Bolt Pattern
    • Offset
    • Rim Diameter
    • Rim Width

    Tires require item specifics for the following dimensions or characteristics, at a minimum, to list with parts compatibility:

    • Aspect Ratio
    • Load Index
    • Rim Diameter
    • Section Width
    • Speed Index

  3. List your part, using item specifics to specify the parts compatibility details.

See Retrieving Parts Compatibilities for Listed Items for information about confirming your parts compatibilities. For information about listing with item specifics, see Working with Custom Item Specifics and Listing with Recommended Item Specific Names and Values.

Manual Parts Compatibility by Application

List parts compatibility by specifying the part's relevant dimensions and characteristics (e.g., Section Width, Aspect Ratio, Rim Diameter, Load Index, and Speed Rating for a tire) using item specifics (Item.ItemSpecifics).

Note: The Product API and Product Metadata API are required to determine which products support parts compatibility. Similarly, additional APIs are required to look up the property names and values for specifying what assembly (vehicle) a part applies.

To manually specify parts compatibility by application:

  1. Call GetCategoryFeatures to determine if the category supports compatibility by application.

    See Parts Compatibility Supported Categories for more information on identifying categories that support parts compatibility by application.

  2. Call getCompatibilitySearchNames in the Product Metadata API to get the property names needed to list compatibilities.

    Set the dataset field value to "Searchable" to retrieve property names that can be used to search for corresponding values. Note the propertyName values in the response. The displaySequence values indicate the hierarchy of the data. For example, Engine is subordinate to Trim, which is subordinate to Model, and so on.

    Figure: getCompatibilitySearchNames request for category 33707
    <?xml version="1.0" encoding="UTF-8"?>
    <getCompatibilitySearchNamesRequest xmlns="http://www.ebay.com/marketplace/
    marketplacecatalog/v1/services">
      <categoryId>33707</categoryId>
      <dataset>Searchable</dataset>
    </getCompatibilitySearchNamesRequest>
    
    Figure: getCompatibilitySearchNames response for category 33707
    <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.1.0</version>
      <timestamp>2010-04-28T18:24:51.737Z</timestamp>
      <categoryId>33707</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>
    

  3. Call getCompatibilitySearchValues with names from the preceding step to complete the name-value pairs that will make up a compatibility.

    To list with parts compatibility by application, you must include valid Year, Make, and Model values for a given application. Optionally, you can include Trim and Engine values.

    1. Call getCompatibilitySearchValues to retrieve compatibility search values for Year.
    2. Make the call to retrieve compatibility search values for Make (see the following example).
    3. Make the call to retrieve compatibility search values for Model. Use a property filter for Make to retrieve the models for a specific make (see the following example).
    4. Optionally, make the call to retrieve compatibility search values for Trim and Engine:
      Figure: getCompatibilitySearchValues request for Makes
      <?xml version="1.0" encoding="UTF-8"?>
      <getCompatibilitySearchValuesRequest xmlns="http://www.ebay.com/marketplace/
      marketplacecatalog/v1/services">
        <categoryId>33707</categoryId>
        <listFormatOnly>true</listFormatOnly>
        <propertyName>Make</propertyName>
      </getCompatibilitySearchValuesRequest>
      
      Figure: getCompatibilitySearchValues response for Makes
      <getCompatibilitySearchValuesResponse xmlns="http://www.ebay.com/marketplace/
      marketplacecatalog/v1/services">
        <ack>Success</ack>
        <version>1.1.0</version>
        <timestamp>2010-04-28T18:49:44.639Z</timestamp>
        <metadataVersion>4</metadataVersion>
        <propertyValues>
          <propertyName>Make</propertyName>
          <value>
            <text>
              <value>AC</value>
            </text>
          </value>
        </propertyValues>
        <propertyValues>
          <propertyName>Make</propertyName>
          <value>
            <text>
              <value>AM General</value>
            </text>
          </value>
        </propertyValues>
        <propertyValues>
          <propertyName>Make</propertyName>
          <value>
            <text>
              <value>Abarth</value>
            </text>
          </value>
        </propertyValues>
      
        <propertyValues>
          <propertyName>Make</propertyName>
          <value>
            <text>
              <value>Acura</value>
            </text>
          </value>
        </propertyValues>
        ...
        <propertyValues>
          <propertyName>Make</propertyName>
          <value>
            <text>
              <value>Yugo</value>
            </text>
          </value>
        </propertyValues>
        <propertyValues>
          <propertyName>Make</propertyName>
          <value>
            <text>
              <value>Zundapp</value>
            </text>
          </value>
        </propertyValues>
        <treeFormat>false</treeFormat>
      </getCompatibilitySearchValuesResponse>
      
      Figure: getCompatibilitySearchValues request for models with a property filter for Make
      <?xml version="1.0" encoding="UTF-8"?>
      <getCompatibilitySearchValuesRequest xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services">
        <categoryId>33707</categoryId>
        <propertyFilter>
          <propertyName>Make</propertyName>
          <value>
            <text>
              <value>Acura</value>
            </text>
          </value>
        </propertyFilter>
        <listFormatOnly>true</listFormatOnly>
        <propertyName>Model</propertyName>
      </getCompatibilitySearchValuesRequest>
      

  4. List your part with an ItemCompatibilityList, consisting of name-value pairs (e.g., Year and 2007, Make and Acura, and Model and TL) that describe the compatibilities.

    The following ItemCompatibilityList can be used all calls in the AddItem family, including ReviseItem and the fixed-prices calls.

    Note: If ItemCompatibilityList contains a Compatibility with an invalid combination of name-value pairs, the invalid compatibility will be reported in the Errors node of the response. As long as ItemCompatibilityList contains at least one valid Compatibility, the call will succeed and the listing will include all valid item compatibilities. If ItemCompatibilityList contains no valid Compatibility, the call will fail.
    Figure: ItemCompatibilityList
       ...
       <Item>
          <ItemCompatibilityList>
             <Compatibility>
            <NameValueList>
              <Name>Year</Name>
              <Value>2006</Value>
            </NameValueList>
            <NameValueList>
              <Name>Make</Name>
              <Value>Acura</Value>
            </NameValueList>
            <NameValueList>
              <Name>Model</Name>
              <Value>TL</Value>
            </NameValueList>
            <CompatibilityNotes>Fits for all trims and engines.</CompatibilityNotes>
          </Compatibility>
          <Compatibility>
            <NameValueList>
              <Name>Year</Name>
              <Value>2007</Value>
            </NameValueList>
            <NameValueList>
              <Name>Make</Name>
              <Value>Acura</Value>
            </NameValueList>
            <NameValueList>
              <Name>Model</Name>
              <Value>TL</Value>
            </NameValueList>
            <CompatibilityNotes>Fits for all trims and engines.</CompatibilityNotes>
          </Compatibility>
          <Compatibility>
            <NameValueList>
              <Name>Year</Name>
              <Value>2008</Value>
            </NameValueList>
            <NameValueList>
              <Name>Make</Name>
              <Value>Acura</Value>
            </NameValueList>
            <NameValueList>
              <Name>Model</Name>
              <Value>TL</Value>
            </NameValueList>
            <CompatibilityNotes>Fits for all trims and engines.</CompatibilityNotes>
          </Compatibility>
          <Compatibility>
            <NameValueList>
              <Name>Year</Name>
              <Value>2009</Value>
            </NameValueList>
            <NameValueList>
              <Name>Make</Name>
              <Value>Acura</Value>
            </NameValueList>
            <NameValueList>
              <Name>Model</Name>
              <Value>TL</Value>
            </NameValueList>
            <CompatibilityNotes>Fits for all trims and engines.</CompatibilityNotes>
          </Compatibility>
        </ItemCompatibilityList>
      </Item>
       ...
    

See Retrieving Parts Compatibilities for Listed Items for information about confirming your parts compatibilities.

Manual Parts Compatibility by K type

The eBay Australia , Germany, and United Kingdom sites (site IDs 15, 77, and 3, respectively), let you manually specify parts compatibility using a K type vehicle specification number (e.g., 25456).

K type vehicle number provide the best accuracy when specifying vehicle item compatibilities, a K type vehicle number includes the corresponding item compatibility for the make, model, platform, type, engine, and production period of the vehicle. For example, the K type vehicle number "25456" specifies the following vehicle information:

To manually specify parts compatibility using a K type vehicle number:

  1. Identify the K type vehicle number that corresponds to the products (vehicles) to which your part is compatible.

    K type is a vehicle specification numbering system provided by TecDoc Information Systems. For more information about TecDoc and the K type numbering system, see the TecDoc Portal.

  2. List your part with an ItemCompatibilityList, consisting of name-value pairs for each K type vehicle number that applies.

    The following example ItemCompatibilityList can be used in all the AddItem family of calls, including ReviseItem and the fixed-prices calls. Set the Name field to "KType" (the value is not case sensitive) and Value field to the corresponding K type vehicle number.

    Figure: Specifying parts compatibility using a K type number
    <ItemCompatibilityList>
      <Compatibility>
        <NameValueList>
          <Name>KType</Name>
          <Value>27959</Value>
        </NameValueList>
        <CompatibilityNotes>Passt alle ordnungen.</CompatibilityNotes>
      </Compatibility>
    </ItemCompatibilityList>
    
Note: Note that if the ItemCompatibilityList contains a Compatibility with an invalid combination of name-value pairs, the invalid compatibility will be reported in the Errors node of the response. However, as long as an ItemCompatibilityList contains at least one valid Compatibility name-value pair, the call will succeed and the listing will include all valid item compatibilities. If ItemCompatibilityList contains no valid Compatibility, the call will fail.

Manual Parts Compatibility by ePID

The eBay Germany and United Kingdom sites (site IDs 77 and 3, respectively) let you manually specify motorcycle and scooter parts compatibility using an eBay Product ID number (or ePID). Use the Master Motorcycle List (MML) for each site to obtain the ePID number(s) that correspond the items you want to list:

ePID numbers provide the best accuracy when listing motorcycle and scooter item compatibilities. When you specify an ePID, the number represents the item compatibility for the following vehicle values:

To manually specify parts compatibility using an ePID number:

  1. Identify the ePID number that corresponds to the products (vehicles) to which your part is compatible.

    ePID values are supplied by eBay in the Master Motorcycle List, or MML.

  2. List your parts with an ItemCompatibilityList, which consists of name-value pairs for each ePID vehicle number that applies.
  3. For each ePID value, supply a NameValueList container with the Name field set to "Notes", and the corresponding Value field set to a value that describes part details.

    The following example ItemCompatibilityList can be used in all the AddItem family of calls, including ReviseItem and the fixed-prices calls. Set the Name field to "ePID" (the value is not case sensitive) and the Value field to the corresponding ePID value, as supplied in the MML.

    Figure: ItemCompatibilityList using ePID numbers
    <ItemCompatibilityList>
        <Compatibility>
            <NameValueList>
               <Name>ePID</Name>
               <Value>128653462</Value>
            </NameValueList>
            <NameValueList>
                <Name>Notes</Name>
                <Value>Your part notes.</Value>
            </NameValueList>
        </Compatibility>
        <Compatibility>
            <NameValueList>
                <Name>ePID</Name>
                <Value>128652112</Value>
            </NameValueList>
            <NameValueList>
                <Name>Notes</Name>
                <Value>Your part notes.</Value>
            </NameValueList>
        </Compatibility>
        <Compatibility>
            <NameValueList>
                <Name>ePID</Name>
                <Value>124013777</Value>
            </NameValueList>
            <NameValueList>
                <Name>Notes</Name>
                <Value>Your part notes.</Value>
            </NameValueList>
        </Compatibility>
        <Compatibility>
            <NameValueList>
                <Name>ePID</Name>
                <Value>124036883</Value>
            </NameValueList>
            <NameValueList>
               <Name>Notes</Name>
               <Value>Your part notes.</Value>
            </NameValueList>
        </Compatibility>
    </ItemCompatibilityList>
    
Note: Note that if the ItemCompatibilityList contains a Compatibility with an invalid combination of name-value pairs, the invalid compatibility will be reported in the Errors node of the response. However, as long as an ItemCompatibilityList contains at least one valid Compatibility name-value pair, the call will succeed and the listing will include all valid item compatibilities. If ItemCompatibilityList contains no valid Compatibility, the call will fail.

Revising Parts Compatibilities for an Item

If you have listed an item in a category that supports parts compatibility by application, you can add or remove item compatibilities.

Note: You cannot add or remove compatibilities for items that were listed with a product.

Adding More Item Compatibilities

To add additional compatibilities, simply call ReviseItem (or comparable revise call that supports parts compatibility) and specify any new compatibilities with Item.ItemCompatibilityList. Duplicate compatibilities (Item.ItemCompatibilityList.Compatibility) are ignored.

Figure: ReviseItem request to add a compatibility
<?xml version="1.0" encoding="utf-8"?>
<ReviseItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <Item>
    <ItemID>110045128198</ItemID>
    <ItemCompatibilityList>
      <Compatibility>
        <NameValueList>
          <Name>Year</Name>
          <Value>2003</Value>
        </NameValueList>
        <NameValueList>
          <Name>Make</Name>
          <Value>Acura</Value>
        </NameValueList>
        <NameValueList>
          <Name>Model</Name>
          <Value>TL</Value>
        </NameValueList>
        <CompatibilityNotes>Fits for all trims and engines.</CompatibilityNotes>
      </Compatibility>
    </ItemCompatibilityList>
  </Item>
</ReviseItemRequest>

Removing Individual Item Compatibilities

To remove an item compatibility, call ReviseItem (or comparable revise call that supports parts compatibility) and specify the compatibility you want to remove. Include Delete with a value of true in the compatibility.

Figure: ReviseItem request to remove a compatibility
<?xml version="1.0" encoding="utf-8"?>
<ReviseItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <Item>
    <ItemID>110045128198</ItemID>
   <ItemCompatibilityList>
    <Compatibility>
      <Delete>true</Delete>
      <NameValueList>
       <Name>Year</Name>
       <Value>2003</Value>
      </NameValueList>
      <NameValueList>
       <Name>Make</Name>
       <Value>Acura</Value>
      </NameValueList>
      <NameValueList>
       <Name>Model</Name>
       <Value>TL</Value>
      </NameValueList>
      <CompatibilityNotes>Fits for all trims and engines.</CompatibilityNotes>
    </Compatibility>
   </ItemCompatibilityList>
  </Item>
</ReviseItemRequest>

Removing or Replacing All Item Compatibilities

To remove all compatibilities, call ReviseItem (or comparable revise call that supports parts compatibility) and set ReplaceAll (Item.ItemCompatibilityList.ReplaceAll) to true. If no new item compatibilities are specified, all item compatibilities are removed from the item. If new compatibilities are included with the ReplaceAll field, the new compatibilities will replace any existing item compatibilities.

Figure: ReviseItem request to remove all compatibilities
<?xml version="1.0" encoding="utf-8"?>
<ReviseItemRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <Item>
    <ItemID>110045128198</ItemID>
   <ItemCompatibilityList>
    <ReplaceAll>true</ReplaceAll>
   </ItemCompatibilityList>
  </Item>
</ReviseItemRequest>

See Retrieving Parts Compatibilities for Listed Items for information about confirming your parts compatibilities.

Retrieving Parts Compatibilities for Listed Items

When an item is listed with parts compatibility information, the compatibilities are displayed on the eBay site 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
Search for Items by Compatibility

Retrieving Compatibilities for Items Listed with Compatibilities by Application

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

Note: A GetItem request does not return compatibility information for items listed with parts capability using a K type vehicle number.
Figure: GetItem request, including item compatibilities
<?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>110045056625</ItemID>
  <IncludeItemCompatibilityList>true</IncludeItemCompatibilityList>
  <DetailLevel>ReturnAll</DetailLevel>
</GetItemRequest>
Figure: GetItem response, showing compatibilities
<GetItemResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2010-04-28T05:12:43.380Z</Timestamp>
  <Ack>Success</Ack>
  <Version>665</Version>
  <Build>E665_CORE_BUNDLED_11079705_R1</Build>
  <Item>
    ...
    <ItemID>110045056625</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>

Finding 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, Load Index, Rim Diameter, Section Width, and Speed Index. Use getProductSearchNames to retrieve valid property names for use in the specification field.

To constrain the result set, specify a compatibilityPropertyFilter.

Figure: findCompatibilitiesBySpecification request for tires
<?xml version="1.0" encoding="utf-8"?>
<findCompatibilitiesBySpecificationRequest xmlns="http://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>

Copyright © 2005–2016 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.