eBay Merchant Data APIVersion 1131

SoldReport

SoldReport shows detailed information on all unacknowledged orders, and all unacknowledged line items in each order from the past 30 days. The unique identifier of each order is shown in the Order.OrderID response field, and unique identifier of each order line item is shown in a separate Transaction.OrderLineItemID response field. Only unfulfilled orders will appear in the response, and orders that have already shipped will not. Sellers use the information in SoldReport to make inventory updates and start order fulfillment.

Note: Once orders and order line items have been acknowledged with the OrderAck call, those orders and order line items will no longer appear in the SoldReport response. See Acknowledging Sales for more information. Note: As of June 2019, eBay has changed the format of order identifier values. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.

In the Trading API, eBay is rolling out this change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely. Since the SoldReport response will not be updated with the new format for OrderID values, it is suggested that Large Merchant Services users migrate to OrderReport instead, which has been enabled to return OrderID values in the new format.



Output

See also Samples.

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

<?xml version="1.0" encoding="utf-8"?>
<SoldReport 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>
      <ExternalTransactionStatus> PaymentTransactionStatusCodeType </ExternalTransactionStatus>
      <ExternalTransactionTime> dateTime </ExternalTransactionTime>
      <FeeOrCreditAmount currencyID="CurrencyCodeType"> AmountType (double) </FeeOrCreditAmount>
      <PaymentOrRefundAmount currencyID="CurrencyCodeType"> AmountType (double) </PaymentOrRefundAmount>
    </ExternalTransaction>
    <!-- ... more ExternalTransaction nodes allowed here ... -->
    <InsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </InsuranceCost>
    <OrderCreationTime> dateTime </OrderCreationTime>
    <OrderID> string </OrderID>
    <OrderItemDetails> OrderItemDetailsType
      <OrderLineItem> OrderLineItemType
        <ActualShippingCost currencyID="CurrencyCodeType"> AmountType (double) </ActualShippingCost>
        <BuyerPaymentTransactionNumber> string </BuyerPaymentTransactionNumber>
        <InsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </InsuranceCost>
        <ItemID> ItemIDType (string) </ItemID>
        <ListingSiteID> int </ListingSiteID>
        <OrderLineItemID> string </OrderLineItemID>
        <PaymentClearedTime> dateTime </PaymentClearedTime>
        <QuantitySold> int </QuantitySold>
        <SalePrice currencyID="CurrencyCodeType"> AmountType (double) </SalePrice>
        <SellingManagerSaleRecordID> int </SellingManagerSaleRecordID>
        <ShippingCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingCost>
        <SKU> SKUType (string) </SKU>
        <Status> TransactionStatusType
          <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
        </Status>
        <TaxAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxAmount>
        <TaxCategory> string </TaxCategory>
        <Taxes> TaxesType
          <TaxDetails> TaxDetailsType
            <Imposition> TaxTypeCodeType </Imposition>
            <TaxAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxAmount>
            <TaxDescription> TaxDescriptionCodeType </TaxDescription>
            <TaxOnHandlingAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxOnHandlingAmount>
            <TaxOnShippingAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxOnShippingAmount>
            <TaxOnSubtotalAmount currencyID="CurrencyCodeType"> AmountType (double) </TaxOnSubtotalAmount>
          </TaxDetails>
          <!-- ... more TaxDetails nodes allowed here ... -->
          <TotalTaxAmount currencyID="CurrencyCodeType"> AmountType (double) </TotalTaxAmount>
        </Taxes>
        <TotalCost currencyID="CurrencyCodeType"> AmountType (double) </TotalCost>
        <TotalIncludeseBayCollectedTax> boolean </TotalIncludeseBayCollectedTax>
        <UnpaidItem> UnpaidItemType
          <Status> UnpaidItemCaseStatusTypeCodeType </Status>
          <Type> UnpaidItemCaseOpenTypeCodeType </Type>
        </UnpaidItem>
        <Variation> MerchantDataVariationType
          <Price currencyID="CurrencyCodeType"> 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 currencyID="CurrencyCodeType"> AmountType (double) </OrderTotalCost>
    <PaymentClearedTime> dateTime </PaymentClearedTime>
    <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
    <PickupDetails> PickupDetailsType
      <PickupOptions> PickupOptionsType
        <PickupMethod> token </PickupMethod>
        <PickupPriority> int </PickupPriority>
      </PickupOptions>
      <!-- ... more PickupOptions nodes allowed here ... -->
    </PickupDetails>
    <PickupMethodSelected> PickupMethodSelectedType
      <MerchantPickupCode> string </MerchantPickupCode>
      <PickupMethod> token </PickupMethod>
      <PickupStatus> PickupStatusCodeType </PickupStatus>
      <PickupStoreID> string </PickupStoreID>
    </PickupMethodSelected>
    <SellingManagerSaleRecordID> int </SellingManagerSaleRecordID>
    <ShipCityName> string </ShipCityName>
    <ShipCountryName> token </ShipCountryName>
    <ShippingCost currencyID="CurrencyCodeType"> 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 currencyID="CurrencyCodeType"> AmountType (double) </TaxAmount>
    <TotalIncludeseBayCollectedTax> boolean </TotalIncludeseBayCollectedTax>
  </OrderDetails>
  <!-- ... more OrderDetails nodes allowed here ... -->
</SoldReport>
Return Value Type Occurrence Meaning
OrderDetails OrderDetailsType Always,
repeatable: [1..*]
Contains information about the sold item, such as: order ID, order line item ID, buyer information, shipping information, order creation time, payment cleared time, tax amount, and total cost.

Note: As of June 2019, eBay has changed the format of order identifier values. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.

In the Trading API, eBay is rolling out this change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely. Since the SoldReport response will not be updated with the new format for OrderID values, it is suggested that Large Merchant Services users migrate to OrderReport instead, which has been enabled to return OrderID values in the new format.
OrderDetails.BuyerEmail string Always Displays the email address of the buyer (from their eBay user account). Used for off-eBay communication.
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.
OrderDetails.BuyerStaticAlias string Always Static anonymous email address of the buyer for eBay intermediated member-to-memmber emails. Messaging calls in the Trading API, such as GetMemeberMessages will also use this static email address.

The email address is in the form <alias>@members.ebay.<SiteDomain>. Each eBay member is assigned a static alias, which is the first part of the email address. The <SiteDomain> value is based on the buyer's registered site. For example, the email address ends in @members.ebay.de for a buyer registered on the eBay Germany site. The <SiteDomain> value can be used to help identify the user's language. If the buyer changes his registered site, then the value of <SiteDomain> will change accordingly.

See BuyerEmail.

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.CheckoutStatus CheckoutStatusType Always The current checkout status of the order.
OrderDetails.CheckoutStatus
  .eBayPaymentStatus
PaymentStatusCodeType Always This value indicates the payment status of an order.

