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

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

Output Samples Change History User Notes
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.

<?xml version="1.0" encoding="utf-8"?>
<SoldReportResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType 
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType 
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
  <!-- Call-specific Output Fields -->
  <OrderDetails> OrderDetailsType 
    <BuyerEmail> string </BuyerEmail>
    <BuyerFirstName> string </BuyerFirstName>
    <BuyerLastName> string </BuyerLastName>
    <BuyerPhone> string </BuyerPhone>
    <BuyerUserID> string </BuyerUserID>
    <CheckoutSiteID> int </CheckoutSiteID>
    <InsuranceCost> AmountType (double) </InsuranceCost>
    <OrderCreationTime> dateTime </OrderCreationTime>
    <OrderID> string </OrderID>
    <OrderItemDetails> OrderItemDetailsType 
      <OrderLineItem> OrderLineItemType 
        <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>
        <TaxAmount> AmountType (double) </TaxAmount>
        <TaxCategory> string </TaxCategory>
        <TotalCost> AmountType (double) </TotalCost>
        <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 nodes here ... -->
            </NameValueList>
            <!-- ... more NameValueList nodes here ... -->
          </VariationSpecifics>
        </Variation>
      </OrderLineItem>
      <!-- ... more OrderLineItem nodes here ... -->
    </OrderItemDetails>
    <OrderTotalCost> AmountType (double) </OrderTotalCost>
    <PaymentClearedTime> dateTime </PaymentClearedTime>
    <SellingManagerSaleRecordID> int </SellingManagerSaleRecordID>
    <ShipCityName> string </ShipCityName>
    <ShipCountryName> token </ShipCountryName>
    <ShippingCost> AmountType (double) </ShippingCost>
    <ShippingService> string </ShippingService>
    <ShipPostalCode> string </ShipPostalCode>
    <ShipRecipientName> string </ShipRecipientName>
    <ShipStateOrProvince> string </ShipStateOrProvince>
    <ShipStreet1> string </ShipStreet1>
    <ShipStreet2> string </ShipStreet2>
    <TaxAmount> AmountType (double) </TaxAmount>
  </OrderDetails>
  <!-- ... more OrderDetails nodes here ... -->
</SoldReportResponse>
Return Value Type Occurrence Meaning
Standard Output Fields   [Jump to call-specific fields]
Ack AckCodeType Always A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   Failure

(out) Request processing failed

•   Success

(out) Request processing succeeded

•   Warning

(out) Request processing completed with warning information being included in the response message


(Not all values in AckCodeType apply to this field.)
Build string Always This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID string Conditionally In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned.

Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors ErrorType Conditionally,
repeatable: [0..*]		 A list of application-level errors (if any) that occurred when eBay processed the request.

See Error Handling.
Errors.ErrorClassification ErrorClassificationCodeType Conditionally API errors are divided between two classes: system errors and request errors.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   RequestError

