GetSellingManagerSaleRecord

Note: GetSellingManagerSaleRecord and all Selling Manager Pro calls are being deprecated. Selling Manager Pro calls will start being decommissioned beginning on June 1, 2021. The GetOrders call of Trading API or the Fulfillment API should be used to retrieve orders.

Requests the data in a Selling Manager sale record.To use this call, you must be a Selling Manager Pro subscriber.

Call GetSellingManagerSoldListings and use the output fields from that call (ItemID and TransactionID from the same SalesRecord) as input fields to your GetSellingManagerSaleRecord request.

See:
Using Selling Manager Calls in the Trading API
Selling Manager Pro page on the eBay Site

See also the reference documentation for this call:

GetSellingManagerSoldListings - Retrieves information about items that a seller has sold.

Input

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

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

<?xml version="1.0" encoding="utf-8"?>
<GetSellingManagerSaleRecordResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <SellingManagerSoldOrder> SellingManagerSoldOrderType
    <ActualShippingCost currencyID="CurrencyCodeType"> AmountType (double) </ActualShippingCost>
    <AdjustmentAmount currencyID="CurrencyCodeType"> AmountType (double) </AdjustmentAmount>
    <BuyerEmail> string </BuyerEmail>
    <BuyerID> string </BuyerID>
    <CashOnDeliveryCost currencyID="CurrencyCodeType"> AmountType (double) </CashOnDeliveryCost>
    <CreationTime> dateTime </CreationTime>
    <DaysSinceSale> int </DaysSinceSale>
    <EmailsSent> int </EmailsSent>
    <ItemCost currencyID="CurrencyCodeType"> AmountType (double) </ItemCost>
    <NetInsuranceFee currencyID="CurrencyCodeType"> AmountType (double) </NetInsuranceFee>
    <NetShippingFee currencyID="CurrencyCodeType"> AmountType (double) </NetShippingFee>
    <NetTotalAmount currencyID="CurrencyCodeType"> AmountType (double) </NetTotalAmount>
    <NotesFromBuyer> string </NotesFromBuyer>
    <NotesToBuyer> string </NotesToBuyer>
    <NotesToSeller> string </NotesToSeller>
    <OrderStatus> SellingManagerOrderStatusType
      <CheckoutStatus> CheckoutStatusCodeType </CheckoutStatus>
      <eBayPaymentStatus> PaymentStatusCodeType </eBayPaymentStatus>
      <FeedbackReceived> CommentTypeCodeType </FeedbackReceived>
      <FeedbackSent> boolean </FeedbackSent>
      <IntegratedMerchantCreditCardEnabled> boolean </IntegratedMerchantCreditCardEnabled>
      <LastEmailSentTime> dateTime </LastEmailSentTime>
      <PaidStatus> SellingManagerPaidStatusCodeType </PaidStatus>
      <PaidTime> dateTime </PaidTime>
      <PaymentHoldStatus> PaymentHoldStatusCodeType </PaymentHoldStatus>
      <PaymentMethodUsed> BuyerPaymentMethodCodeType </PaymentMethodUsed>
      <PayPalTransactionID> string </PayPalTransactionID>
      <SellerInvoiceNumber> string </SellerInvoiceNumber>
      <SellerInvoiceTime> dateTime </SellerInvoiceTime>
      <ShippedStatus> SellingManagerShippedStatusCodeType </ShippedStatus>
      <ShippedTime> dateTime </ShippedTime>
      <TotalEmailsSent> int </TotalEmailsSent>
    </OrderStatus>
    <SalePrice currencyID="CurrencyCodeType"> AmountType (double) </SalePrice>
    <SaleRecordID> long </SaleRecordID>
    <SellingManagerSoldTransaction> SellingManagerSoldTransactionType
      <InvoiceNumber> string </InvoiceNumber>
      <ItemID> ItemIDType (string) </ItemID>
      <ItemPrice currencyID="CurrencyCodeType"> AmountType (double) </ItemPrice>
      <ItemTitle> string </ItemTitle>
      <OrderLineItemID> string </OrderLineItemID>
      <QuantitySold> int </QuantitySold>
      <SaleRecordID> long </SaleRecordID>
      <Shipment> ShipmentType
        <ShipmentTrackingDetails> ShipmentTrackingDetailsType
          <ShipmentLineItem> ShipmentLineItemType
            <LineItem> LineItemType
              <CountryOfOrigin> string </CountryOfOrigin>
              <Description> string </Description>
              <ItemID> ItemIDType (string) </ItemID>
              <Quantity> int </Quantity>
              <TransactionID> string </TransactionID>
            </LineItem>
            <!-- ... more LineItem nodes allowed here ... -->
          </ShipmentLineItem>
          <ShipmentTrackingNumber> string </ShipmentTrackingNumber>
          <ShippingCarrierUsed> string </ShippingCarrierUsed>
        </ShipmentTrackingDetails>
        <!-- ... more ShipmentTrackingDetails nodes allowed here ... -->
      </Shipment>
      <SubtotalAmount currencyID="CurrencyCodeType"> AmountType (double) </SubtotalAmount>
      <TransactionID> long </TransactionID>
      <Variation> VariationType </Variation>
    </SellingManagerSoldTransaction>
    <!-- ... more SellingManagerSoldTransaction nodes allowed here ... -->
    <ShippingAddress> AddressType
      <CityName> string </CityName>
    </ShippingAddress>
    <ShippingDetails> ShippingDetailsType
      <SalesTax> SalesTaxType
        <SalesTaxPercent> float </SalesTaxPercent>
      </SalesTax>
      <ShippingServiceOptions> ShippingServiceOptionsType
        <ShippingService> token </ShippingService>
        <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
      </ShippingServiceOptions>
      <!-- ... more ShippingServiceOptions nodes allowed here ... -->
    </ShippingDetails>
    <TotalAmount currencyID="CurrencyCodeType"> AmountType (double) </TotalAmount>
    <TotalQuantity> int </TotalQuantity>
    <UnpaidItemStatus> UnpaidItemStatusTypeCodeType </UnpaidItemStatus>
    <VATInsuranceFee currencyID="CurrencyCodeType"> AmountType (double) </VATInsuranceFee>
    <VATRate> VATRateType
      <ItemID> ItemIDType (string) </ItemID>
      <OrderLineItemID> string </OrderLineItemID>
      <TransactionID> string </TransactionID>
      <VATPercent> float </VATPercent>
    </VATRate>
    <!-- ... more VATRate nodes allowed here ... -->
    <VATShippingFee currencyID="CurrencyCodeType"> AmountType (double) </VATShippingFee>
    <VATTotalAmount currencyID="CurrencyCodeType"> AmountType (double) </VATTotalAmount>
  </SellingManagerSoldOrder>
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</GetSellingManagerSaleRecordResponse>