Applicable values: See eBayPaymentStatus.
Code so that your app gracefully handles any future changes to this list.
OrderDetails.CheckoutStatus
  .PaymentMethod
BuyerPaymentMethodCodeType Always The payment method that the buyer selected to pay for the order.

Note: For sellers opted in to eBay Managed Payments, a payment method is not needed at listing time, but this field is still returned. For eBay Managed Payments orders, the value returned in this field will be CreditCard, unless an eBay gift card was used by the buyer to pay a partial or full balance of the order. If this is the case, the the value returned in this field will be CCAccepted. Either of these two values will be returned for eBay Managed Payments orders, regardless of the actual payment method that the buyer uses.

Applicable values: See PaymentMethod.
Code so that your app gracefully handles any future changes to this list.
OrderDetails.CheckoutStatus
  .Status
CompleteStatusCodeType Always Indicates the status of the order. This value is subject to change based on the status of the checkout flow. Generally speaking, the Status field reads Incomplete when payment has yet to be initiated, Pending when payment has been initiated but is in process, and Complete when the payment process has completed.

Note: If the PaymentMethod is CashOnPickup, the Status value will read Complete right at checkout, even though the seller may not have been officially paid yet, and the eBayPaymentStatus field will read NoPaymentFailure. The Status value will remain as lt;code>Complete even if the seller uses ReviseCheckoutStatus to change the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from NoPaymentFailure to PaymentInProcess.

Applicable values:

Complete
This value indicates that the order or order line item is complete. Generally speaking, an order or order line item is complete when payment from the buyer has been initiated and has been processed.

Note: If the PaymentMethodUsed is CashOnPickup, the CheckoutStatus.Status value in GetOrders will be Complete at checkout time, even though the seller may not have been officially paid yet. The CheckoutStatus.Status value in GetOrders will remain as Complete even if the seller uses ReviseCheckoutStatus to change the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from NoPaymentFailure to PaymentInProcess.
CustomCode
Reserved for internal or future use
Incomplete
This value indicates that the order or order line item is in the incomplete state. Generally speaking, an order or order line item is considered incomplete when payment from the buyer has yet to be initiated.
Pending
This value indicates that the order or order line item is in the pending state. Generally speaking, an order is considered pending when payment from the buyer has been initiated but has yet to be fully processed.

Note: If the payment method is CashOnPickup, the CheckoutStatus.Status value in GetOrders will read Complete at checkout time, even though the seller may not have been officially paid yet. The CheckoutStatus.Status value in GetOrders will remain as Complete even if the seller uses ReviseCheckoutStatus to change the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from NoPaymentFailure to PaymentInProcess.

Code so that your app gracefully handles any future changes to this list.
OrderDetails
  .ExternalTransaction
ExternalTransactionType Always,
repeatable: [1..*]
The transaction that relates to the eBay order line item.
OrderDetails
  .ExternalTransaction
  .ExternalTransactionID
string Always Unique identifier for a PayPal payment of an eBay order. If the order was purchased with a payment method other than PayPal, "SIS" is returned, which stands for "Send Information To Seller." This field is only returned after payment has been made.
OrderDetails
  .ExternalTransaction
  .ExternalTransactionStatus
PaymentTransactionStatusCodeType Conditionally The current processing status of a PayPal payment for an eBay order.

Applicable values:

CustomCode
Reserved for internal or future use.
Failed
This value indicates that the payment transaction failed.
Pending
This value indicates that the payment transaction is pending.
Succeeded
This value indicates that the payment transaction succeeded.

Code so that your app gracefully handles any future changes to this list.
OrderDetails
  .ExternalTransaction
  .ExternalTransactionTime
dateTime Always Timestamp for payment transaction.
OrderDetails
  .ExternalTransaction
  .FeeOrCreditAmount
AmountType (double) Always Fee Amount is a positive value and Credit Amount is a negative value.
OrderDetails
  .ExternalTransaction
  .FeeOrCreditAmount
  [ attribute currencyID ]
CurrencyCodeType Always Fee Amount is a positive value and Credit Amount is a negative value.

For a list of possible enumeration values, see CurrencyCodeType.
OrderDetails
  .ExternalTransaction
  .PaymentOrRefundAmount
AmountType (double) Always If this dollar value is a positive amount, this is the amount that the buyer pays the seller through PayPal for purchase of the order. If this dollar value is a negative amount, this is the amount refunded to the buyer.

Note: If a refund is due to the buyer, the amount in this field will not include any 'Collect and Remit' tax (mandated US state sales tax or 'Goods and Services' tax in Australia or New Zealand) charged to the buyer for one or more order line items, since this tax is collected by eBay and not by the seller.
Note: As of November 2019, for orders subject to eBay 'Collect and Remit' taxes, PayPal has begun distributing order funds to the seller's account with the sales tax included. eBay 'Collect and Remit' tax includes US sales tax for numerous states, and 'Good and Services' tax that is applicable to Australian and New Zealand sellers. This 'Collect and Remit' tax amount for the order will be included in the PaymentOrRefundAmount value (for the payment scenario). To determine if 'Collect and Remit' taxes were added into PaymentOrRefundAmount value, the user can check for the Transaction.eBayCollectAndRemitTaxes.TaxDetails and the Transaction.Taxes.TaxDetails containers in the response. If both of these containers appear in the response with a TaxDetails.TaxDescription value of SalesTax (in US) or GST (in Australia or New Zealand), the tax amount that the buyer paid is in this amount.

Sellers should be aware that the sales tax that the buyer pays for the order will initially be included when the order funds are distributed to their PayPal account, but that PayPal will pull out the sales tax amount shortly after the payment clears, and will distribute the sales tax to the appropriate taxing authority. Previous to this change, PayPal would strip out the 'Collect and Remit' tax before distributing order funds to the seller's account.

This logic change does not apply to sellers who are in eBay managed payments, so the amount in this field will never reflect any 'Collect and Remit' tax, even if the order is subject to 'Collect and Remit' tax.
OrderDetails
  .ExternalTransaction
  .PaymentOrRefundAmount
  [ attribute currencyID ]
CurrencyCodeType Always If this dollar value is a positive amount, this is the amount that the buyer pays the seller through PayPal for purchase of the order. If this dollar value is a negative amount, this is the amount refunded to the buyer.

Note: If a refund is due to the buyer, the amount in this field will not include any 'Collect and Remit' tax (mandated US state sales tax or 'Goods and Services' tax in Australia or New Zealand) charged to the buyer for one or more order line items, since this tax is collected by eBay and not by the seller.
Note: As of November 2019, for orders subject to eBay 'Collect and Remit' taxes, PayPal has begun distributing order funds to the seller's account with the sales tax included. eBay 'Collect and Remit' tax includes US sales tax for numerous states, and 'Good and Services' tax that is applicable to Australian and New Zealand sellers. This 'Collect and Remit' tax amount for the order will be included in the PaymentOrRefundAmount value (for the payment scenario). To determine if 'Collect and Remit' taxes were added into PaymentOrRefundAmount value, the user can check for the Transaction.eBayCollectAndRemitTaxes.TaxDetails and the Transaction.Taxes.TaxDetails containers in the response. If both of these containers appear in the response with a TaxDetails.TaxDescription value of SalesTax (in US) or GST (in Australia or New Zealand), the tax amount that the buyer paid is in this amount.

