eBay Merchant Data API API Reference Version 823 Support     Knowledge Base     Forums     All Tutorials     All Code Samples Users Guide API Reference Making an API Call Tutorials Release Notes

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

SoldReport

Lists all items that have been sold by this seller. If a buyer purchased multiple items from a single listing, the sale will result in a single Order ID for the total purchase with a separate Line Item ID for each of the purchased items. The SoldReport request returns the data for all of your new orders (newly-sold items) with Order ID and Order Line Item ID. The Sold Report includes all transactions for the past 30 days (from the transaction creation date).

Note: SoldReport cannot be issued on its own like an ordinary API call, using an endpoint. This Large Merchant Services call must be invoked as a parameter in a Bulk Data Exchange API call, which will produce a report that can be downloaded using a File Transfer API call. This call has no request type.

The concept of an 'Order' is only used in the Trading API when a buyer makes combined payments. Each payment is a transaction. But in the Large Merchant Services solution, every sale is considered to be an Order. It is important to recognize these conceptual differences when you are working with multiple APIs.

OrderLineItemID is a based upon the combination of the eBay Trading API's ItemID and TransactionID fields. The number before the hyphen is the Item ID and the number after the hyphen is the Transaction ID. The Transaction field in the Trading API is a container that can include many types of transaction information.

See Trading API for more information.

Sellers use the information in the SoldReport to make inventory updates and start order fulfillment.

Note: After release 637, a namespace is returned in the BulkDataExchangeResponseType (top level) of the response. This container is not shown in the call output description, but you can see it in the call samples at the end of this page. See Making An API Call for more information about the BulkDataExchange Response container.

Back to top

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

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

<?xml version="1.0" encoding="utf-8"?>
<SoldReportResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <OrderDetails> OrderDetailsType
    <BuyerEmail> string </BuyerEmail>
    <BuyerFirstName> string </BuyerFirstName>
    <BuyerLastName> string </BuyerLastName>
    <BuyerPhone> string </BuyerPhone>
    <BuyerStaticAlias> string </BuyerStaticAlias>
    <BuyerUserID> string </BuyerUserID>
    <CheckoutSiteID> int </CheckoutSiteID>
    <CheckoutStatus> CheckoutStatusType
      <eBayPaymentStatus> PaymentStatusCodeType </eBayPaymentStatus>
      <PaymentMethod> BuyerPaymentMethodCodeType </PaymentMethod>
      <Status> CompleteStatusCodeType </Status>
    </CheckoutStatus>
    <ExternalTransaction> ExternalTransactionType
      <ExternalTransactionID> string </ExternalTransactionID>
      <ExternalTransactionTime> dateTime </ExternalTransactionTime>
      <FeeOrCreditAmount> AmountType (double) </FeeOrCreditAmount>
      <PaymentOrRefundAmount> AmountType (double) </PaymentOrRefundAmount>
    </ExternalTransaction>
    <!-- ... more ExternalTransaction nodes allowed here ... -->
    <InsuranceCost> AmountType (double) </InsuranceCost>
    <OrderCreationTime> dateTime </OrderCreationTime>
    <OrderID> string </OrderID>
    <OrderItemDetails> OrderItemDetailsType
      <OrderLineItem> OrderLineItemType
        <ActualShippingCost> AmountType (double) </ActualShippingCost>
        <BuyerPaymentTransactionNumber> string </BuyerPaymentTransactionNumber>
        <InsuranceCost> AmountType (double) </InsuranceCost>
        <ItemID> ItemIDType (string) </ItemID>
        <ListingSiteID> int </ListingSiteID>
        <OrderLineItemID> string </OrderLineItemID>
        <PaymentClearedTime> dateTime </PaymentClearedTime>
        <QuantitySold> int </QuantitySold>
        <SalePrice> AmountType (double) </SalePrice>
        <SellingManagerSaleRecordID> int </SellingManagerSaleRecordID>
        <ShippingCost> AmountType (double) </ShippingCost>
        <SKU> SKUType (string) </SKU>
        <Status> TransactionStatusType
          <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
        </Status>
        <TaxAmount> AmountType (double) </TaxAmount>
        <TaxCategory> string </TaxCategory>
        <Taxes> TaxesType
          <TaxDetails> TaxDetailsType
            <Imposition> TaxTypeCodeType </Imposition>
            <TaxAmount> AmountType (double) </TaxAmount>
            <TaxDescription> TaxDescriptionCodeType </TaxDescription>
            <TaxOnHandlingAmount> AmountType (double) </TaxOnHandlingAmount>
            <TaxOnShippingAmount> AmountType (double) </TaxOnShippingAmount>
            <TaxOnSubtotalAmount> AmountType (double) </TaxOnSubtotalAmount>
          </TaxDetails>
          <!-- ... more TaxDetails nodes allowed here ... -->
          <TotalTaxAmount> AmountType (double) </TotalTaxAmount>
        </Taxes>
        <TotalCost> AmountType (double) </TotalCost>
        <UnpaidItem> UnpaidItemType
          <Status> UnpaidItemCaseStatusTypeCodeType </Status>
          <Type> UnpaidItemCaseOpenTypeCodeType </Type>
        </UnpaidItem>
        <Variation> MerchantDataVariationType
          <Price> AmountType (double) </Price>
          <Quantity> int </Quantity>
          <SellingStatus> MerchantDataSellingStatusType
            <QuantitySold> int </QuantitySold>
          </SellingStatus>
          <SKU> SKUType (string) </SKU>
          <VariationSpecifics> NameValueListArrayType
            <NameValueList> NameValueListType
              <Name> string </Name>
              <Value> string </Value>
              <!-- ... more Value values allowed here ... -->
            </NameValueList>
            <!-- ... more NameValueList nodes allowed here ... -->
          </VariationSpecifics>
        </Variation>
      </OrderLineItem>
      <!-- ... more OrderLineItem nodes allowed here ... -->
    </OrderItemDetails>
    <OrderTotalCost> AmountType (double) </OrderTotalCost>
    <PaymentClearedTime> dateTime </PaymentClearedTime>
    <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
    <SellingManagerSaleRecordID> int </SellingManagerSaleRecordID>
    <ShipCityName> string </ShipCityName>
    <ShipCountryName> token </ShipCountryName>
    <ShippingCost> AmountType (double) </ShippingCost>
    <ShippingService> string </ShippingService>
    <ShippingServiceToken> string </ShippingServiceToken>
    <ShipPostalCode> string </ShipPostalCode>
    <ShipRecipientName> string </ShipRecipientName>
    <ShipReferenceId> string </ShipReferenceId>
    <ShipStateOrProvince> string </ShipStateOrProvince>
    <ShipStreet1> string </ShipStreet1>
    <ShipStreet2> string </ShipStreet2>
    <TaxAmount> AmountType (double) </TaxAmount>
  </OrderDetails>
  <!-- ... more OrderDetails nodes allowed here ... -->