Return Value	Type	Occurrence	Meaning

Call-specific Output Fields [Jump to standard fields]

SellingManagerSoldOrder	SellingManagerSoldOrderType	Always	Contains the data in a Selling Manager Sale Record.
SellingManagerSoldOrder .ActualShippingCost	AmountType (double)	Always	The shipping cost paid by the seller to ship the order line item. For multiple line item orders, it is possible that one order line item will have the shipping cost and the value for the other order line item will be 0.00. Note: This is different from the field of the same name returned by GetOrders and its related calls, which contains the shipping cost paid by the buyer.
SellingManagerSoldOrder .ActualShippingCost [ attribute currencyID ]	CurrencyCodeType	Always	The shipping cost paid by the seller to ship the order line item. For multiple line item orders, it is possible that one order line item will have the shipping cost and the value for the other order line item will be 0.00. Note: This is different from the field of the same name returned by GetOrders and its related calls, which contains the shipping cost paid by the buyer. For a list of possible enumeration values, see CurrencyCodeType.
SellingManagerSoldOrder .AdjustmentAmount	AmountType (double)	Always	Discount, or charge, to which the buyer and seller have agreed. If this value is a positive value, the amount is the extra money that the buyer pays the seller. If this value is a negative value, the amount is a discount the seller gives the buyer.
SellingManagerSoldOrder .AdjustmentAmount [ attribute currencyID ]	CurrencyCodeType	Always	Discount, or charge, to which the buyer and seller have agreed. If this value is a positive value, the amount is the extra money that the buyer pays the seller. If this value is a negative value, the amount is a discount the seller gives the buyer. For a list of possible enumeration values, see CurrencyCodeType.
SellingManagerSoldOrder .BuyerEmail	string	Always	The email of the buyer.
SellingManagerSoldOrder .BuyerID	string	Always	The user ID of the buyer.
SellingManagerSoldOrder .CashOnDeliveryCost	AmountType (double)	Conditionally	The cost of cash-on-delivery.
SellingManagerSoldOrder .CashOnDeliveryCost [ attribute currencyID ]	CurrencyCodeType	Always	The cost of cash-on-delivery. For a list of possible enumeration values, see CurrencyCodeType.
SellingManagerSoldOrder .CreationTime	dateTime	Conditionally	The sale date.
SellingManagerSoldOrder .DaysSinceSale	int	Conditionally	Number of days since the sale.
SellingManagerSoldOrder .EmailsSent	int	Always	Number of emails sent regarding this order.
SellingManagerSoldOrder .ItemCost	AmountType (double)	Conditionally	A SMPro seller can record the cost of the item, as calculated by the seller, in this field.
SellingManagerSoldOrder .ItemCost [ attribute currencyID ]	CurrencyCodeType	Always	A SMPro seller can record the cost of the item, as calculated by the seller, in this field. For a list of possible enumeration values, see CurrencyCodeType.
SellingManagerSoldOrder .NetInsuranceFee	AmountType (double)	Always	Total cost of shipping insurance.
SellingManagerSoldOrder .NetInsuranceFee [ attribute currencyID ]	CurrencyCodeType	Always	Total cost of shipping insurance. For a list of possible enumeration values, see CurrencyCodeType.
SellingManagerSoldOrder .NetShippingFee	AmountType (double)	Conditionally	Total shipping fee.
SellingManagerSoldOrder .NetShippingFee [ attribute currencyID ]	CurrencyCodeType	Always	Total shipping fee. For a list of possible enumeration values, see CurrencyCodeType.
SellingManagerSoldOrder .NetTotalAmount	AmountType (double)	Conditionally	The seller records in this field a net total amount obtained according to the seller's method of calculation. This field is returned for VAT transactions only.
SellingManagerSoldOrder .NetTotalAmount [ attribute currencyID ]	CurrencyCodeType	Always	The seller records in this field a net total amount obtained according to the seller's method of calculation. This field is returned for VAT transactions only. For a list of possible enumeration values, see CurrencyCodeType.
SellingManagerSoldOrder .NotesFromBuyer	string	Conditionally	Notes from the buyer to the seller.
SellingManagerSoldOrder .NotesToBuyer	string	Always	Notes from the seller to the buyer.
SellingManagerSoldOrder .NotesToSeller	string	Conditionally	Notes to self from seller.
SellingManagerSoldOrder .OrderStatus	SellingManagerOrderStatusType	Always	Status of the order regarding payment, shipping, feedback, and other communications.
SellingManagerSoldOrder .OrderStatus.CheckoutStatus	CheckoutStatusCodeType	Conditionally	Indicates the current status of the checkout flow for the order. Applicable values: BuyerRequestsTotal (out) This value indicates that the buyer wants to confirm the total price of the order line item before making a payment. CheckoutComplete (out) This value indicates that the buyer has paid and checkout is complete. CheckoutIncomplete (out) This value indicates that checkout is incomplete, generally because the buyer has not paid yet. CustomCode (out) Reserved for future use. SellerResponded (out) This value indicates that the seller has just responded to the buyer concerning the total price of the order line item. Code so that your app gracefully handles any future changes to this list.
SellingManagerSoldOrder .OrderStatus.eBayPaymentStatus	PaymentStatusCodeType	Conditionally	The success or failure of a buyer's online payment. Applicable values: See eBayPaymentStatus. Code so that your app gracefully handles any future changes to this list.
SellingManagerSoldOrder .OrderStatus.FeedbackReceived	CommentTypeCodeType	Conditionally	The type of feedback received (if feedback was received). Applicable values: See FeedbackReceived. Code so that your app gracefully handles any future changes to this list.
SellingManagerSoldOrder .OrderStatus.FeedbackSent	boolean	Conditionally	Whether the seller has left feedback.
SellingManagerSoldOrder .OrderStatus .IntegratedMerchantCreditCardEnabled	boolean	Conditionally	Indicates whether the order can be paid for through a payment gateway (Payflow) account. If IntegratedMerchantCreditCardEnabled is `true`, then integrated merchant credit card (IMCC) is enabled for credit cards because the seller has a payment gateway account. Therefore, if IntegratedMerchantCreditCardEnabled is `true`, and AmEx, Discover, or VisaMC is returned for an item, then on checkout, an online credit-card payment is processed through a payment gateway account. A payment gateway account is used by sellers to accept online credit cards (Visa, MasterCard, American Express, and Discover). Note: Beginning on May 1, 2019, eBay will no longer support electronic payments through Integrated Merchant Credit Card accounts. To accept online credit card payments from buyers, a seller must use specify PayPal as an accepted payment method, or opt in to eBay Managed Payments program (if the program is available to that seller).
SellingManagerSoldOrder .OrderStatus.LastEmailSentTime	dateTime	Conditionally	The time that the last email was sent.
SellingManagerSoldOrder .OrderStatus.PaidStatus	SellingManagerPaidStatusCodeType	Conditionally	The paid status of the order. Applicable values: See PaidStatus. Code so that your app gracefully handles any future changes to this list.
SellingManagerSoldOrder .OrderStatus.PaidTime	dateTime	Conditionally	Date on which the order was paid.
SellingManagerSoldOrder .OrderStatus.PaymentHoldStatus	PaymentHoldStatusCodeType	Conditionally	Contains the current status of a hold on a PayPal payment. The payment hold that is referred to as a "payment review" hold results from a possible issue with a buyer. The payment hold referred to as a "merchant hold" results from a possible issue with a seller. For more information, please see the link below. Applicable values: See PaymentHoldStatus. Code so that your app gracefully handles any future changes to this list. See PayPal Holds on Payments.
SellingManagerSoldOrder .OrderStatus.PaymentMethodUsed	BuyerPaymentMethodCodeType	Conditionally	The payment method the buyer selected for paying the seller for the order. If checkout is incomplete, PaymentMethodUsed is set to whatever the buyer selected as his or her preference on the Review Your Purchase page. Applicable values: See PaymentMethodUsed. Code so that your app gracefully handles any future changes to this list.
SellingManagerSoldOrder .OrderStatus .PayPalTransactionID	string	Conditionally	Unique identifier of the PayPal transaction for the order.
SellingManagerSoldOrder .OrderStatus .SellerInvoiceNumber	string	Conditionally	The custom invoice number.
SellingManagerSoldOrder .OrderStatus.SellerInvoiceTime	dateTime	Conditionally	The time the invoice was sent. This is a seller-entered value for VAT-enabled sites. It is returned only for business sellers in VAT-enabled sites.
SellingManagerSoldOrder .OrderStatus.ShippedStatus	SellingManagerShippedStatusCodeType	Conditionally	The shipped status of the order. Applicable values: CustomCode (in/out) Reserved for internal or future use. Shipped (in/out) The shipped status is "shipped." Unshipped (in/out) The shipped status is "unshipped." Code so that your app gracefully handles any future changes to this list.
SellingManagerSoldOrder .OrderStatus.ShippedTime	dateTime	Conditionally	The date on which the seller marks the item as shipped, either set by default as the date date the item was marked shipped or set explicitly by the seller using the Edit Sales Record page. Note that sellers have the ability to set this value up to 3 calendar days in the future.
SellingManagerSoldOrder .OrderStatus.TotalEmailsSent	int	Conditionally	The total emails sent.
SellingManagerSoldOrder .SalePrice	AmountType (double)	Conditionally	Amount of the accepted offer for the listing.
SellingManagerSoldOrder .SalePrice [ attribute currencyID ]	CurrencyCodeType	Always	Amount of the accepted offer for the listing. For a list of possible enumeration values, see CurrencyCodeType.
SellingManagerSoldOrder .SaleRecordID	long	Conditionally	The sale record ID. Applicable to Selling Manager users. When an item is sold, Selling Manager generates a sale record. A sale record contains buyer information, shipping, and other information. A sale record is displayed in the Sold view in Selling Manager. Each sale record has a sale record ID. In the following calls, the value for the sale record ID is in the SellingManagerSalesRecordNumber field: GetItemTransactions, GetSellerTransactions, GetOrders, GetOrderTransactions. In the Selling Manager calls, the value for the sale record ID is in the SaleRecordID field. The sale record ID can be for single or multiple line item orders.
SellingManagerSoldOrder .SellingManagerSoldTransaction	SellingManagerSoldTransactionType	Always, repeatable: [1..*]	Information about one line item in the order.
SellingManagerSoldOrder .SellingManagerSoldTransaction .InvoiceNumber	string	Conditionally	Seller's customized invoice number.
SellingManagerSoldOrder .SellingManagerSoldTransaction .ItemID	ItemIDType (string)	Always	Unique identifier for an eBay listing.
SellingManagerSoldOrder .SellingManagerSoldTransaction .ItemPrice	AmountType (double)	Always	Price per item.
SellingManagerSoldOrder .SellingManagerSoldTransaction .ItemPrice [ attribute currencyID ]	CurrencyCodeType	Always	Price per item. For a list of possible enumeration values, see CurrencyCodeType.
SellingManagerSoldOrder .SellingManagerSoldTransaction .ItemTitle	string	Always	The title of the item listing. Max length: 80.
SellingManagerSoldOrder .SellingManagerSoldTransaction .OrderLineItemID	string	Always	A unique identifier for an eBay order line item. .
SellingManagerSoldOrder .SellingManagerSoldTransaction .QuantitySold	int	Always	Total number of identical items sold in the order line item.
SellingManagerSoldOrder .SellingManagerSoldTransaction .SaleRecordID	long	Always	Unique identifier for a Selling Manager sale record. This field is created at the same time as the order line item (transaction). A sale record is displayed in the Sold view in Selling Manager and contains information on the buyer and shipping. In the GetItemTransactions, GetSellerTransactions, GetOrders, and GetOrderTransactions calls, the SaleRecordID value is reflected in the ShippingDetails.SellingManagerSalesRecordNumber field. For orders that occurred within the last 30 days, passing only the SaleRecordID into the GetSellingManagerSoldListings request will return the sale record. However, for sales that occurred more than 30 days ago, the SaleDateRange container must also be used, passing in a date range that includes the date on which the specific sale occurred.
SellingManagerSoldOrder .SellingManagerSoldTransaction .Shipment	ShipmentType	Conditionally	Container consisting of tracking information for the shipment.
SellingManagerSoldOrder .SellingManagerSoldTransaction .Shipment .ShipmentTrackingDetails	ShipmentTrackingDetailsType	Conditionally, repeatable: [0..*]	Container consisting of the tracking number and shipping carrier associated with the shipment of one item (package). Because an order can have multiple line items and/or packages, there can be multiple ShipmentTrackingDetails containers under the Shipment container.
SellingManagerSoldOrder .SellingManagerSoldTransaction .Shipment .ShipmentTrackingDetails .ShipmentLineItem	ShipmentLineItemType	Conditionally	Contains information about one or more order line items in a Global Shipping Program package. Required or returned if the value of ShippingCarrierUsed is `PBI`.
SellingManagerSoldOrder .SellingManagerSoldTransaction .Shipment .ShipmentTrackingDetails .ShipmentLineItem.LineItem	LineItemType	Conditionally, repeatable: [1..*]	Contains information about one order line item in a Global Shipping Program package. The package can contain multiple units of a given order line item, and multiple order line items.
SellingManagerSoldOrder .SellingManagerSoldTransaction .Shipment .ShipmentTrackingDetails .ShipmentLineItem.LineItem .CountryOfOrigin	string	Conditionally	The Country of Manufacture for the order line item; this is required for customs. This should identify the country in which more than 50% of the value of the item was created. This value must conform to the ISO 3166 two-letter country code standard. To see the list of currently supported codes, and the English names associated with each code (e.g., KY="Cayman Islands"), call GeteBayDetails with DetailName set to CountryDetails.
SellingManagerSoldOrder .SellingManagerSoldTransaction .Shipment .ShipmentTrackingDetails .ShipmentLineItem.LineItem .Description	string	Conditionally	The item description of the order line item, based on its ItemID.
SellingManagerSoldOrder .SellingManagerSoldTransaction .Shipment .ShipmentTrackingDetails .ShipmentLineItem.LineItem .ItemID	ItemIDType (string)	Conditionally	Unique identifier for the eBay listing associated with the order line item. A multiple-quantity listing can have multiple order line items, but only one ItemID value. Unless an OrderLineItemID or SKU value is specified in the same node, this field is required for each ItemTransactionID node included in the request.
SellingManagerSoldOrder .SellingManagerSoldTransaction .Shipment .ShipmentTrackingDetails .ShipmentLineItem.LineItem .Quantity	int	Conditionally	The number of units of the order line item in this package; this is required for customs. The seller must ensure that this matches the quantity of the order line item enclosed in the package. This value must be a positive integer, and it can't be greater than the quantity of this item specified in the original transaction.
SellingManagerSoldOrder .SellingManagerSoldTransaction .Shipment .ShipmentTrackingDetails .ShipmentLineItem.LineItem .TransactionID	string	Conditionally	Unique identifier for an eBay order line item (transaction). The TransactionID should match the ItemID specified in each ItemTransactionID node included in the request. Optionally, an OrderLineItemID value can substitute for the ItemID/TransactionID pair. The TransactionID value for auction listings is always `0` since there can be only one winning bidder/one sale for an auction listing.
SellingManagerSoldOrder .SellingManagerSoldTransaction .Shipment .ShipmentTrackingDetails .ShipmentTrackingNumber	string	Conditionally	The tracking number assigned by the shipping carrier to the item shipment. This field and the ShippingCarrierUsed field are mutually dependent. When you submit ShipmentTrackingNumber, you must also supply a value for ShippingCarrierUsed. When you submit ShippingCarrierUsed, you must also supply a value for ShipmentTrackingNumber. The format of the tracking number must be consistent with the format used by the specified shipping carrier (ShippingCarrierUsed). Typically, you should avoid spaces and hyphens. Returned only if set. 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 tracking number is only returned to the buyer or seller, and a string value of `Unavailable` will be returned to all third parties.
SellingManagerSoldOrder .SellingManagerSoldTransaction .Shipment .ShipmentTrackingDetails .ShippingCarrierUsed	string	Conditionally	The name of the shipping carrier used to ship the item. This field and the ShipmentTrackingNumber field are mutually dependent. When you submit ShippingCarrierUsed, you must also supply a value for ShipmentTrackingNumber. When you submit ShipmentTrackingNumber, you must also supply a value for ShippingCarrierUsed. When the site ID is Austria, Poland, or UK, ShippingCarrierUsed can be any value, because it is not checked by eBay. For all other sites, only the following characters are allowed: letters (`a-z`, `A-Z`), numbers (`0-9`), space, and dash (`-`). The site ID is specified in the CompleteSale request header. Note: Commonly used shipping carriers can be found by calling GeteBayDetails with DetailName set to `ShippingCarrierDetails` and examining the returned ShippingCarrierDetails.ShippingCarrier field. ShippingCarrierCodeType also has a list of valid shipping carriers, but eBay cannot guarantee that this enumerated type contains a full, updated list of shipping carriers. For the CompleteSale call: This field is not case sensitive in the CompleteSale request. When using UPS Mail Innovations, supply the value `UPS-MI`. Buyers will subsequently be sent to the UPS Mail Innovations website for tracking status. When using FedEx SmartPost, supply the value `FedEx`. Buyers will subsequently be sent to the FedEx web site for tracking status. For the Get calls: When using the Global Shipping Program, this field returns a value of `PBI`. Applicable values: See ShippingCarrierCodeType
SellingManagerSoldOrder .SellingManagerSoldTransaction .SubtotalAmount	AmountType (double)	Always	This value is calculated by multplying the ItemPrice value by the QuantitySold value.
SellingManagerSoldOrder .SellingManagerSoldTransaction .SubtotalAmount [ attribute currencyID ]	CurrencyCodeType	Always	This value is calculated by multplying the ItemPrice value by the QuantitySold value. For a list of possible enumeration values, see CurrencyCodeType.
SellingManagerSoldOrder .SellingManagerSoldTransaction .TransactionID	long	Always	Unique identifier for an eBay order line item. An order line item is created once there is a commitment from a buyer to purchase an item. Since an auction listing can only have one order line item during the duration of the listing, the TransactionID for auction listings is always 0. Along with its corresponding ItemID, a TransactionID is used and referenced during an order checkout flow and after checkout has been completed.
SellingManagerSoldOrder .SellingManagerSoldTransaction .Variation	VariationType	Conditionally	In a fixed-priced listing, a seller can offer variations of the same item. For example, the seller could create a fixed-priced listing for a t-shirt design and offer the shirt in different colors and sizes. In this case, each color and size combination is a separate variation. Each variation can have a different quantity and price. Due to the possible price differentiation, buyers can buy multiple items from this listing at the same time, but all of the items must be of the same variation. One order line item is created whether one or multiple items of the same variation are purchased. The Variation node contains information about which variation was purchased. Therefore, applications that process order line items should always check to see if this node is present.
SellingManagerSoldOrder .ShippingAddress	AddressType	Always	Shipping address of a buyer.
SellingManagerSoldOrder .ShippingAddress.CityName	string	Conditionally	The city associated with an address on file with eBay. Most addresses include a city name, but not all. For example, Singapore is an island city-state, so `SG` would appear in the Country field, and 'Singapore' or 'Republic of Singapore' would appear in the CountryName field, but the CityName field is not applicable. Max length: GB, DE - 35; US, CA - 40; AU - 80; Other countries - 50.
SellingManagerSoldOrder .ShippingDetails	ShippingDetailsType	Always	The shipping-related details for an order, including flat and calculated shipping costs and shipping insurance costs.
SellingManagerSoldOrder .ShippingDetails.SalesTax	SalesTaxType	Conditionally	This container shows sales tax information for an item in a specific tax jurisdiction. The concept of 'sales tax' is only applicable to eBay US and Canada (English and French) sites. This container can be used in an Add/Revise/Relist/Verify call to set sales tax settings for a specific tax jurisdiction, but it is actually a better practice if a user sets up sales tax rates through the Sales Tax Table tool in My eBay (or by using the SetTaxTable call). A seller's Sales Tax Table is applied to the listing by including the UseTaxTable field in the request and setting its value to `true`. The GetTaxTable call can be used to retrieve the current sales tax rates for different tax jurisdictions. This container is only returned in order management 'Get' calls if sales tax is applicable to the order line item. For eBay Collect and Remit states, the sales tax information is displayed in the Transaction.Taxes container instead. Note: As of September 1, 2020, buyers in over 40 US states will automatically be charged sales tax for eBay purchases. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. So, if a sales tax rate is applied by the seller for a state that is subject to 'eBay Collect and Remit', this sales tax rate will be ignored by eBay during checkout process. For a list of the US states that are currently subject to 'eBay Collect and Remit', see the eBay sales tax collection help topic. Note: For eBay managed payment orders that are subject to 'Collect and Remit' taxes, these taxes will only be shown in the eBayCollectAndRemitTaxes container for line items, and the SalesTax will not be returned at all. For non-eBay managed payment orders, the 'Collect and Remit' taxes will be shown in both the eBayCollectAndRemitTaxes and SalesTax containers. See Enabling Multi-Jurisdiction Sales Tax.
SellingManagerSoldOrder .ShippingDetails.SalesTax .SalesTaxPercent	float	Conditionally	This float value is the sales tax percentage rate applicable to the corresponding tax jurisdiction (US state or Canadian province). Sellers are responsible for providing accurate sales tax rates for each jurisdiction. This sales tax rate comes into play when a buyer from that tax jurisdiction makes a purchase from the seller. The value passed in is stored with a precision of 3 digits after the decimal point (##.###). This field is only returned in order management calls if sales tax applies to the order line item, and is only in GetItem (and other 'Get' calls) if sales tax is applicable to the listing or order line item, and the seller is the person making the call. Although this field will be returned at the order level in order management calls for a single line item order, sales tax is applied at the line item level and not order level. For multiple line item orders, this field will not be returned at all at the order level. Note: As of September 1, 2020, buyers in over 40 US states will automatically be charged sales tax for eBay purchases. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. So, if a sales tax rate is applied to the listing by the seller for a state that is subject to eBay 'Collect and Remit', the sales tax rate in this field is ignored by eBay during the checkout process. For a list of the US states that are currently subject to 'eBay Collect and Remit', see the eBay sales tax collection help topic.
SellingManagerSoldOrder .ShippingDetails .ShippingServiceOptions	ShippingServiceOptionsType	Conditionally, repeatable: [0..*]	This container is used to provide details on a specific domestic shipping service option, including the unique identifier of the shipping service option and the costs related to domestic shipping service. A separate ShippingServiceOptions container is needed for each domestic shipping service option that is available to ship the item. Unless a fulfillment business policy is being used, generally at least one ShippingServiceOptions container will be required. If you specify multiple ShippingServiceOptions nodes, the repeating nodes must be contiguous. For example, you can insert InternationalShippingServiceOption nodes after a list of repeating ShippingServiceOptions nodes, but not between them: `<ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <ShippingServiceOptions>...</ShippingServiceOptions> <InternationalShippingServiceOption>...</InternationalShippingServiceOption> <InternationalShippingServiceOption>...</InternationalShippingServiceOption>` If you specify ShippingDetails when you revise or relist an item but you omit ShippingServiceOptions, eBay will drop the domestic shipping services from the listing. This may also have unintended side effects, as other fields that depend on this data may be dropped as well. To retain the shipping services and dependent fields when you modify other shipping details, it may be simplest to specify all ShippingDetails that you still want to include in the listing. A seller can offer up to four domestic shipping services and up to five international shipping services. However, if the seller is opted in to the Global Shipping Program, only four other international shipping services may be offered (regardless of whether or not Global Shipping is offered for the listing). All specified domestic and international shipping services must be the same shipping type (for example, Flat versus Calculated). Note: If the seller has set the shipping cost model to 'Flat' or 'Calculated' (ShippingDetails.ShippingType field), at least one actual shipping service option must be specified through a ShippingServiceOptions container. In the past, eBay allowed users to set the shipping cost model to 'Flat' or 'Calculated', and then just pass in one ShippingServiceOptions container with the ShippingServiceOptions.ShipppingService value set to a 'Local Pickup' option. Now, sellers must pass in at least one actual domestic shipping service option in addition to any 'Local Pickup' option, or the listing will be blocked with the following error: 17510 - You must specify at least one domestic shipping service, other than or in addition to Local Pickup. For GetItemShipping, results are filtered: if any service is not available in the buyer's region, it is removed. If no services remain after this filtering, a warning is returned. See Repeating (Unbounded) Fields for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1).
SellingManagerSoldOrder .ShippingDetails .ShippingServiceOptions .ShippingService	token	Conditionally	This enumeration value indicates a specific domestic shipping service option being offered by the seller to ship an item to a buyer who is located within the same country as the item. This field is required to identify each domestic shipping service option that is specified with a ShippingServiceOptions container. For a list of valid ShippingService values, call GeteBayDetails with DetailName set to `ShippingServiceDetails`. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing. To view the full list of domestic shipping service options in the response, look for the ShippingServiceDetails.ShippingService fields. Domestic shipping service options will not have a InternationalService = `true` field, as this indicates that the ShippingService value is an International shipping service option. See GeteBayDetails. Applicable values: See ShippingServiceCodeType
SellingManagerSoldOrder .ShippingDetails .ShippingServiceOptions .ShippingServiceCost	AmountType (double)	Conditionally	The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item. Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping=true), the seller still needs to include this ShippingServiceCost field and set its value to `0.0`, as eBay will not do this automatically. When returned by GetItemShipping, it includes the packaging and handling cost. Note that if ShippingService is set to `LocalPickup`, ShippingServiceCost must be set to `0.0`. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code.
SellingManagerSoldOrder .ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ]	CurrencyCodeType	Always	The base cost of shipping one unit of the item using the shipping service specified in the corresponding ShippingService field. In the case of a multiple-quantity, fixed-price listing, the ShippingServiceAdditionalCost field also becomes applicable, and shows the cost to ship each additional unit of the item if the buyer purchases multiple quantity of the same line item. Note: If the corresponding shipping service option is set as a 'free shipping' option (FreeShipping=true), the seller still needs to include this ShippingServiceCost field and set its value to `0.0`, as eBay will not do this automatically. When returned by GetItemShipping, it includes the packaging and handling cost. Note that if ShippingService is set to `LocalPickup`, ShippingServiceCost must be set to `0.0`. Also, if a shipping service has been specified (even LocalPickup), GetItem returns the shipping service cost, even if the cost is zero. If this is for calculated shipping for a listing that has not yet ended, note that the cost cannot be determined until the listing has ended and the buyer has specified a postal code. For a list of possible enumeration values, see CurrencyCodeType.
SellingManagerSoldOrder .TotalAmount	AmountType (double)	Always	Total cost in the order.
SellingManagerSoldOrder .TotalAmount [ attribute currencyID ]	CurrencyCodeType	Always	Total cost in the order. For a list of possible enumeration values, see CurrencyCodeType.
SellingManagerSoldOrder .TotalQuantity	int	Conditionally	Total item quantity.
SellingManagerSoldOrder .UnpaidItemStatus	UnpaidItemStatusTypeCodeType	Conditionally	The status of an unpaid item regarding final value, state of communications between buyer and seller, and the filing of an Unpaid Item. Applicable values: See UnpaidItemStatus. Code so that your app gracefully handles any future changes to this list.
SellingManagerSoldOrder .VATInsuranceFee	AmountType (double)	Conditionally	Amount of applicable value added tax insurance fee.
SellingManagerSoldOrder .VATInsuranceFee [ attribute currencyID ]	CurrencyCodeType	Always	Amount of applicable value added tax insurance fee. For a list of possible enumeration values, see CurrencyCodeType.
SellingManagerSoldOrder .VATRate	VATRateType	Conditionally, repeatable: [0..*]	Rate of applicable value added tax.
SellingManagerSoldOrder .VATRate.ItemID	ItemIDType (string)	Conditionally	Unique identifier for an eBay listing. A listing can have multiple order line items (transactions), but only one ItemID. An ItemID can be paired up with a corresponding TransactionID and used as an input filter for ReviseSellingManagerSaleRecord. However, if OrderID is passed in as an input filter for ReviseSellingManagerSaleRecord, the ItemID/TransactionID pair is ignored.
SellingManagerSoldOrder .VATRate.OrderLineItemID	string	Conditionally	OrderLineItemID is a unique identifier for an eBay order line item If a VAT rate is specified in the ReviseSellingManagerSaleRecord request, OrderLineItemID can be used instead of ItemID and TransactionID. Max length: 50 (Note: The eBay database specifies 38. ItemIDs and TransactionIDs are usually 9 to 12 digits.).
SellingManagerSoldOrder .VATRate.TransactionID	string	Conditionally	Unique identifier for an eBay sales transaction. This identifier is created once there is a commitment from a buyer to purchase an item. Along with its corresponding ItemID, a TransactionID is used and referenced during an order checkout flow and after checkout has been completed. The ItemID/TransactionID pair can be used as an input filter for ReviseSellingManagerSaleRecord. However, if OrderID is passed in as an input filter for ReviseSellingManagerSaleRecord, the ItemID/TransactionID pair is ignored. The TransactionID value for auction listings is always `0` since there can be only one winning bidder/one sale for an auction listing.
SellingManagerSoldOrder .VATRate.VATPercent	float	Conditionally	The VAT (Value-Added Tax) rate for the order line item. When the VATPercent is specified, the item's VAT information appears on the item's listing page. In addition, the seller can choose to print an invoice that includes the item's net price, VAT percent, VAT amount, and total price. Since VAT rates vary depending on the item and on the user's country of residence, a seller is responsible for entering the correct VAT rate; it is not calculated by eBay. To specify a VATPercent, a seller must have a VAT-ID registered with eBay and must be listing the item on a VAT-enabled site. Max applicable length is 6 characters, including the decimal (e.g., 12.345). The scale is 3 decimal places. (If you pass in 12.3456, eBay may round up the value to 12.346.) Note: The View Item page may display the precision to 2 decimal places with no trailing zeros. However, the full value you send in is stored. Min: 0. Max: 30.
SellingManagerSoldOrder .VATShippingFee	AmountType (double)	Conditionally	VAT shipping fee.
SellingManagerSoldOrder .VATShippingFee [ attribute currencyID ]	CurrencyCodeType	Always	VAT shipping fee. For a list of possible enumeration values, see CurrencyCodeType.
SellingManagerSoldOrder .VATTotalAmount	AmountType (double)	Conditionally	VAT total amount.
SellingManagerSoldOrder .VATTotalAmount [ attribute currencyID ]	CurrencyCodeType	Always	VAT total amount. For a list of possible enumeration values, see CurrencyCodeType.