Sellers should be aware that the sales tax that the buyer pays for the order will initially be included when the order funds are distributed to their PayPal account, but that PayPal will pull out the sales tax amount shortly after the payment clears, and will distribute the sales tax to the appropriate taxing authority. Previous to this change, PayPal would strip out the 'Collect and Remit' tax before distributing order funds to the seller's account.

This logic change does not apply to sellers who are in eBay managed payments, so the amount in this field will never reflect any 'Collect and Remit' tax, even if the order is subject to 'Collect and Remit' tax.


For a list of possible enumeration values, see CurrencyCodeType.
OrderDetails.InsuranceCost AmountType (double) Always Cost of insuring the delivery of this order with the courier.
OrderDetails.InsuranceCost
  [ attribute currencyID ]
CurrencyCodeType Always Cost of insuring the delivery of this order with the courier.

For a list of possible enumeration values, see CurrencyCodeType.
OrderDetails.OrderCreationTime dateTime Always The date and time that the order was created.
OrderDetails.OrderID string Always A unique identifier for a single or multiple line item order 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.

Note: As of June 2019, eBay has changed the format of order identifier values. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.

For developers and sellers who are already integrated with the Trading API's order management calls, this change shouldn't impact your integration unless you parse the existing order identifiers (e.g., OrderID or OrderLineItemID), or otherwise infer meaning from the format (e.g., differentiating between a single line item order versus a multiple line item order). Because we realize that some integrations may have logic that is dependent upon the old identifier format, eBay is rolling out this Trading API change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely.

During the transition period, for developers/sellers using a Trading WSDL older than Version 1113, they can use the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header in API calls to control whether the new or old OrderID format is returned in call response payloads. To get the new OrderID format, the value of the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header must be set to 1113. During the transition period and even after, the new and old OrderID formats will still be supported/accepted in all Trading API call request payloads. After the transition period (which will be announced), only the new OrderID format will be returned in all Trading API call response payloads, regardless of the Trading WSDL version used or specified compatibility level.

Note: For sellers integrated with the new order ID format, please note that the identifier for an order will change as it goes from unpaid to paid status. When using a SoldReport or FeeSettlementReport, either of these order IDs (paid or unpaid status) can be used to identify an order.
Max length: 40.
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
  .ActualShippingCost
AmountType (double) [invalid value for Returned] This indicates the shipping cost for the order line item, and it's only emitted if promotional shipping service is selected and payment has been made.
OrderDetails.OrderItemDetails
  .OrderLineItem
  .ActualShippingCost
  [ attribute currencyID ]
CurrencyCodeType Always This indicates the shipping cost for the order line item, and it's only emitted if promotional shipping service is selected and payment has been made.

For a list of possible enumeration values, see CurrencyCodeType.
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, and the BuyerPaymentTransactionNumber will be the same number as the PayPal External Transaction ID. Otherwise, the buyer must mark the item as paid 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.InsuranceCost
  [ attribute currencyID ]
CurrencyCodeType Always Cost of insuring the delivery of this order with the courier.