</SoldReportResponse>

Back to top

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

Lists the sold items for a specific seller ID (ID associated with the auth token) and returns an Order ID and Order Line Item ID for each item.

This sample represents a data file that you will download using the Bulk Data Exchange Service and File Transfer Service.

Description

User megaonlinemerchant wants to see a list of her sold eBay items. She sends a Bulk Data Exchange startDownloadJob request with the SoldReport parameter, uses a Bulk Data Exchange getJobStatus request to see if her report is ready to download, and then sends a File Transfer Service downloadJob request to retrieve the report data.

Input

Since a Large Merchant Services report returns a pre-determined set of elements, there is no input request for a report. Instead, the report type is specified as a parameter of a Bulk Data Exchange startDownloadJob call.

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

 
Do not send a request file for reports. See description above.

Output

The response returns Order or Line Item details for each sold item. Every time you receive a Sold Report it will contain all of the items that you have sold, unless you acknowledge each order or line item using an OrderAck request. After you acknowledge an order, it will no longer show up in your Sold Reports.

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

<?xml version="1.0" encoding="utf-8"?>
<BulkDataExchangeResponses xmlns="urn:ebay:apis:eBLBaseComponents">
  <SoldReport>
    <OrderDetails>
      <OrderID>110035808425-23344921001</OrderID>
      <BuyerUserID>430096</BuyerUserID>
      <BuyerFirstName>Sean</BuyerFirstName>
      <BuyerLastName>Brown</BuyerLastName>
      <BuyerEmail>test_user@company.com</BuyerEmail>
      <BuyerPhone>1-800-111-1111</BuyerPhone>
      <ShippingService>UPS Ground</ShippingService>
      <CheckoutSiteID>0</CheckoutSiteID>
      <OrderCreationTime>2008-11-25T16:57:46.000Z</OrderCreationTime>
      <TaxAmount currencyID="USD">0.00</TaxAmount>
      <InsuranceCost currencyID="USD">0.00</InsuranceCost>
      <ShippingCost currencyID="USD">0.00</ShippingCost>
      <OrderTotalCost currencyID="USD">100.00</OrderTotalCost>
      <OrderItemDetails>
        <OrderLineItem>
          <OrderLineItemID>110035808425-23344921001</OrderLineItemID>
          <ItemID>110035808425</ItemID>
          <SKU>1122334455-12-1</SKU>
          <QuantitySold>2</QuantitySold>
          <SalePrice currencyID="USD">50.00</SalePrice>
          <TaxAmount currencyID="USD">0.00</TaxAmount>
          <ShippingCost currencyID="USD">0.00</ShippingCost>
          <TotalCost currencyID="USD">100.00</TotalCost>
          <InsuranceCost currencyID="USD">0.00</InsuranceCost>
          <ListingSiteID>0</ListingSiteID>
          <SellingManagerSalesRecordID>103</SellingManagerSalesRecordID>
        </OrderLineItem>
      </OrderItemDetails>
    </OrderDetails>
    <OrderDetails>
      <OrderID>110035808425-23344920001</OrderID>
      <BuyerUserID>430096</BuyerUserID>
      <BuyerFirstName>Sean</BuyerFirstName>
      <BuyerLastName>Brown</BuyerLastName>
      <BuyerEmail>test_user@company.com</BuyerEmail>
      <BuyerPhone>1-800-111-1111</BuyerPhone>
      <ShippingService>UPS Ground</ShippingService>
      <CheckoutSiteID>0</CheckoutSiteID>
      <OrderCreationTime>2008-11-25T16:57:25.000Z</OrderCreationTime>
      <TaxAmount currencyID="USD">0.00</TaxAmount>
      <InsuranceCost currencyID="USD">0.00</InsuranceCost>
      <ShippingCost currencyID="USD">0.00</ShippingCost>
      <OrderTotalCost currencyID="USD">50.00</OrderTotalCost>
      <OrderItemDetails>
        <OrderLineItem>
          <OrderLineItemID>110035808425-23344920001</OrderLineItemID>
          <ItemID>110035808425</ItemID>
          <SKU>1122334455-12-1</SKU>
          <QuantitySold>1</QuantitySold>
          <SalePrice currencyID="USD">50.00</SalePrice>
          <TaxAmount currencyID="USD">0.00</TaxAmount>
          <ShippingCost currencyID="USD">0.00</ShippingCost>
          <TotalCost currencyID="USD">50.00</TotalCost>
          <InsuranceCost currencyID="USD">0.00</InsuranceCost>
          <ListingSiteID>0</ListingSiteID>
          <SellingManagerSalesRecordID>104</SellingManagerSalesRecordID>
        </OrderLineItem>
      </OrderItemDetails>
    </OrderDetails>
    <OrderDetails>
      <OrderID>110035808425-23344919001</OrderID>
      <BuyerUserID>430096</BuyerUserID>
      <BuyerFirstName>Sean</BuyerFirstName>
      <BuyerLastName>Brown</BuyerLastName>
      <BuyerEmail>test_user@company.com</BuyerEmail>
      <BuyerPhone>1-800-111-1111</BuyerPhone>
      <ShippingService>UPS Ground</ShippingService>
      <CheckoutSiteID>0</CheckoutSiteID>
      <OrderCreationTime>2008-11-25T16:57:13.000Z</OrderCreationTime>
      <TaxAmount currencyID="USD">0.00</TaxAmount>
      <InsuranceCost currencyID="USD">0.00</InsuranceCost>
      <ShippingCost currencyID="USD">0.00</ShippingCost>
      <OrderTotalCost currencyID="USD">50.00</OrderTotalCost>
      <OrderItemDetails>
        <OrderLineItem>
          <OrderLineItemID>110035808425-23344919001</OrderLineItemID>
          <ItemID>110035808425</ItemID>
          <SKU>1122334455-12-1</SKU>
          <QuantitySold>1</QuantitySold>
          <SalePrice currencyID="USD">50.00</SalePrice>
          <TaxAmount currencyID="USD">0.00</TaxAmount>
          <ShippingCost currencyID="USD">0.00</ShippingCost>
          <TotalCost currencyID="USD">50.00</TotalCost>
          <InsuranceCost currencyID="USD">0.00</InsuranceCost>
          <ListingSiteID>0</ListingSiteID>
          <SellingManagerSalesRecordID>105</SellingManagerSalesRecordID>
        </OrderLineItem>
      </OrderItemDetails>
    </OrderDetails>
    <OrderDetails>
      <OrderID>110035808513-23323318001</OrderID>
      <BuyerUserID>132943282</BuyerUserID>
      <BuyerFirstName>Test</BuyerFirstName>
      <BuyerLastName>User</BuyerLastName>
      <BuyerEmail>test_user@company.com</BuyerEmail>
      <BuyerPhone>1-800-111-1111</BuyerPhone>
      <ShippingService>NotSelected</ShippingService>
      <CheckoutSiteID>0</CheckoutSiteID>
      <OrderCreationTime>2008-11-20T17:45:35.000Z</OrderCreationTime>
      <TaxAmount currencyID="USD">0.00</TaxAmount>
      <InsuranceCost currencyID="USD">0.00</InsuranceCost>
      <ShippingCost currencyID="USD">0.00</ShippingCost>
      <OrderTotalCost currencyID="USD">50.00</OrderTotalCost>
      <OrderItemDetails>
        <OrderLineItem>
          <OrderLineItemID>110035808513-23323318001</OrderLineItemID>
          <ItemID>110035808513</ItemID>
          <SKU>1122334455-12-1</SKU>
          <QuantitySold>1</QuantitySold>
          <SalePrice currencyID="USD">50.00</SalePrice>
          <TaxAmount currencyID="USD">0.00</TaxAmount>
          <ShippingCost currencyID="USD">0.00</ShippingCost>
          <TotalCost currencyID="USD">50.00</TotalCost>
          <InsuranceCost currencyID="USD">0.00</InsuranceCost>
          <ListingSiteID>0</ListingSiteID>
          <SellingManagerSalesRecordID>106</SellingManagerSalesRecordID>
        </OrderLineItem>
      </OrderItemDetails>
    </OrderDetails>
    <OrderDetails>
      <OrderID>110035817938-23323316001</OrderID>
      <BuyerUserID>132943282</BuyerUserID>
      <BuyerFirstName>Test</BuyerFirstName>
      <BuyerLastName>User</BuyerLastName>
      <BuyerEmail>test_user@company.com</BuyerEmail>
      <BuyerPhone>1-800-111-1111</BuyerPhone>
      <ShippingService>NotSelected</ShippingService>
      <CheckoutSiteID>0</CheckoutSiteID>
      <OrderCreationTime>2008-11-20T17:42:52.000Z</OrderCreationTime>
      <TaxAmount currencyID="USD">0.00</TaxAmount>
      <InsuranceCost currencyID="USD">4.30</InsuranceCost>
      <ShippingCost currencyID="USD">0.00</ShippingCost>
      <OrderTotalCost currencyID="USD">110.00</OrderTotalCost>
      <OrderItemDetails>
        <OrderLineItem>
          <OrderLineItemID>110035817938-23323316001</OrderLineItemID>
          <ItemID>110035817938</ItemID>
          <SKU>1122334455-13</SKU>
          <QuantitySold>2</QuantitySold>
          <SalePrice currencyID="USD">55.00</SalePrice>
          <TaxAmount currencyID="USD">0.00</TaxAmount>
          <ShippingCost currencyID="USD">0.00</ShippingCost>
          <TotalCost currencyID="USD">110.00</TotalCost>
          <InsuranceCost currencyID="USD">4.30</InsuranceCost>
          <ListingSiteID>0</ListingSiteID>
          <SellingManagerSalesRecordID>107</SellingManagerSalesRecordID>
        </OrderLineItem>
      </OrderItemDetails>
    </OrderDetails>
    <OrderDetails>
      <OrderID>110035817828-23317658001</OrderID>
      <BuyerUserID>397681</BuyerUserID>
      <BuyerFirstName>TestLastName</BuyerFirstName>
      <BuyerLastName>TestFirstName</BuyerLastName>
      <BuyerEmail>test_user@company.com</BuyerEmail>
      <BuyerPhone>1-800-111-1111</BuyerPhone>
      <ShippingService>Expedited Int'l Flat Rate Shipping</ShippingService>
      <CheckoutSiteID>0</CheckoutSiteID>
      <OrderCreationTime>2008-11-18T22:21:12.000Z</OrderCreationTime>
      <TaxAmount currencyID="USD">0.00</TaxAmount>
      <InsuranceCost currencyID="USD">3.50</InsuranceCost>
      <ShippingCost currencyID="USD">15.20</ShippingCost>
      <OrderTotalCost currencyID="USD">23.70</OrderTotalCost>
      <OrderItemDetails>
        <OrderLineItem>
          <OrderLineItemID>110035817828-23317658001</OrderLineItemID>
          <ItemID>110035817828</ItemID>
          <SKU>cmg00002</SKU>
          <QuantitySold>1</QuantitySold>
          <SalePrice currencyID="USD">5.00</SalePrice>
          <TaxAmount currencyID="USD">0.00</TaxAmount>
          <ShippingCost currencyID="USD">15.20</ShippingCost>
          <TotalCost currencyID="USD">23.70</TotalCost>
          <InsuranceCost currencyID="USD">3.50</InsuranceCost>
          <ListingSiteID>0</ListingSiteID>
          <SellingManagerSalesRecordID>108</SellingManagerSalesRecordID>
        </OrderLineItem>
      </OrderItemDetails>
    </OrderDetails>
    <OrderDetails>
      <OrderID>110035808177-23317657001</OrderID>
      <BuyerUserID>397681</BuyerUserID>
      <BuyerFirstName>TestLastName</BuyerFirstName>
      <BuyerLastName>TestFirstName</BuyerLastName>
      <BuyerEmail>test_user@company.com</BuyerEmail>
      <BuyerPhone>1-800-111-1111</BuyerPhone>
      <ShippingService>NotSelected</ShippingService>
      <CheckoutSiteID>0</CheckoutSiteID>
      <OrderCreationTime>2008-11-18T22:16:34.000Z</OrderCreationTime>
      <TaxAmount currencyID="USD">0.00</TaxAmount>
      <InsuranceCost currencyID="USD">2.15</InsuranceCost>
      <ShippingCost currencyID="USD">0.00</ShippingCost>
      <OrderTotalCost currencyID="USD">50.00</OrderTotalCost>
      <OrderItemDetails>
        <OrderLineItem>
          <OrderLineItemID>110035808177-23317657001</OrderLineItemID>
          <ItemID>110035808177</ItemID>
          <SKU>1122334455-12</SKU>
          <QuantitySold>1</QuantitySold>
          <SalePrice currencyID="USD">50.00</SalePrice>
          <TaxAmount currencyID="USD">0.00</TaxAmount>
          <ShippingCost currencyID="USD">0.00</ShippingCost>
          <TotalCost currencyID="USD">50.00</TotalCost>
          <InsuranceCost currencyID="USD">2.15</InsuranceCost>
          <ListingSiteID>0</ListingSiteID>
          <SellingManagerSalesRecordID>109</SellingManagerSalesRecordID>
        </OrderLineItem>
      </OrderItemDetails>
    </OrderDetails>
    <OrderDetails>
      <OrderID>110035817827-23317655001</OrderID>
      <BuyerUserID>397681</BuyerUserID>
      <BuyerFirstName>TestLastName</BuyerFirstName>
      <BuyerLastName>TestFirstName</BuyerLastName>
      <BuyerEmail>test_user@company.com</BuyerEmail>
      <BuyerPhone>1-800-111-1111</BuyerPhone>
      <ShippingService>NotSelected</ShippingService>
      <CheckoutSiteID>0</CheckoutSiteID>
      <OrderCreationTime>2008-11-18T22:04:58.000Z</OrderCreationTime>
      <TaxAmount currencyID="USD">0.00</TaxAmount>
      <InsuranceCost currencyID="USD">1.00</InsuranceCost>
      <ShippingCost currencyID="USD">0.00</ShippingCost>
      <OrderTotalCost currencyID="USD">65.00</OrderTotalCost>
      <OrderItemDetails>
        <OrderLineItem>
          <OrderLineItemID>110035817827-23317655001</OrderLineItemID>
          <ItemID>110035817827</ItemID>
          <SKU>cmg00001</SKU>
          <QuantitySold>1</QuantitySold>
          <SalePrice currencyID="USD">65.00</SalePrice>
          <TaxAmount currencyID="USD">0.00</TaxAmount>
          <ShippingCost currencyID="USD">0.00</ShippingCost>
          <TotalCost currencyID="USD">65.00</TotalCost>
          <InsuranceCost currencyID="USD">1.00</InsuranceCost>
          <ListingSiteID>0</ListingSiteID>
          <SellingManagerSalesRecordID>110</SellingManagerSalesRecordID>
        </OrderLineItem>
      </OrderItemDetails>
    </OrderDetails>
  </SoldReport>
</BulkDataExchangeResponses>

Back to top

SoldReport Change History

Back to top

User-Contributed Notes

Copyright © 2008–2013 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.