Standard Output Fields

Ack	AckCodeType	Always	A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for the Ack field. Applicable values: CustomCode (out) Reserved for internal or future use. Failure (out) This value indicates that the call request processing failed. Success (out) This value indicates that the call request was processed successfully without any issues. Warning (out) This value indicates that the call request was successful, but processing was not without any issues. These issues can be checked in the Errors container, that will also be returned when one or more known issues occur with the call request. (Not all values in AckCodeType apply to this field.) Code so that your app gracefully handles any future changes to this list.
Build	string	Always	This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID	string	Conditionally	Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors	ErrorType	Conditionally, repeatable: [0..*]	A list of application-level errors (if any) that occurred when eBay processed the request.
Errors.ErrorClassification	ErrorClassificationCodeType	Conditionally	API errors are divided between two classes: system errors and request errors. Applicable values: CustomCode (out) Reserved for internal or future use. RequestError (out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. SystemError (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form. Code so that your app gracefully handles any future changes to this list.
Errors.ErrorCode	token	Conditionally	A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document.
Errors.ErrorParameters	ErrorParameterType	Conditionally, repeatable: [0..*]	This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters [ attribute ParamID ]	string	Conditionally	This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters.Value	string	Conditionally	This is the value of the request parameter noted in the ParamID attribute. So, if the ParamID value was ItemID, the value in this field would be the actual value of that ItemID.
Errors.LongMessage	string	Conditionally	A more detailed description of the condition that raised the error.
Errors.SeverityCode	SeverityCodeType	Conditionally	Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. Applicable values: CustomCode (out) Reserved for internal or future use. Error (out) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data. If the source of the problem is within the application (such as a missing required element), change the application before you retry the request. If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to eBay. If the source of the problem is on eBay's side, An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form. See the Compatible Application Check section of the eBay Features Guide for more information. Warning (out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning. When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future. Code so that your app gracefully handles any future changes to this list.
Errors.ShortMessage	string	Conditionally	A brief description of the condition that raised the error.
HardExpirationWarning	string	Conditionally	Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp	dateTime	Always	This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the Time Values section in the eBay Features Guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version	string	Always	The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response.

Detail Controls

DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.

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

Returns a record of an item sale.

Description

User m***************r sold one of her Harry Potter books. She needs the shipping address of the buyer. She calls GetSellingManagerSaleRecord, specifying the item ID and transaction ID.

Input

The fields in the following GetSellingManagerSaleRecord sample are used to obtain sales and order line item information for a sold item. Both the ItemID and TransactionID are required input fields.

XML format.

<?xml version="1.0" encoding="utf-8"?>
<GetSellingManagerSaleRecordRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>A*******3</eBayAuthToken>
  </RequesterCredentials>
  <ItemID>1**********9</ItemID>
  <TransactionID>7**********7</TransactionID>
</GetSellingManagerSaleRecordRequest>

Output

The response includes the shipping address needed by m***************r. The response also includes the sale price.

XML format.
<?xml version="1.0" encoding="utf-8"?>
<GetSellingManagerSaleRecordResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2019-11-05T22:07:43.564Z</Timestamp>
  <Ack>Success</Ack>
  <Version>1131</Version>
  <Build>E1131_UNI_API5_19098188_R1</Build>
  <SellingManagerSoldOrder>
    <SellingManagerSoldTransaction>
      <ItemID>1**********9</ItemID>
      <QuantitySold>1</QuantitySold>
      <ItemPrice currencyID="CAD">300.0</ItemPrice>
      <SubtotalAmount currencyID="CAD">300.0</SubtotalAmount>
      <ItemTitle>SDK item title</ItemTitle>
    </SellingManagerSoldTransaction>
    <ShippingAddress>
      <Name>V**********o</Name>
      <Street1>2***** *** ******</Street1>
      <CityName>Ventura</CityName>
      <StateOrProvince>CA</StateOrProvince>
      <Country>US</Country>
      <PostalCode>93003</PostalCode>
    </ShippingAddress>
    <TotalAmount currencyID="CAD">300.0</TotalAmount>
    <ActualShippingCost currencyID="CAD">0.0</ActualShippingCost>
    <AdjustmentAmount currencyID="CAD">0.0</AdjustmentAmount>
    <OrderStatus>
      <CheckoutStatus>CheckoutIncomplete</CheckoutStatus>
      <PaymentMethodUsed>None</PaymentMethodUsed>
      <PaymentHoldStatus>None</PaymentHoldStatus>
    </OrderStatus>
    <EmailsSent>0</EmailsSent>
    <BuyerID>G*********r</BuyerID>
    <BuyerEmail>S**********************@****.com</BuyerEmail>
  </SellingManagerSoldOrder>
</GetSellingManagerSaleRecordResponse>

Change History

Change Date	Description
1189 2021-01-15	(deprecated) This call is being deprecated. It will no longer be supported after June 1, 2021.
1157 2020-06-05	Order.OrderID (modified): Beginning in June 2020, only the new order ID format will be returned in response payloads for paid orders, regardless of the WSDL version number or compatibility level.
1145 2020-03-13	OrderID (doc change): Updated OrderID request field description to state that beginning in April 2020, users will no longer be able to control whether returned order ID values for paid orders are in the old or new format, regardless of the WSDL version number and/or compatibility level. Previously, when the new order ID format was introduced in June 2019, the user could control whether they wanted to see the new or old order ID format in response payloads. Note that with the new order ID format, the unique identifier of an order will change as the order goes from unpaid to paid status. For Trading API calls that support OrderID as a request filter, the OrderID request field will still accept order ID values for unpaid orders, but once payment has been made for an order, sellers are advised to use the unique identifier for the paid order, as this will be the permanent identifier of the order once payment occurs, and the order ID that is also known to the buyer.
1113 2019-06-21	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. The format (old or new) that is returned in response payloads is dependent on the WSDL version and/or compatibility level. See the 1113 Release Notes for more details.
1107 2019-05-10	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.
1085 2018-10-26	ShippingDetails.SalesTax (doc change): Added a note to state that the Sales Tax rate for a US tax jurisdiction that is subject to the 'eBay Collect and Remit Tax' program will be ignored during the checkout process, since eBay will be collecting and remitting this tax to the tax authorities without the seller's involvement.
1031 2017-09-01	ShippingDetails.InsuranceDetails (deprecated): This container and InsuranceDetailsType have been deprecated, as it is no longer possible/applicable for sellers to offer shipping insurance to buyers on any eBay site.
1027 2017-08-04	ShipmentType.Notes (deprecated): The Notes field is being deprecated since this field is only applicable for Half.com orders, and API support for Half.com orders is being deprecated.
0959 2016-03-11	Shipment.ShipmentLineItem (doc change): Previously, the documentation for this call erroneously indicated that Shipment.ShipmentLineItem was conditionally included in the response. In fact, the ShipmentLineItem container was and is part of ShipmentTrackingDetails, and the documentation now displays only Shipment.ShipmentTrackingDetails.ShipmentLineItem in the response prototype.
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.
0945 2015-10-15	BuyerPaymentMethodCodeType (modified): Moneybookers, ProPay, or Paymate will no longer be accepted as valid PaymentMethods for new listings. However, these payment methods will still be allowed for existing listings, so these values may still get returned until these payment methods are completely removed from all listings.
0911 2015-02-20	ShipmentTrackingDetails.ShippingCarrierUsed (doc change): Previous Trading API documentation incorrectly stated that the shipping carrier name returned for the international leg of a Global Shipping Program shipment was `GlobalShipping_MultiCarrier`. The value actually returned in the ShippingCarrierUsed field for Global Shipping is `PBI`.
0899 2014-11-04	BuyerPaymentMethodCodeType (modified): 'QIWI' added as enumeration value. This payment method can only be specified on the US site and is only applicable to Russian buyers.
0849 2013-11-05	OrderStatus.PaymentMethodUsed (modified): 'CreditCard' and 'DirectDebit' added as acceptable buyer payment methods. These two values will only be returned for eBay Now-enabled listings. ShippingServiceOptions.ShippingService (modified): 'eBayNowImmediateDelivery' added as an acceptable value in the ShippingService field. This value will only be returned for eBay Now-enabled listings.
0807 2013-01-23	SellingManagerSoldOrder.ActualShippingCost (doc change): Clarified that SellingManagerSoldOrder.ActualShippingCost is tThe shipping cost paid by the seller to ship an order line item. This is different from the field of the same name returned by GetOrders and its related calls, which contains the shipping cost paid by the buyer.
0781 2012-07-04	ShippingServiceCodeType (modified): AU_StandardDeliveryFromOutsideAU added as a shipping service option. This option can be specified by sellers on the AU site if the item is being shipped from a location outside of Australia using standard delivery.
0777 2012-06-06	ShipmentLineItem (added): ShipmentLineItem is returned in SellingManagerSoldOrder.SellingManagerSoldTransaction.Shipment or SellingManagerSoldOrder.SellingManagerSoldTransaction.Shipment.ShipmentTrackingDetails, and contains information about one or more order line items in a Global Exchange package. It's returned in ShipmentTrackingDetails if you're providing tracking information for the domestic leg of the shipment. ShipmentLineItem.LineItem (added): Contains information about one order line item in a Global Exchange package, including the Country of Manufacture and the number of units of the order line item in the package, both of which are required for customs. The package can contain multiple order line items.
0771 2012-04-25	SellingManagerSoldOrder.RefundAmount (added): This field indicates the dollar amount of a refund (if any) that was issued to the buyer. This field only applies to DE/AT orders going through the new eBay payment process. SellingManagerSoldOrder.RefundStatus (added): This field indicates the result of a refund (Success, Failure, Pending). This field only applies to DE/AT orders going through the new eBay payment process.
0741 2011-09-28	eBayPaymentStatus.Paid (added): New enum value that indicates that the buyer has paid for an order.
0735 2011-08-17	SellingManagerSoldOrder.OrderStatus.PaymentMethodUsed (deprecated): StandardPaymentMethod is no longer returned.
0731 2011-07-20	PaymentHoldStatusCodeType (modified): ReleaseConfirmed, ReleaseFailed, and ReleasePending added as enumeration values to capture the status of the release of funds to a seller's account.
0719 2011-04-27	ShippingServiceCodeType (modified): 15 new shipping services added for the Australia and Canada sites. The nine new Australia carrier-specific shipping services include AU_AusPostRegisteredPostInternationalPaddedBag1kg, AU_AusPostRegisteredPostInternationalPaddedBag500g, AU_AusPostRegisteredPostInternationalParcel, AU_AustralianAirExpressFlatRate1kg, AU_AustralianAirExpressFlatRate3kg, AU_AustralianAirExpressFlatRate5kg, AU_AustralianAirExpressMetro15kg, AU_eBayAusPost3kgFlatRateSatchel, and AU_eBayAusPost500gFlatRateSatchel. The nine new Australia generic service level shipping services include AU_EconomyDeliveryFromOutsideAU, AU_ExpeditedDeliveryFromOutsideAU, AU_ExpressDelivery, AU_Freight, and AU_StandardDelivery. The new Canada shipping service is CA_Freight. Item.ShippingDetails.ShippingServiceOptions (modified): '4' has been added as a valid integer value to account for the additional international shipping service that may be specified by the seller. PaymentHoldStatusCodeType (added): New code type that indicates the type and/or status of a payment hold.
0705 2011-01-19	OrderLineItemID (modified): The OrderLineItemID value can now be used in Production to identify an order line item (instead of ItemID/TransactionID pair). An OrderLineItemID value can also be passed into the OrderID field (for single line item orders only).
0691 2010-10-14	OrderLineItemID (added): A unique identifier for an eBay transaction, which is based upon the concatenation of ItemID and TransactionID with a hyphen in between these two IDs. OrderLineItemID can only be specified in the input or returned in the output if you set your request version to 705.
0663 2010-03-31	PaymentHoldStatus (modified): If a new seller hold applies to the buyer's payment, a PaymentHoldStatus of NewSellerHold is returned.
0635 2009-09-16	InsuranceDetails, InsuranceFee, InsuranceOption, InternationalInsuranceDetails, InsuranceWanted, ShippingInsuranceCost (modified): Sellers can no longer give buyers the option to purchase shipping insurance for either domestic or international items. The buyer-paid shipping insurance option has been removed from the following sites: `BEFR, BENL, CA, CAFR, HK, IE, IN, MY, Motors, NL, PH, PL, SG, UK, US` Insurance tags are returned only when the associated item has buyer-paid shipping insurance values. Shipment (modified): The ShippingCarrierUsed and ShipmentTrackingNumber elements have been combined and moved into the new ShipmentTrackingDetails container, which is returned as a node within the Shipment container. ShipmentTrackingDetails is a repeatable container, allowing you to list details for multiple packages shipped for a single item purchased by a buyer. With this refinement, ShippingCarrierUsed and ShipmentTrackingNumber are no longer returned as individual child elements of Shipment.
0627 2009-07-22	ShippingCarrierUsed (modified): For request version 627 and greater, whatever value of ShippingCarrierUsed was specified by CompleteSale is returned by GetSellingManagerSaleRecord. For lower request versions, if the value specified in CompleteSale is not a value in ShippingServiceCodeType, ShippingServiceCodeType.Other is returned.
0589 2008-10-29	(added) New call.

ItemID	ItemIDType (string)	Conditional	Unique identifier for the eBay listing associated with the Selling Manager sale record. Unless the OrderID or OrderLineItemID value is specified in the request, the ItemID and TransactionID fields must be used to identify the Selling Manager sale record to retrieve. You can use GetSellingManagerSoldListings to retrieve the ItemID, TransactionID or OrderLineItemID values that correspond to the Selling Manager sale record (SaleRecordID). All four of these fields are returned under the SellingManagerSoldTransaction container of the GetSellingManagerSoldListings request.
OrderID	OrderIDType (string)	Conditional	A unique identifier that identifies a single line item or multiple line item order associated with the Selling Manager sale record(s). If an OrderID is used in the request, the OrderLineItemID and ItemID/TransactionID pair are not required. 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. Sellers can check to see if an order has been paid by looking for a value of 'CheckoutComplete' in the OrderStatus.CheckoutStatus field in the response of GetSellingManagerSaleRecord or call. Sellers should not fulfill orders until buyer has made payment. When using a GetSellingManagerSaleRecord call to retrieve a sale record associated with a specific order, either of these order IDs (paid or unpaid status) can be used to identify the order. Max length: 40.
OrderLineItemID	string	Conditional	A unique identifier for an eBay order line item that is associated with the Selling Manager sale record. This field is created as soon as there is a commitment to buy (bidder wins the auction, buyer clicks buy button, or buyer purchases item through PlaceOffer call). You can use GetSellingManagerSoldListings to retrieve the ItemID, TransactionID or OrderLineItemID values that correspond to the Selling Manager sale record (SaleRecordID). All four of these fields are returned under the SellingManagerSoldTransaction container of the GetSellingManagerSoldListings request. Unless an OrderID or an ItemID/TransactionID pair is specified in the GetSellingManagerSaleRecord request, the OrderLineItemID field is required.
TransactionID	string	Conditional	Unique identifier for the sales transaction associated with the Selling Manager sale record. Unless the OrderID or OrderLineItemID value is specified in the request, the ItemID and TransactionID fields must be used to identify the Selling Manager sale record to retrieve. You can use GetSellingManagerSoldListings to retrieve the ItemID, TransactionID or OrderLineItemID values that correspond to the Selling Manager sale record (SaleRecordID). All four of these fields are returned under the SellingManagerSoldTransaction container of the GetSellingManagerSoldListings request. The TransactionID value for auction listings is always `0` since there can be only one winning bidder/one sale for an auction listing.