For a list of possible enumeration values, see CurrencyCodeType.
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.
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.

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 order line item (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 order line item (transaction).
OrderDetails.OrderItemDetails
  .OrderLineItem.SalePrice
AmountType (double) Always Price of the item.
OrderDetails.OrderItemDetails
  .OrderLineItem.SalePrice
  [ attribute currencyID ]
CurrencyCodeType Always Price of the item.

For a list of possible enumeration values, see CurrencyCodeType.
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.ShippingCost
  [ attribute currencyID ]
CurrencyCodeType Always Calculated shipping cost based on item weight, buyer's postal code, and shipping service.

For a list of possible enumeration values, see CurrencyCodeType.
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.Status
TransactionStatusType Always Container consisting of status details of an order line item, including payment information. Several of these fields change values during the checkout flow. See TransactionStatusType for its child elements.

For SoldReport, only the PaymentHoldStatus child element is returned. The fields indicating the status of the order are actually found in the OrderDetails.CheckoutStatus container.
OrderDetails.OrderItemDetails
  .OrderLineItem.Status
  .PaymentHoldStatus
PaymentHoldStatusCodeType Always This field indicates the type and/or status of a payment hold on the item.

Applicable values: See PaymentHoldStatus.
Code so that your app gracefully handles any future changes to this list.

See PayPal Holds on Payments.

OrderDetails.OrderItemDetails
  .OrderLineItem.TaxAmount
AmountType (double) Always Calculated tax fee based on the sale price and the sales tax at the buyer's location.
OrderDetails.OrderItemDetails
  .OrderLineItem.TaxAmount
  [ attribute currencyID ]
CurrencyCodeType Always Calculated tax fee based on the sale price and the sales tax at the buyer's location.

For a list of possible enumeration values, see CurrencyCodeType.
OrderDetails.OrderItemDetails
  .OrderLineItem.TaxCategory
string Conditionally A tax exception category code. This is returned only if set for the listing.
OrderDetails.OrderItemDetails
  .OrderLineItem.Taxes
TaxesType Conditionally Details about taxes applicable to this order line item (transaction). Returned only if enabled for the account. (Otherwise see OrderLineItem.TaxAmount.)
OrderDetails.OrderItemDetails
  .OrderLineItem.Taxes
  .TaxDetails
TaxDetailsType Conditionally,
repeatable: [0..*]
Container consisting of detailed sales tax information for an order line item, including the tax type and description, sales tax on the item cost, and sales tax related to shipping and handling.
OrderDetails.OrderItemDetails
  .OrderLineItem.Taxes
  .TaxDetails.Imposition
TaxTypeCodeType Conditionally This field indicates the tax type. A separate TaxDetails container is returned for each unique imposition (tax type).

Applicable values:

CustomCode
Reserved for internal or future use.
GST
This enumeration value indicates that a Goods and Services import tax was charged to the buyer against the order line item.

This tax type is only applicable for items being sold by Australian or New Zealand sellers.
SalesTax
This enumeration value indicates that standard sales tax was charged to the buyer against the order line item.
WasteRecyclingFee
This enumeration value indicates that an electronic waste recycling fee was charged to the buyer against the order line item.

Code so that your app gracefully handles any future changes to this list.
OrderDetails.OrderItemDetails
  .OrderLineItem.Taxes
  .TaxDetails.TaxAmount
AmountType (double) Conditionally This value is the total amount of sales tax for the order line item for the corresponding impositiion (tax type).

TaxAmount = TaxOnSubtotalAmount + TaxOnShippingAmount + TaxOnHandlingAmount

Note: If the corresponding tax type is GST or SalesTax (if found under both the eBayCollectAndRemitTaxes.TaxDetails and Taxes.TaxDetails containers), the order is subject to 'eBay Collect and Remit' tax, and a change in logic has been rolled out as of early November 2019. For orders that are subject to 'eBay Collect and Remit' tax, which includes US sales tax for numerous states, and 'Good and Services' tax that is applicable to Australian and New Zealand sellers, the tax amount in this field will be included in the Order.Total, Order.AmountPaid, and Transaction.AmountPaid fields.

Sellers should be aware that the sales tax that the buyer pays for the order will initially be included when the order funds are distributed to their PayPal account, but that PayPal will pull out the sales tax amount shortly after the payment clears, and will distribute the sales tax to the appropriate taxing authority. Previous to this change, PayPal would strip out the 'Collect and Remit' tax before distributing order funds to the seller's account.

This logic change does not apply to sellers who are in eBay managed payments, so the amount in this field will never reflect any 'Collect and Remit' tax, even if the order is subject to 'Collect and Remit' tax.
OrderDetails.OrderItemDetails
  .OrderLineItem.Taxes
  .TaxDetails.TaxAmount
  [ attribute currencyID ]
CurrencyCodeType Always This value is the total amount of sales tax for the order line item for the corresponding impositiion (tax type).

TaxAmount = TaxOnSubtotalAmount + TaxOnShippingAmount + TaxOnHandlingAmount

Note: If the corresponding tax type is GST or SalesTax (if found under both the eBayCollectAndRemitTaxes.TaxDetails and Taxes.TaxDetails containers), the order is subject to 'eBay Collect and Remit' tax, and a change in logic has been rolled out as of early November 2019. For orders that are subject to 'eBay Collect and Remit' tax, which includes US sales tax for numerous states, and 'Good and Services' tax that is applicable to Australian and New Zealand sellers, the tax amount in this field will be included in the Order.Total, Order.AmountPaid, and Transaction.AmountPaid fields.

Sellers should be aware that the sales tax that the buyer pays for the order will initially be included when the order funds are distributed to their PayPal account, but that PayPal will pull out the sales tax amount shortly after the payment clears, and will distribute the sales tax to the appropriate taxing authority. Previous to this change, PayPal would strip out the 'Collect and Remit' tax before distributing order funds to the seller's account.

This logic change does not apply to sellers who are in eBay managed payments, so the amount in this field will never reflect any 'Collect and Remit' tax, even if the order is subject to 'Collect and Remit' tax.


For a list of possible enumeration values, see CurrencyCodeType.
OrderDetails.OrderItemDetails
  .OrderLineItem.Taxes
  .TaxDetails.TaxDescription
TaxDescriptionCodeType Conditionally This enumeration indicates the type of tax.

Applicable values:

CustomCode
Reserved for internal or future use.
ElectronicWasteRecyclingFee
This enumeration value indicates that an electronic waste recycling fee was charged to the buyer against the order line item.
GST
This enumeration value indicates that a Goods and Services import tax was charged to the buyer against the order line item.

Note: At this time, this tax type is only applicable to the Australia site.
SalesTax
This enumeration value indicates that standard sales tax was charged to the buyer against the order line item.
TireRecyclingFee
This enumeration value indicates that a tire recycling fee was charged to the buyer against the order line item.

Code so that your app gracefully handles any future changes to this list.
OrderDetails.OrderItemDetails
  .OrderLineItem.Taxes
  .TaxDetails
  .TaxOnHandlingAmount
AmountType (double) Conditionally This value is the amount of sales tax applied based on handling costs for the order line item for the corresponding impositiion (tax type).
OrderDetails.OrderItemDetails
  .OrderLineItem.Taxes
  .TaxDetails
  .TaxOnHandlingAmount
  [ attribute currencyID ]
CurrencyCodeType Always This value is the amount of sales tax applied based on handling costs for the order line item for the corresponding impositiion (tax type).

For a list of possible enumeration values, see CurrencyCodeType.
OrderDetails.OrderItemDetails
  .OrderLineItem.Taxes
  .TaxDetails
  .TaxOnShippingAmount
AmountType (double) Conditionally This value is the amount of sales tax applied based on shipping costs for the order line item for the corresponding impositiion (tax type).
OrderDetails.OrderItemDetails
  .OrderLineItem.Taxes
  .TaxDetails
  .TaxOnShippingAmount
  [ attribute currencyID ]
CurrencyCodeType Always This value is the amount of sales tax applied based on shipping costs for the order line item for the corresponding impositiion (tax type).

For a list of possible enumeration values, see CurrencyCodeType.
OrderDetails.OrderItemDetails
  .OrderLineItem.Taxes
  .TaxDetails
  .TaxOnSubtotalAmount
AmountType (double) Conditionally This value is the amount of sales tax applied based on the unit cost of the order line item for the corresponding impositiion (tax type).
OrderDetails.OrderItemDetails
  .OrderLineItem.Taxes
  .TaxDetails
  .TaxOnSubtotalAmount
  [ attribute currencyID ]
CurrencyCodeType Always This value is the amount of sales tax applied based on the unit cost of the order line item for the corresponding impositiion (tax type).

For a list of possible enumeration values, see CurrencyCodeType.
OrderDetails.OrderItemDetails
  .OrderLineItem.Taxes
  .TotalTaxAmount
AmountType (double) Conditionally This value indicates the total tax amount for the order line item, for all tax types, which may include sales tax (seller-applied or 'eBay Collect and Remit'), 'Goods and Services' tax (for Australian or New Zealand sellers), or other fees like an electronic waste recycling fee.

Note: If the corresponding tax type is GST or SalesTax (if found under both the eBayCollectAndRemitTaxes and Taxes containers), the order is subject to 'eBay Collect and Remit' tax, and a change in logic has rolled out as of early November 2019. For orders that are subject to eBay 'Collect and Remit' tax, which includes US sales tax for numerous states, and 'Good and Services' tax that is applicable to Australian and New Zealand sellers, the tax amount in this field will be included in the Order.Total, Order.AmountPaid, and Transaction.AmountPaid fields.

Sellers should be aware that the sales tax that the buyer pays for the order will initially be included when the order funds are distributed to their PayPal account, but that PayPal will pull out the sales tax amount shortly after the payment clears, and will distribute the sales tax to the appropriate taxing authority. Previous to this change, PayPal would strip out the 'Collect and Remit' tax before distributing order funds to the seller's account.

This logic change does not apply to sellers who are in eBay managed payments, so the amount in this field will never reflect any 'Collect and Remit' tax, even if the order is subject to 'Collect and Remit' tax.
OrderDetails.OrderItemDetails
  .OrderLineItem.Taxes
  .TotalTaxAmount
  [ attribute currencyID ]
CurrencyCodeType Always This value indicates the total tax amount for the order line item, for all tax types, which may include sales tax (seller-applied or 'eBay Collect and Remit'), 'Goods and Services' tax (for Australian or New Zealand sellers), or other fees like an electronic waste recycling fee.

Note: If the corresponding tax type is GST or SalesTax (if found under both the eBayCollectAndRemitTaxes and Taxes containers), the order is subject to 'eBay Collect and Remit' tax, and a change in logic has rolled out as of early November 2019. For orders that are subject to eBay 'Collect and Remit' tax, which includes US sales tax for numerous states, and 'Good and Services' tax that is applicable to Australian and New Zealand sellers, the tax amount in this field will be included in the Order.Total, Order.AmountPaid, and Transaction.AmountPaid fields.

Sellers should be aware that the sales tax that the buyer pays for the order will initially be included when the order funds are distributed to their PayPal account, but that PayPal will pull out the sales tax amount shortly after the payment clears, and will distribute the sales tax to the appropriate taxing authority. Previous to this change, PayPal would strip out the 'Collect and Remit' tax before distributing order funds to the seller's account.

This logic change does not apply to sellers who are in eBay managed payments, so the amount in this field will never reflect any 'Collect and Remit' tax, even if the order is subject to 'Collect and Remit' tax.


For a list of possible enumeration values, see CurrencyCodeType.
OrderDetails.OrderItemDetails
  .OrderLineItem.TotalCost
AmountType (double) Always The total cost of the order line item, which includes the sale price of all order line items, shipping costs, and taxes. If multiple order line items between the same buyer and seller have been combined into a Combined Payment order, the TotalCost value returned for each order line item reflects the amount paid for the Combined Payment order and not the individual order line item.

Note: As of November 2019, for orders subject to eBay 'Collect and Remit' taxes, PayPal has begun distributing order funds to the seller's account with the sales tax included. eBay 'Collect and Remit' tax includes US sales tax for numerous states, and 'Good and Services' tax that is applicable to Australian and New Zealand sellers. This 'Collect and Remit' tax amount for each order line item will be included in the TotalCost value. To determine if 'Collect and Remit' taxes were added into TotalCost value, the user can check for the TotalIncludeseBayCollectedTax boolean value. If this value is returned as true, the tax amount shown in the Taxes.TaxDetails.TaxAmount field for each order line item is reflected in the TotalCost value.

Sellers should be aware that the sales tax that the buyer pays for the order will initially be included when the order funds are distributed to their PayPal account, but that PayPal will pull out the sales tax amount shortly after the payment clears, and will distribute the sales tax to the appropriate taxing authority. Previous to this change, PayPal would strip out the 'Collect and Remit' tax before distributing order funds to the seller's account.

This logic change does not apply to sellers who are in eBay managed payments, so the amount in this field will never reflect any 'Collect and Remit' tax, even if the order is subject to 'Collect and Remit' tax.
OrderDetails.OrderItemDetails
  .OrderLineItem.TotalCost
  [ attribute currencyID ]
CurrencyCodeType Always The total cost of the order line item, which includes the sale price of all order line items, shipping costs, and taxes. If multiple order line items between the same buyer and seller have been combined into a Combined Payment order, the TotalCost value returned for each order line item reflects the amount paid for the Combined Payment order and not the individual order line item.

Note: As of November 2019, for orders subject to eBay 'Collect and Remit' taxes, PayPal has begun distributing order funds to the seller's account with the sales tax included. eBay 'Collect and Remit' tax includes US sales tax for numerous states, and 'Good and Services' tax that is applicable to Australian and New Zealand sellers. This 'Collect and Remit' tax amount for each order line item will be included in the TotalCost value. To determine if 'Collect and Remit' taxes were added into TotalCost value, the user can check for the TotalIncludeseBayCollectedTax boolean value. If this value is returned as true, the tax amount shown in the Taxes.TaxDetails.TaxAmount field for each order line item is reflected in the TotalCost value.

Sellers should be aware that the sales tax that the buyer pays for the order will initially be included when the order funds are distributed to their PayPal account, but that PayPal will pull out the sales tax amount shortly after the payment clears, and will distribute the sales tax to the appropriate taxing authority. Previous to this change, PayPal would strip out the 'Collect and Remit' tax before distributing order funds to the seller's account.

This logic change does not apply to sellers who are in eBay managed payments, so the amount in this field will never reflect any 'Collect and Remit' tax, even if the order is subject to 'Collect and Remit' tax.


For a list of possible enumeration values, see CurrencyCodeType.
OrderDetails.OrderItemDetails
  .OrderLineItem
  .TotalIncludeseBayCollectedTax
boolean Always This boolean field is returned as true if the TotalCost value (for the line item) includes eBay 'Collect and Remit' taxes. eBay 'Collect and Remit' taxes include US state-mandated sales tax and 'Goods and Services' taxes that are applicable to orders from Australian and New Zealand sellers.

More and more US states are mandating the collection of sales tax for Internet sales. For a full list of affected states and effective dates, see the eBay sales tax collection help page.

For eBay managed payment orders, this field should always be returned as false, since eBay will always strip out any applicable sales tax (and remit to taxing authority) before the seller payout for the order line item is distributed to the seller's account.

Note: As of November 2019, for orders subject to eBay 'Collect and Remit' taxes, PayPal has begun distributing order funds to the seller's account with the sales tax included. However, shortly after the order funds clear in the seller's account, the 'Collect and Remit' tax amount will be pulled by PayPal from the seller's account and then disributed to the appropriate taxing authority. Previously, PayPal was stripping this 'Collect and Remit' tax from the buyer's payment and directly submitting this amount to the appropriate taxing authority, and this tax amount never shows up in the sellers account.
OrderDetails.OrderItemDetails
  .OrderLineItem.UnpaidItem
UnpaidItemType Conditionally Unpaid Item Details.
OrderDetails.OrderItemDetails
  .OrderLineItem.UnpaidItem
  .Status
UnpaidItemCaseStatusTypeCodeType Conditionally This field indicates the status of the Unpaid Item case. This field is always returned with the UnpaidItem container.

Applicable values:

ClosedWithoutPayment
This value indicates that the Unpaid Item case is closed with no payment received from the buyer.
ClosedWithPayment
This value indicates that the Unpaid Item case is closed with payment received from the buyer.
CustomCode
This value is reserved for future or internal use.
Open
This value indicates that the Unpaid Item case is open.

Code so that your app gracefully handles any future changes to this list.
OrderDetails.OrderItemDetails
  .OrderLineItem.UnpaidItem.Type
UnpaidItemCaseOpenTypeCodeType Conditionally This field indicates if the Unpaid Item case was opened manually by the customer or opened automatically by eBay's Unpaid Item Assistant feature. This field is always returned with the UnpaidItem container.

Applicable values:

Auto
This value indicates that the Unpaid Item case was opened automatically through eBay's Unpaid Item Assistant feature.
CustomCode
This value is reserved for future or internal use.
Manual
This value indicates that the seller opened an Unpaid Item case manually through the Resolution Center or by using the Trading API's AddDispute call.

Code so that your app gracefully handles any future changes to this list.

See Using Unpaid Item Assistant for more information about managing the Unpaid Item Assistant feature.

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.Price
  [ attribute currencyID ]
CurrencyCodeType 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.



For a list of possible enumeration values, see CurrencyCodeType.
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.

Note: The maximum number of item specifics that may be defined for a listing has increased from 30 to 45.
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 variations, 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:
  • Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node.
  • Specify up to five VariationSpecifics in each Variation node.
  • 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.

For AddToWatchList and RemoveFromWatchList: The ItemID value of the multiple-variation listing and the name-value pair to identify each variation in the listing are required.

Note: As of August 30, 2018, California will require sellers to display a Proposition 65 warning on online retail sites if products contain chemicals and/or substances that may impact the health of California buyers. This requirement is applicable to most eBay US categories, including eBay Motors, Motors Parts & Accessories, and catalog-enabled categories. The warning message can be customized by the seller, but should contain the following basic information:
  • The name of at least one listed chemical that prompted the warning
  • Text stating that the product 'can expose you to' the chemical(s) in the product
  • The URL for OEHHA's new Proposition 65 warnings website, which is www.P65Warnings.ca.gov
Unlike standard item specifics that allow a maximum of 65 characters in the Value field, the matching value for the 'California Prop 65 Warning' item specific allows up to 800 characters of text. When a seller passes in this item specific, eBay will automatically insert a warning symbol icon for the listing.

OrderDetails.OrderItemDetails
  .OrderLineItem.Variation
  .VariationSpecifics
  .NameValueList.Name
string Conditionally Depending on the call and context, this value is either a name of an Item/Category/Variation Specific, or a Parts Compatibility name.

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). 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 the AddFixedPriceItem family of calls: In the Compatibility.NameValueList context, this value is a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings.

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

