eBay Product API Call Reference Version 1.4 Support     Knowledge Base     Forums     All Tutorials     All Code Samples Users Guide Call Reference Making an API Call Tutorials Release Notes

Call Index Field Index Enumeration Index Type Index Errors by Number Input Output Samples Change History User Notes

addProducts

Use this call to check the status of products you have previously submitted (with addProducts) for inclusion in the eBay catalog for a given category. addProducts is an asynchronous call. Although you will get an immediate response to indicate whether the call was successful or not, you will need to use this call to determine whether the submission has been approved or rejected. The approval process may take up to 6 hours.

See Product Creation for more information about when you should add a product to an eBay catalog, and how to do it.

Back to top

addProducts 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"?>
<addProductsRequest xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services">
  <!-- Call-specific Input Fields -->
  <addProductRequest> ProductSubmission (BaseServiceRequest)
    <categoryId> string </categoryId>
    <invocationId> string </invocationId>
    <media> Media
      <mediaIdentifier> MediaIdentifier
        <url> string </url>
      </mediaIdentifier>
      <mediaType> MediaType </mediaType>
    </media>
    <!-- ... more media nodes allowed here ... -->
    <productPropertyValue> 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 ... -->
    </productPropertyValue>
    <!-- ... more productPropertyValue nodes allowed here ... -->
  </addProductRequest>
  <!-- ... more addProductRequest nodes allowed here ... -->
  <clientBatchId> string </clientBatchId>
</addProductsRequest>

Back to top

addProducts 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"?>
<addProductsResponse xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services">
  <!-- Call-specific Output Fields -->
  <addProductResponse> AddProductResponse (BaseServiceResponse)
    <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>
    <invocationId> string </invocationId>
    <status> ProductSubmissionStatus
      <ePID> string </ePID>
      <!-- ... more ePID values allowed here ... -->
      <productSubmissionId> string </productSubmissionId>
      <statusCode> ProductSubmissionStatusCode </statusCode>
      <statusReasonCode> ProductSubmissionStatusReasonCode (string) </statusReasonCode>
      <statusReasonDetail> string </statusReasonDetail>
    </status>
    <timestamp> dateTime </timestamp>
    <version> string </version>
  </addProductResponse>
  <!-- ... more addProductResponse nodes allowed here ... -->
  <clientBatchId> string </clientBatchId>
  <!-- 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>
</addProductsResponse>

Back to top

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

Submits a product for inclusion into the eBay catalog.

Description

To improve the finding experience for buyers, eBay is requiring sellers to list with the eBay catalog in selected categories, such as Electronics. If the seller's item matches a product in the eBay catalog, the seller must list with the product by supplying a supported product ID, such as an ePID, a UPC, or a ProductID that corresponds to the catalog product.

If the seller cannot find a match in eBay's product catalog, he can use addProducts to add the product.

Input

The product request must include the category ID (categoryId), and one or more product property name value pairs (addProductRequest.productPropertyValue.propertyName and addProductRequest.productPropertyValue.value) to describe the product. Retrieve compatibility search values for vehicle model (propertyName set to Model) from the Other Parts category (categoryId set to 6763). Limit the results to models for Honda make vehicles only (propertyFilter.propertyName set to Make and propertyFilter.value.text.value set to Honda).

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

<?xml version="1.0" encoding="UTF-8"?>
<addProductsRequest xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services">
   <addProductRequest>
      <invocationId>0123456789</invocationId>
      <categoryId>156955</categoryId>
      <productPropertyValue>
         <propertyName>Title</propertyName>
         <value>
            <text>
               <value>Long description </value>
            </text>
         </value>
      </productPropertyValue>
      <productPropertyValue>
         <propertyName>Brand</propertyName>
         <value>
            <text>
               <value>Belkin</value>
            </text>
         </value>
      </productPropertyValue>
      <productPropertyValue>
         <propertyName>Model</propertyName>
         <value>
            <text>
               <value>Belkin456</value>
            </text>
         </value>
      </productPropertyValue>
      <productPropertyValue>
         <propertyName>SKU</propertyName>
         <value>
            <text>
               <value>BelkSKUin123</value>
            </text>
         </value>
      </productPropertyValue>
      <productPropertyValue>
         <propertyName>GPS_Devices_GPS_Type</propertyName>
         <value>
            <text>
               <value>Automobile</value>
            </text>
         </value>
      </productPropertyValue>
      <productPropertyValue>
         <propertyName>GPS_Devices_Form_Factor</propertyName>
         <value>
            <text>
               <value>Logi1</value>
            </text>
         </value>
         <value>
            <text>
               <value>Logi2</value>
            </text>
         </value>
      </productPropertyValue>
      <productPropertyValue>
         <propertyName/>
         <value>
            <number>
               <value>2536</value>
               <unitOfMeasurement/>
            </number>
         </value>
      </productPropertyValue>
      <media>
         <mediaIdentifier>
            <url>http://www.botany.com/img/plants/dictionary-plants-flowers.jpg</url>
         </mediaIdentifier>
         <mediaType>Image</mediaType>
      </media>
   </addProductRequest>
   <clientBatchId>54321</clientBatchId>
</addProductsRequest>

Output

The response defaults to a tree format, in which each child property specifies a model name (e.g., (propertyValuesTree.childPropertyNameValue.value.text.value is Accord).

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

<addProductsResponse xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services">
   <ack>Success</ack>
   <errorMessage/>
   <version>1.3.1</version>
   <timestamp>2011-05-02T20:14:22.569Z</timestamp>
   <addProducResponse>
      <errorMessage/>
      <invocationId>0123456789</invocationId>
      <status>
         <productSubmissionId>5000102408</productSubmissionId>
         <statusCode>Pending</statusCode>
      </status>
   </addProducResponse>
   <clientBatchId>54321</clientBatchId>
</addProductsResponse>

Back to top

addProducts Change History

Back to top

User-Contributed Notes

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