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

   findProducts request with keywords and propertyFilter

   <?xml version="1.0" encoding="UTF-8"?>
   <findProductsRequest xmlns="https://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>
   

   findProducts response, showing ePID

   <findProductsResponse xmlns="https://www.ebay.com/marketplace/marketplacecatalog/v1/services">
     <ack>Success</ack>
     <version>1.3.0</version>
     <timestamp>2018-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.

   getProductCompatibilities search for Ford vehicles

   <getProductCompatibilitiesRequest xmlns="https://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>
   					

   getProductCompatibilities response

   <getProductCompatibilitiesResponse xmlns="https://www.ebay.com/marketplace/marketplacecatalog/v1/services">
     <ack>Success</ack>
     <version>1.3.0</version>
     <timestamp>2018-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.

   Use AddItem to list item using eBay catalog 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>
   					

   AddItem response

   <AddItemResponse xmlns="urn:ebay:apis:eBLBaseComponents">
      <Timestamp>2018-04-28T05:19:48.152Z</Timestamp>
      <Ack>Success</Ack>
      <Version>1067</Version>
      <Build>E1067_CORE_BUNDLED_11079705_R1</Build>
      <ItemID>110045056625</ItemID>
      <StartTime>2018-04-28T05:19:47.355Z</StartTime>
      <EndTime>2018-05-05T05:19:47.355Z</EndTime>
      <Fees>
         ...
         <Fee>
            <Name>ListingFee</Name>
            <Fee currencyID="USD">0.5</Fee>
         </Fee>
         ...
      </Fees>
   </AddItemResponse>
   					

Refer to Retrieve parts compatibilities for listed items for additional information about confirming parts compatibilities.