For PlaceOffer: Required if the item being purchased includes Item Variations.

Note: For mandatory and recommended item specifics that are returned in the GetCategorySpecifics call, the seller should pass in the name of these item specifics just as they are shown in the GetCategorySpecifics response. Similarly, for catalog-enabled categories, the seller should pass in the name of instance aspects just as they are shown in the GetCategorySpecifics response. Instance aspects are additional details unique to a specific item or listing that a seller can include along with the product aspects that are already defined in the eBay catalog product associated with the listing. Instance aspects common to many catalog-enabled categories include 'Bundle Description' and 'Modification Description'. As of August 30, 2018, eBay US sellers who ship to California are required to pass in a 'California Prop 65 Warning' item specific if the item in the listing contains one or more chemicals known to be harmful to human health. This item specific is passed at the listing level for both single-variation and multiple-variation listings. The 'California Prop 65 Warning' is considered an instance specific because it will be retained on the listing even when the seller lists using an eBay catalog product. The 'California Prop 65 Warning' may be applicable in most eBay US categories, including eBay Motors, Motors Parts & Accessories, and catalog-enabled categories. Note: If Brand and MPN (Manufacturer Part Number) are being used to identify product variations in a multiple-variation listing, the Brand must be specified at the item level (ItemSpecifics container) and the MPN for each product variation must be specified at the variation level (VariationSpecifics container). The Brand name must be the same for all variations within a single listing.
Max length: 65.
OrderDetails.OrderItemDetails
  .OrderLineItem.Variation
  .VariationSpecifics
  .NameValueList.Value