(out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data.

•   SystemError

(out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
Errors.ErrorCode token Conditionally A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document.
Errors.ErrorParameters ErrorParameterType Conditionally,
repeatable: [0..*]		 This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters
  [ attribute ParamID ]		 string Conditionally The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value string Conditionally The value of the variable (e.g., the attribute set ID)
Errors.LongMessage string Conditionally A more detailed description of the condition that raised the error.
Errors.SeverityCode SeverityCodeType Conditionally Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use

•   Error

(out) Application-level error

•   Warning

(out) Warning or informational error
Errors.ShortMessage string Conditionally A brief description of the condition that raised the error.
HardExpirationWarning string Conditionally Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp dateTime Always This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone.

Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version string Always The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.
Call-specific Output Fields
OrderDetails OrderDetailsType Always,
repeatable: [1..*]		 Contains information about the sold item, such as: order ID, order line item ID, buyer information, shipping information, order creataion time, payment cleared time, tax amount, insurance cost, and total cost.

See OrderLineItemType for more information about the OrderLineItemID field.
OrderDetails.BuyerEmail string Always Displays the email address of the buyer (from their eBay user account).
OrderDetails.BuyerFirstName string Always Displays the first name of the buyer (from their eBay user account).
OrderDetails.BuyerLastName string Always Displays the last name of the buyer (from their eBay user account).
OrderDetails.BuyerPhone string Always Buyer's primary phone number. This may return a value of "Invalid Request" if you are not authorized to see the buyer's phone number.

Also applicable to Half.com (for GetOrders).
OrderDetails.BuyerUserID string Always The buyer's eBay User ID.
OrderDetails.CheckoutSiteID int Always The eBay site that the buyer used when paying for the item(s).
OrderDetails.InsuranceCost AmountType (double) Always Cost of insuring the delivery of this order with the courier.
OrderDetails.OrderCreationTime dateTime Always The date and time that the order was created.
OrderDetails.OrderID string Always A unique identifier for a purchase or multiple purchases from the same seller. When a buyer purchases multiple items from the same listing, each item purchased will have an Order Line Item ID and all items in that purchase will have the same Order ID.



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.
OrderDetails.OrderItemDetails OrderItemDetailsType Always Contains the data for each line item in the order.
OrderDetails.OrderItemDetails
  .OrderLineItem 		OrderLineItemType Always,
repeatable: [1..*]		 Specifics for the sale data for a single SKU or item.
OrderDetails.OrderItemDetails
  .OrderLineItem
  .BuyerPaymentTransactionNumber 		string Conditionally If payment has been marked as sent (on the Buyer's MyeBay page), this field returns the transaction number assigned to the payment event by the eBay application. Sellers might use this field to determine when they can ship an item. This field is only included in the response after the Buyer has completed checkout.

If a buyer has completed checkout using PayPal, the Payment is automatically marked as sent. Otherwise, the buyer must mark it manually on the MyeBay page.
OrderDetails.OrderItemDetails
  .OrderLineItem.InsuranceCost 		AmountType (double) Always Cost of insuring the delivery of this order with the courier.
OrderDetails.OrderItemDetails
  .OrderLineItem.ItemID 		ItemIDType (string) Always The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value.
Also applicable to Half.com.
OrderDetails.OrderItemDetails
  .OrderLineItem.ListingSiteID 		int Always eBay site where the seller is registered.
OrderDetails.OrderItemDetails
  .OrderLineItem.OrderLineItemID 		string Always An ID that uniquely identifies each line item within an order. If the buyer only purchased one item, there will be one Order ID and one Order Line Item ID. If a buyer purchases multiple items, there will be one Order ID and multiple Order Line Item IDs.

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.
OrderDetails.OrderItemDetails
  .OrderLineItem
  .PaymentClearedTime 		dateTime Conditionally The date and time that the payment was acknowledged. Only returned for SoldReport if payment has been marked as received.
OrderDetails.OrderItemDetails
  .OrderLineItem.QuantitySold 		int Always The number of items sold to a specific buyer (within a single transaction).
OrderDetails.OrderItemDetails
  .OrderLineItem.SalePrice 		AmountType (double) Always Price of the item.
OrderDetails.OrderItemDetails
  .OrderLineItem
  .SellingManagerSaleRecordID 		int Conditionally For users of the Selling Manager or Selling Manager Pro tools only. If you are not using Selling Manager or Selling Manager Pro, this field will not be returned in your response.

Unique identifier for the record, assigned by eBay. An example of a recordId: 1111:222:333:444:x.
OrderDetails.OrderItemDetails
  .OrderLineItem.ShippingCost 		AmountType (double) Always Calculated shipping cost based on item weight, buyer's postal code, and shipping service.
OrderDetails.OrderItemDetails
  .OrderLineItem.SKU 		SKUType (string) Always Stock Keeping Unit that serves as a unique identifier for an item. Many merchants assign a SKU number to an item of a specific type, size, and color. This way, they can keep track of how many products of each type, size, and color are selling, and they can re-stock their shelves according to customer demand. You can use SKU numbers to add Fixed Price Items and to keep track of your eBay inventory, instead of (or in addition to) the Item ID.
OrderDetails.OrderItemDetails
  .OrderLineItem.TaxAmount 		AmountType (double) Always Calculated tax fee based on the sale price and the sales tax at the seller's location.
OrderDetails.OrderItemDetails
  .OrderLineItem.TaxCategory 		string Conditionally Reserved for future use.
OrderDetails.OrderItemDetails
  .OrderLineItem.TotalCost 		AmountType (double) Always Calculated total for all fees, tax, and sale price(s) in this order.
OrderDetails.OrderItemDetails
  .OrderLineItem.Variation 		MerchantDataVariationType Conditionally Variations are multiple similar (but not identical) items in one fixed-price listing. For example, a clothing listing can contain items of the same brand that vary by color and size. Each variation specifies a combination of one of these colors and sizes. Each variation can have a different quantity and price. Only returned if the order line item is for a variation.
OrderDetails.OrderItemDetails
  .OrderLineItem.Variation.Price 		AmountType (double) Always The fixed price of all items identified by this variation. For example, a "Blue, Large" variation price could be USD 10.00, and a "Black, Medium" variation price could be USD 5.00.
OrderDetails.OrderItemDetails
  .OrderLineItem.Variation
  .Quantity 		int Always For ActiveInventoryReport: The number of items available for sale that are associated with this variation.

For SoldReport: The total number of items associated with the variation (including the quantity sold). To calculate the quantity available for sale, subtract the variation's QuantitySold from this value.
OrderDetails.OrderItemDetails
  .OrderLineItem.Variation
  .SellingStatus 		MerchantDataSellingStatusType Always Contains the variation's quantity sold. Always returned when variations are present.
OrderDetails.OrderItemDetails
  .OrderLineItem.Variation
  .SellingStatus.QuantitySold 		int Always Total number of items sold in the variation (across the variation's lifetime). To determine the quantity sold for the order line item, use OrderLineItem.QuantitySold.
OrderDetails.OrderItemDetails
  .OrderLineItem.Variation.SKU 		SKUType (string) Conditionally Stock Keeping Unit that serves as the seller's unique identifier for items within the same variation. You can use the variation's SKU instead of the variation specifics to revise a variation and to keep track of your eBay inventory.

Many merchants assign a SKU to an item of a specific type, size, and color. This way, they can keep track of how many products of each type, size, and color are selling, and they can re-stock their shelves or update the variation quantity on eBay according to customer demand.

Only returned if the seller specified a SKU for the variation.
OrderDetails.OrderItemDetails
  .OrderLineItem.Variation
  .VariationSpecifics 		NameValueListArrayType Conditionally A list of name/value pairs that uniquely identify the variation within the listing. All variations specify the same set of names, and each variation provides a unique combination of values for those names. For example, if the items vary by color and size, then every variation specifies Color and Size as names, and no two variations specify the same combination of color and size values.

If a variation has no SKU, use the variation specifics as a unique ID to revise the variation and to keep track of your eBay inventory.
OrderDetails.OrderItemDetails
  .OrderLineItem.Variation
  .VariationSpecifics
  .NameValueList 		NameValueListType Conditionally,
repeatable: [0..*]		 For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified.

For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node.

If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node.

When you list with Item Variations:
a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node.
b) Specify up to five VariationSpecifics in each Variation node.
c) Specify all applicable names with all their supported values in the VariationSpecificSet node.

See the Variation sample in the AddFixedPriceItem call reference for examples.

For PlaceOffer: Required if the item being purchased includes Item Variations.
OrderDetails.OrderItemDetails
  .OrderLineItem.Variation
  .VariationSpecifics
  .NameValueList.Name 		string Conditionally A name in a name/value pair.

For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics or GetItemRecommendations). You can't specify the same name twice within the same listing.

For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations.

For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer").

For search calls: In the GetSearchResults response, this the name of an attribute (Attribute) that was used in the listing. Specifically: If SearchRequest was used to perform a "Product Finder" search, this contains the name of one attribute (i.e, the name of one ID-based Item Specifics field). If IncludeCondition was true in the request, this returns the condition attribute name (e.g., "Item Condition").

In the GetProducts response, this is an attribute name that is defined for a catalog product.

For PlaceOffer: Required if the item being purchased includes Item Variations.
OrderDetails.OrderItemDetails
  .OrderLineItem.Variation
  .VariationSpecifics
  .NameValueList.Value 		string Conditionally,
repeatable: [0..*]		 A value associated with the name.

For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values.

For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values.

In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name=Size, you would specify all size values that you wan to offer in the listing.

For GetCategorySpecifics and GetItemRecommendations: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available.

For search calls: In the GetSearchResults response, if SearchRequest was used to perform a "Product Finder" search, this contains the value of one attribute. If IncludeCondition was true in the request, this returns the condition attribute value (e.g., "New").

For PlaceOffer: Required if the item being purchased includes Item Variations.
OrderDetails.OrderTotalCost AmountType (double) Always Calculated total for all fees, tax, and sale price(s) in this order.
OrderDetails
  .PaymentClearedTime 		dateTime Conditionally The date and time that the payment was acknowledged. Only returned if payment has been marked as sent (checkout is complete). If a buyer has completed checkout using PayPal, the Payment is automatically marked as sent. Otherwise, the buyer must mark it manually on the MyeBay page.
OrderDetails
  .SellingManagerSaleRecordID 		int Conditionally For users of the Selling Manager or Selling Manager Pro tools only. If you are not using Selling Manager or Selling Manager Pro, this field will not be returned in your response.

Unique identifier for the record, assigned by eBay. An example of a recordId: 1111:222:333:444:x.
OrderDetails.ShipCityName string Conditionally Displays the buyer's city name (from the shipping address on their eBay user account). Only returned if payment has been marked as sent (checkout is complete). If a buyer has completed checkout using PayPal, the Payment is automatically marked as sent. Otherwise, the buyer must mark it manually on the MyeBay page.
OrderDetails.ShipCountryName token Conditionally Displays the buyer's ISO 3166 country code (from the shipping address on their eBay user account). Only returned if payment has been marked as sent.

Applicable values: See CountryCodeType
OrderDetails.ShippingCost AmountType (double) Always Calculated shipping cost based on item weight, buyer's postal code, and shipping service.
OrderDetails.ShippingService string Always Carrier used to ship item(s).
OrderDetails.ShipPostalCode string Conditionally Displays the buyer's postal code or zip code (from the shipping address on their eBay user account). Only returned if payment has been marked as sent.
OrderDetails.ShipRecipientName string Conditionally Displays the buyer's recipient name for shipping (from the shipping address on their eBay user account). Only returned if payment has been marked as sent.
OrderDetails
  .ShipStateOrProvince 		string Conditionally Displays the buyer's state or province name (from the shipping address on their eBay user account). Only returned if payment has been marked as sent.
OrderDetails.ShipStreet1 string Conditionally Displays the buyer's street name (from the shipping address on their eBay user account). Only returned if payment has been marked as sent.
OrderDetails.ShipStreet2 string Conditionally Displays the second line of a buyer's street name (if one exists in the shipping address on their eBay user account). Only returned if payment has been marked as sent.
OrderDetails.TaxAmount AmountType (double) Always Calculated tax fee based on the sale price and the sales tax at the seller's location.



Back to top

Output Samples Change History User Notes
SoldReport Samples

New to making API calls? Please see Making an API Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Basic Call

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

Output Samples Change History User Notes
SoldReport Change History
Version Description
657
2010-2-17
  • Price, Variations (added): New Variations node for details that apply to multi-variation listings. Also note that SKUDetails.Price might not be returned when Variation.Price is present.
  • OrderLineItemType.TaxCategory (added): Added to support future account functionality.
  • All Amount Values (modified): All amount values will now be returned as xs:double.
  • All (modified): Schema elements were re-ordered to match report output.
639
2009-10-14
  • OrderDetailsType.SellingManagerSaleRecordID, OrderLineItemType.SellingManagerSaleRecordID (added): New Selling Manager or Selling Manager Pro element included in the order and line item details.
589
2008-11-29
  • (added) New call.



Back to top

Output Samples Change History User Notes
User-Contributed Notes
   
 
 
 

This document was generated with a customized version of the apireferencedocs tool.

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