string Conditionally,
repeatable: [0..*]
Depending on the call and context, this value is either the value of an Item/Category/Variation Specific, a Parts Compatibility value, or a product identifier.

For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics 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 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 the Compatibility.NameValueList context, this is the corresponding value of a motor vehicle aspect such as Year, Make, and Model. A Compatibility.NameValueList container is applicable for motor vehicle parts and accessories listings.

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

For PlaceOffer: Required if the item being purchased includes Item Variations.


Note: The standard maximum length for the value of an item specific is 65, but the maximum allowed length increases for instance aspects such as 'Bundle Description' and 'Modification Description'. The maximum allowed length for these instance aspects are returned in the GetCategorySpecifics call. The maximum allowed length for the new 'California Prop 65 Warning' item specific is 800 characters. For more information about the 'California Prop 65 Warning' item specific, see the ItemSpecifics.NameValueList field description.
Max length: 65 (but longer for some instance aspects, including 800 for 'California Prop 65 Warning').
OrderDetails.OrderTotalCost AmountType (double) Always The total cost of the order, which includes the sale price of all order line items, shipping costs, and taxes.

Note: As of November 2019, for orders subject to eBay 'Collect and Remit' taxes, PayPal has begun distributing order funds to the seller's account with the sales tax included. eBay 'Collect and Remit' tax includes US sales tax for numerous states, and 'Good and Services' tax that is applicable to Australian and New Zealand sellers. This 'Collect and Remit' tax amount for the order will be included in the OrderTotalCost value. To determine if 'Collect and Remit' taxes were added into OrderTotalCost value, the user can check for the TotalIncludeseBayCollectedTax boolean value. If this value is returned as true, the tax amount shown in the Taxes.TaxDetails.TaxAmount field for each order line item is reflected in the OrderTotalCost value. For a multiple line item order, the seller would need to view and add up the taxes shown in the field for each line item in the order.

Sellers should be aware that the sales tax that the buyer pays for the order will initially be included when the order funds are distributed to their PayPal account, but that PayPal will pull out the sales tax amount shortly after the payment clears, and will distribute the sales tax to the appropriate taxing authority. Previous to this change, PayPal would strip out the 'Collect and Remit' tax before distributing order funds to the seller's account.

This logic change does not apply to sellers who are in eBay managed payments, so the amount in this field will never reflect any 'Collect and Remit' tax, even if the order is subject to 'Collect and Remit' tax.
OrderDetails.OrderTotalCost
  [ attribute currencyID ]
CurrencyCodeType Always The total cost of the order, which includes the sale price of all order line items, shipping costs, and taxes.

Note: As of November 2019, for orders subject to eBay 'Collect and Remit' taxes, PayPal has begun distributing order funds to the seller's account with the sales tax included. eBay 'Collect and Remit' tax includes US sales tax for numerous states, and 'Good and Services' tax that is applicable to Australian and New Zealand sellers. This 'Collect and Remit' tax amount for the order will be included in the OrderTotalCost value. To determine if 'Collect and Remit' taxes were added into OrderTotalCost value, the user can check for the TotalIncludeseBayCollectedTax boolean value. If this value is returned as true, the tax amount shown in the Taxes.TaxDetails.TaxAmount field for each order line item is reflected in the OrderTotalCost value. For a multiple line item order, the seller would need to view and add up the taxes shown in the field for each line item in the order.

Sellers should be aware that the sales tax that the buyer pays for the order will initially be included when the order funds are distributed to their PayPal account, but that PayPal will pull out the sales tax amount shortly after the payment clears, and will distribute the sales tax to the appropriate taxing authority. Previous to this change, PayPal would strip out the 'Collect and Remit' tax before distributing order funds to the seller's account.

This logic change does not apply to sellers who are in eBay managed payments, so the amount in this field will never reflect any 'Collect and Remit' tax, even if the order is subject to 'Collect and Remit' tax.


For a list of possible enumeration values, see CurrencyCodeType.
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.PaymentHoldStatus PaymentHoldStatusCodeType Always Contains the status of a PayPal payment hold on the item.

Applicable values: See PaymentHoldStatus.
Code so that your app gracefully handles any future changes to this list.
OrderDetails.PickupDetails PickupDetailsType Conditionally Contains all local pickup related information.
OrderDetails.PickupDetails
  .PickupOptions
PickupOptionsType Conditionally,
repeatable: [0..*]
Container consisting of a pickup method and the priority of the pickup method. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page.

This container is always returned prior to order payment if the seller created/revised/relisted the item with the EligibleForPickupInStore and/or EligibleForPickupDropOff flag in the call request set to 'true'. If and when the In-Store pickup method (US only) or 'Click and Collect' pickup method (UK and Australia only) is selected by the buyer and payment for the order is made, this container will no longer be returned in the response, and will essentially be replaced by the PickupMethodSelected container.

Note: At this time, the In-Store Pickup and Click and Collect features are generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. In-Store Pickup is only applicable to the US site, and Click and Collect is only applicable to the UK, Germany, and Australia sites.
OrderDetails.PickupDetails
  .PickupOptions.PickupMethod
token Conditionally This value indicates an available pickup method. This field is always returned with the PickupOptions container.

Note: At this time, 'InStorePickup' and 'PickUpDropOff' are the only available pickup methods; however, additional pickup methods may be added to the list in future releases.
Note: A seller must be eligible for the In-Store Pickup or Click and Collect feature to list an item that is eligible for In-Store Pickup or Click and Collect. At this time, In-Store Pickup is generally only available to large retail merchants in US, and the 'Click and Collect' feature is only available to large merchants on the eBay UK (site ID - 3), eBay Australia (Site ID - 15), and eBay Germany (Site ID - 77) sites.

Applicable values: See PickupMethodCodeType
OrderDetails.PickupDetails
  .PickupOptions.PickupPriority
int Conditionally This integer value indicates the priority of the pickup method. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page. This field is always returned with the PickupOptions container.

Note: A seller must be eligible for the In-Store Pickup or Click and Collect features to list an item that is eligible for In-Store Pickup or Click and Collect. At this time, In-Store Pickup is generally only available to large retail merchants in US, and the 'Click and Collect' feature is only available to large merchants on the eBay UK (site ID - 3), eBay Australia (Site ID - 15), and eBay Germany (Site ID - 77) sites.
OrderDetails
  .PickupMethodSelected
PickupMethodSelectedType Conditionally Contains the information about buyer selected pickup method
OrderDetails
  .PickupMethodSelected
  .MerchantPickupCode
string Conditionally The unique reference number defined by the merchant to track In-Store Pickup orders. The MerchantPickupCode is picked up by eBay if it is set by the merchant through the payload of a notification sent to eBay through the Inbound Notifications API. This field is only returned with the PickupMethodSelected container if it set by the merchant.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the real reference number is only returned to the buyer or seller, and a string value of Unavailable will be returned to all third parties.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
OrderDetails
  .PickupMethodSelected
  .PickupMethod
token Conditionally This value indicates the local pickup method that was selected by the buyer at checkout. This field is always returned with the PickupMethodSelected container.

Note: Merchants must be eligible for the In-Store Pickup or "Click and Collect" feature to list items that are eligible for these local pickup methods.

Applicable values: See PickupMethodCodeType
OrderDetails
  .PickupMethodSelected
  .PickupStatus
PickupStatusCodeType Conditionally This field indicates the current status of the local pickup order. The value of the PickupStatus field can change during the lifecycle of the order based on the notifications that a merchant sends to eBay through the Inbound Notifications API. This field is always returned with the PickupMethodSelected container.

Note: A seller must be eligible for the In-Store Pickup or Click and Collect features to list an item that is eligible for these features. At this time, these features are generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.

Applicable values: See PickupStatus.
Code so that your app gracefully handles any future changes to this list.
OrderDetails
  .PickupMethodSelected
  .PickupStoreID
string Conditionally The unique identifier of the merchant's store where the item will be picked up. The PickupStoreID is picked up by eBay based on the LocationID value that is set by the merchant in the Inventory Management API. This field is always returned with the PickupMethodSelected container.

Note: A seller must be eligible for the In-Store Pickup feature to list an item that is eligible for In-Store Pickup. At this time, the In-Store Pickup feature is generally only available to large retail merchants in US, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
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.ShippingCost
  [ attribute currencyID ]
CurrencyCodeType Always Calculated shipping cost based on item weight, buyer's postal code, and shipping service.

For a list of possible enumeration values, see CurrencyCodeType.
OrderDetails.ShippingService string Always Name of the shipping service for display purposes.

Note that this value can change for aesthetic purposes, whereas the ShippingServiceToken will not. Therefore, for all practical purposes, use ShippingServiceToken when programmatically reading and processing.

See ShippingServiceToken.

OrderDetails
  .ShippingServiceToken
string Always Value used for the shipping service. For a list of valid values, call GeteBayDetails with DetailName set to ShippingServiceDetails.lt;br>
Related fields:
Item.ShippingDetails.InternationalShippingServiceOption.ShippingService in AddFixedPriceItem
Item.ShippingDetails.ShippingServiceOptions.ShippingService in AddFixedPriceItem
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.ShipReferenceId string Conditionally Uniquely identifies an order shipped using the Global Shipping Program. This value is generated by eBay when the order is completed. The international shipping provider uses the ReferenceID as the primary reference when processing the shipment. Sellers must include this value on the package immediately above the street address of the international shipping provider. Example: "Reference #1234567890123456"
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.
OrderDetails.TaxAmount
  [ attribute currencyID ]
CurrencyCodeType Always Calculated tax fee based on the sale price and the sales tax at the seller's location.

For a list of possible enumeration values, see CurrencyCodeType.
OrderDetails
  .TotalIncludeseBayCollectedTax
boolean Always This boolean field is returned as true if the OrderTotalCost value includes eBay 'Collect and Remit' taxes. eBay 'Collect and Remit' taxes include US state-mandated sales tax and 'Goods and Services' taxes that are applicable to orders from Australian and New Zealand sellers.

More and more US states are mandating the collection of sales tax for Internet sales. For a full list of affected states and effective dates, see the eBay sales tax collection help page.

For eBay managed payment orders, this field should always be returned as false, since eBay will always strip out any applicable sales tax (and remit to taxing authority) before the seller payout for the order is distributed to the seller's account.

Note: As of November 2019, for orders subject to eBay 'Collect and Remit' taxes, PayPal has begun distributing order funds to the seller's account with the sales tax included. However, shortly after the order funds clear in the seller's account, the 'Collect and Remit' tax amount will be pulled by PayPal from the seller's account and then disributed to the appropriate taxing authority. Previously, PayPal was stripping this 'Collect and Remit' tax from the buyer's payment and directly submitting this amount to the appropriate taxing authority, and this tax amount never shows up in the sellers account.



Samples

New to making API calls? Please see Making a 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.

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



Change History

Change Date Description
1131
2019-10-25
  • OrderDetails.TotalIncludeseBayCollectedTax (added): This boolean field indicates if the order total shown in the OrderDetails.OrderTotalCost field includes eBay 'Collect and Remit' taxes.
  • OrderDetails.OrderTotalCost (modified): If the new TotalIncludeseBayCollectedTax boolean field is returned as true, the amount shown in the OrderTotalCost field includes eBay 'Collect and Remit' taxes. To get the amount of 'Collect and Remit' taxes, see the Taxes.TaxDetails.TaxAmount field for each line item in the order.
  • OrderLineItem.TotalIncludeseBayCollectedTax (added): This boolean field indicates if the order line item total shown in the OrderLineItem.TotalCost field includes eBay 'Collect and Remit' taxes.
  • OrderLineItem.TotalCost (modified): If the new TotalIncludeseBayCollectedTax boolean field is returned as true, the amount shown in the TotalCost field includes eBay 'Collect and Remit' taxes. To get the amount of 'Collect and Remit' taxes for a line item, see the Taxes.TaxDetails.TaxAmount field for each line item in the order.
1113
2019-06-21
  • OrderDetails.OrderID (modified): The new format of order identifier values was rolled out. Both the new and old order ID format will be accepted in request payloads to identify an eBay order. However, the SoldReport call response payload is not being updated to return the new format, regardless of the WSDL version being used or the commpatibility level value. See the 1113 Release Notes for more details.
1107
2019-05-10
  • OrderDetails.OrderID (modified): Starting in June 2019, eBay will start changing the format of order identifier values. The new format will be a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. To enable and use the new format, the user will need to use the 1107 WSDL (or newer as versions roll out) and set the compatibility level to 1113. There will be a nine-month transition period where the old format will still be supported.
0955
2016-02-12
  • BuyerPaymentMethodCodeType (modified): The Moneybookers, ProPay, and Paymate enumeration values have been deprecated, and will no longer be returned in any calls.
0879
2014-06-17
  • PickuMethodCodeType (modified): 'PickUpDropOff' value added to handle the use case when the buyer selects "Click and Collect" as the pickup method. The "Click and Collect" feature is currently only available on the eBay UK site.
0843
2013-09-24
  • OrderDetails.PaymentClearedTime, OrderDetails.ShipCityName, OrderDetails.ShipCountryName, OrderDetails.ShipPostalCode, OrderDetails.ShipRecipientName, OrderDetails.ShipStateOrProvince, OrderDetails.ShipStreet1, OrderDetails.ShipStreet2 (doc change): The previously described condition for these fields to be returned was incorrect. They are returned only if payment for the order has been cleared.
0841
2013-09-19
  • OrderDetails.ShipCityName, OrderDetails.ShipCountryName, OrderDetails.ShipPostalCode, OrderDetails.ShipRecipientName, OrderDetails.ShipStateOrProvince, OrderDetails.ShipStreet1, OrderDetails.ShipStreet2 (modified): These fields are only returned if the downloadRequestFilter.soldReportFilter is set in the corresponding startDownloadJob call of the Bulk Data Exchange API.
0837
2013-08-29
  • PickupDetails (added): This In-Store Pickup container is now returned in SoldReport.
  • PickupMethodSelected (added): This In-Store Pickup container is now returned in SoldReport.
0799
2012-11-07
  • OrderDetails (modified): When an order ships via the Global Shipping Program, the following fields returned in the OrderDetails container now contain information specific to the domestic leg of the shipment: OrderTotalCost, ShipCityName, ShipCountryName, ShippingCost, ShippingService, ShippingServiceToken, ShipPostalCode, ShipStateOrProvince, ShipStreet1 and ShipStreet2. For more information, see the descriptions of the individual fields.
  • OrderLineItem (modified): When an order ships via the Global Shipping Program, the ShippingCost and TotalCost fields returned in the OrderLineItem container now contain information specific to the domestic leg of the shipment. For more information, see the descriptions of the fields.
0797
2012-10-24
  • OrderLineItem.UnpaidItem (added): This container is only returned if an Unpaid Item case has been opened against the corresponding order line item. The fields in this container report the status of the case and whether the case was opened manually be the seller, or if the case was opened automatically through the Unpaid Item Assistant mechanism.
  • OrderDetails.ShipReferenceId (added): A unique identifier that is used by the international shipping provider for an order that is being shipped using the Global Shipping Program. This value is generated by eBay after checkout is complete. The seller must input this value on the shipping label just above the street address of the international shipping provider.
0787
2012-08-15
  • ActualShippingCost (added): The actual shipping cost for an order line item. This field is returned only if a seller-defined promotional shipping rule is applied to the order, and only after payment is made by the buyer.
0783
2012-07-18
  • ShippingCost (modified): For order line items with Calculated shipping type, the correct shipping cost is returned only after buyer payment, as part of the total cost in OrderDetails.ShippingCost. For order line items with Flat shipping type, the correct shipping cost is returned for the order line item in OrderDetails.OrderItemDetails.OrderLineItem.ShippingCost, and before buyer payment in OrderDetails.ShippingCost. It is returned as part of the total cost, after buyer payment in OrderDetails.ShippingCost.
0675
2010-06-23
  • OrderDetails.OrderItemDetails.OrderLineItem.Taxes (added): Reserved for future use.
0673
2010-6-9
  • OrderDetails.BuyerStaticAlias (added): Buyer's static email address. Used for for eBay intermediated emails.
0657
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.
0639
2009-10-14
  • OrderDetailsType.SellingManagerSaleRecordID, OrderLineItemType.SellingManagerSaleRecordID (added): New Selling Manager or Selling Manager Pro element included in the order and line item details.
0589
2008-11-29
  • (added) New call.