GetSellingManagerSaleRecord

Requests the data in a Selling Manager sale record.

Note: This call is subject to change without notice; the deprecation process is inapplicable to this call.

Prerequisites

To use this call, you must be a Selling Manager Pro subscriber. Use the following flow. First, call GetSellingManagerSoldListings. Next, use the output fields, "ItemID" and "TransactionID", from the same SalesRecord as input fields in the GetSellingManagerSaleRecord request call.

Related Information

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

See also the reference documentation for these calls:

AddSellingManagerTemplate - Adds a Selling Manager template.
GetSellingManagerTemplates - Retrieves Selling Manager templates.

GetSellingManagerSaleRecord Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

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

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<GetSellingManagerSaleRecordResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType 
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType 
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
  <!-- Call-specific Output Fields -->
  <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>
      <QuantitySold> int </QuantitySold>
      <SaleRecordID> long </SaleRecordID>
      <Shipment> ShipmentType 
        <ShipmentTrackingDetails> ShipmentTrackingDetailsType 
          <ShipmentTrackingNumber> string </ShipmentTrackingNumber>
          <ShippingCarrierUsed> string </ShippingCarrierUsed>
        </ShipmentTrackingDetails>
        <!-- ... more ShipmentTrackingDetails nodes here ... -->
      </Shipment>
      <SubtotalAmount currencyID="CurrencyCodeType"> AmountType (double) </SubtotalAmount>
      <TransactionID> long </TransactionID>
      <Variation> VariationType 
      </Variation>
    </SellingManagerSoldTransaction>
    <!-- ... more SellingManagerSoldTransaction nodes here ... -->
    <ShippingAddress> AddressType 
      <CityName> string </CityName>
    </ShippingAddress>
    <ShippingDetails> ShippingDetailsType 
      <InsuranceDetails> InsuranceDetailsType 
        <InsuranceFee currencyID="CurrencyCodeType"> AmountType (double) </InsuranceFee>
        <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
      </InsuranceDetails>
      <SalesTax> SalesTaxType 
        <SalesTaxPercent> float </SalesTaxPercent>
      </SalesTax>
      <ShippingServiceOptions> ShippingServiceOptionsType 
        <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
      </ShippingServiceOptions>
      <!-- ... more ShippingServiceOptions nodes 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>
      <TransactionID> string </TransactionID>
      <VATPercent> float </VATPercent>
    </VATRate>
    <!-- ... more VATRate nodes here ... -->
    <VATShippingFee currencyID="CurrencyCodeType"> AmountType (double) </VATShippingFee>
    <VATTotalAmount currencyID="CurrencyCodeType"> AmountType (double) </VATTotalAmount>
  </SellingManagerSoldOrder>
</GetSellingManagerSaleRecordResponse>

Return Value	Type	Occurrence	Meaning

Standard Output Fields [Jump to call-specific fields]

Ack	AckCodeType	Always	A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack. Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.)
Build	string	Always	This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID	string	Conditionally	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors	ErrorType	Conditionally, repeatable: [0..*]	A list of application-level errors (if any) that occurred when eBay processed the request. See Error Handling.
Errors.ErrorClassification	ErrorClassificationCodeType	Conditionally	API errors are divided between two classes: system errors and request errors. Applicable values: • CustomCode (out) Reserved for internal or future use. • RequestError (out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. • SystemError (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
Errors.ErrorCode	token	Conditionally	A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document.
Errors.ErrorParameters	ErrorParameterType	Conditionally, repeatable: [0..*]	This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters [ attribute ParamID ]	string	Conditionally	The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value	string	Conditionally	The value of the variable (e.g., the attribute set ID)
Errors.LongMessage	string	Conditionally	A more detailed description of the condition that raised the error.
Errors.SeverityCode	SeverityCodeType	Conditionally	Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. Applicable values: • CustomCode (out) Reserved for internal or future use • Error (out) Application-level error • Warning (out) Warning or informational error
Errors.ShortMessage	string	Conditionally	A brief description of the condition that raised the error.
HardExpirationWarning	string	Conditionally	Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp	dateTime	Always	This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version	string	Always	The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.

Call-specific Output Fields
SellingManagerSoldOrder	SellingManagerSoldOrderType	Always	Contains the data in a Selling Manager sale record.
SellingManagerSoldOrder .ActualShippingCost	AmountType (double)	Always	Actual shipping cost paid by the seller to ship the item.
SellingManagerSoldOrder .ActualShippingCost [ attribute currencyID ]	CurrencyCodeType	Always	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. 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	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. 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	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. 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	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. 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	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
SellingManagerSoldOrder .NetShippingFee	AmountType (double)	Conditionally	Total shipping fee.
SellingManagerSoldOrder .NetShippingFee [ attribute currencyID ]	CurrencyCodeType	Always	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. 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	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. 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	The current status of checkout for the transaction. Applicable values: • BuyerRequestsTotal (out) Buyer requests total from seller. • CheckoutComplete (out) Checkout complete. • CheckoutIncomplete (out) Checkout incomplete--no details specified. • CustomCode (out) Reserved for future use. • SellerResponded (out) Seller responded to buyer's request.
SellingManagerSoldOrder .OrderStatus.eBayPaymentStatus	PaymentStatusCodeType	Conditionally	The success or failure of a buyer's online payment. Applicable values: • BuyerCreditCardFailed (out) The buyer's credit card failed. • BuyerECheckBounced (out) The buyer's eCheck bounced. • BuyerFailedPaymentReportedBySeller (out) The seller reports that the buyer's payment failed. • CustomCode (out) Reserved for internal or future use. • NoPaymentFailure (out) No payment failure. • PaymentInProcess (out) Currently for eBay Germany only. • PayPalPaymentInProcess (out) The payment from buyer to seller is in PayPal process, but has not yet been completed.
SellingManagerSoldOrder .OrderStatus.FeedbackReceived	CommentTypeCodeType	Conditionally	The type of feedback received (if feedback was received). Applicable values: • CustomCode (in/out) Reserved for internal or future use. • IndependentlyWithdrawn (in/out) Applies to the eBay Motors site only. Feedback is withdrawn based on the decision of a third party. • Negative (in/out) Negative feedback. Decreases total feedback score. • Neutral (in/out) Neutral feedback. No effect on total feedback score. • Positive (in/out) Positive feedback. Increases total feedback score. • Withdrawn (in/out) Withdrawn feedback. Removes the effect of the original feedback on total feedback score. Comments from withdrawn feedback are still visible.
SellingManagerSoldOrder .OrderStatus.FeedbackSent	boolean	Conditionally	Whether the seller has left feedback.
SellingManagerSoldOrder .OrderStatus .IntegratedMerchantCreditCardEnabled	boolean	Conditionally	Indicates whether the item 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).
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: • CustomCode (in/out) Reserved for internal or future use. • Paid (in/out) The status of the order is "paid." • PartiallyPaid (in/out) The status of the order is "partially paid." • Pending (in/out) The status of the order is "pending." • Refunded (in/out) The status of the order is "refunded." • Unpaid (in/out) The status of the order is "unpaid."
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: • CustomCode (out) Reserved for internal or future use. • MerchantHold (out) The payment hold referred to as a "merchant hold" results from a possible issue with a seller. If this value is returned, then the following values, as a result, will be returned: In GetMyeBaySelling, PaidWithPayPal is returned in TransactionArray.Transaction.SellerPaidStatus. In GetMyeBayBuying, PaidWithPayPal is returned in TransactionArray.Transaction.BuyerPaidStatus. • None (out) Indicates that there is no payment review hold and no merchant hold. • PaymentReview (out) The payment hold referred to as a "payment review" hold results from a possible issue with a buyer. If this value is returned, then the following values, as a result, will be returned: In GetMyeBaySelling, NotPaid is returned in TransactionArray.Transaction.SellerPaidStatus. In GetMyeBayBuying, PaidWithPayPal is returned in TransactionArray.Transaction.BuyerPaidStatus. • Released (out) Indicates that a payment hold has been released. See Holds on PayPal Payments.
SellingManagerSoldOrder .OrderStatus.PaymentMethodUsed	BuyerPaymentMethodCodeType	Conditionally	The payment method the buyer selected for paying the seller for the transaction. 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.
SellingManagerSoldOrder .OrderStatus .PayPalTransactionID	string	Conditionally	The PayPal transaction ID.
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."
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.
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	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. 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 one transaction or for an order (which contains multiple transactions).
SellingManagerSoldOrder .SellingManagerSoldTransaction	SellingManagerSoldTransactionType	Always, repeatable: [1..*]	Information about one transaction in the order.
SellingManagerSoldOrder .SellingManagerSoldTransaction .InvoiceNumber	string	Conditionally	Seller's customized invoice number.
SellingManagerSoldOrder .SellingManagerSoldTransaction .ItemID	ItemIDType (string)	Always	ID of the item involved in the transaction.
SellingManagerSoldOrder .SellingManagerSoldTransaction .ItemPrice	AmountType (double)	Always	Price of each item.
SellingManagerSoldOrder .SellingManagerSoldTransaction .ItemPrice [ attribute currencyID ]	CurrencyCodeType	Always	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
SellingManagerSoldOrder .SellingManagerSoldTransaction .ItemTitle	string	Always	Title of the item.
SellingManagerSoldOrder .SellingManagerSoldTransaction .QuantitySold	int	Always	Total number of items sold in the transaction.
SellingManagerSoldOrder .SellingManagerSoldTransaction .SaleRecordID	long	Always	The sale record ID. 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 one transaction or for an order (which contains multiple transactions).
SellingManagerSoldOrder .SellingManagerSoldTransaction .Shipment	ShipmentType	Conditionally	Details about the shipment.
SellingManagerSoldOrder .SellingManagerSoldTransaction .Shipment .ShipmentTrackingDetails	ShipmentTrackingDetailsType	Conditionally, repeatable: [0..*]	Container for the shipping carrier and tracking information associated with an item shipment. This is a repeatable container, allowing for multiple package shipments to be input for a single item transaction.
SellingManagerSoldOrder .SellingManagerSoldTransaction .Shipment .ShipmentTrackingDetails .ShipmentTrackingNumber	string	Conditionally	The tracking number assigned by the shipping carrier to the item shipment. The format of the tracking number must be consistent with the format used by the specified shipping carrier (ShippingCarrierUsed).
SellingManagerSoldOrder .SellingManagerSoldTransaction .Shipment .ShipmentTrackingDetails .ShippingCarrierUsed	string	Conditionally	Name of the shipping carrier used to ship the item.
SellingManagerSoldOrder .SellingManagerSoldTransaction .SubtotalAmount	AmountType (double)	Always	The subtotal is the item price multiplied by the quantity of items.
SellingManagerSoldOrder .SellingManagerSoldTransaction .SubtotalAmount [ attribute currencyID ]	CurrencyCodeType	Always	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
SellingManagerSoldOrder .SellingManagerSoldTransaction .TransactionID	long	Always	ID of the transaction.
SellingManagerSoldOrder .SellingManagerSoldTransaction .Variation	VariationType	Conditionally	Variations are multiple similar (but not identical) items in a single fixed-price (or Store Inventory Format) listing. For example, a single listing could contain multiple items of the same brand and model that vary by color and size (like "Blue, Large" and "Black, Medium"). Each variation can have its own quantity and price. When a user purchases items from a multi-variation listing, this Variation node contains information about which variation was purchased. Therefore, applications that process transactions should always check to see if this node is present. A single transaction can contain items from only one variation.
SellingManagerSoldOrder .ShippingAddress	AddressType	Always	Shipping address of a buyer.
SellingManagerSoldOrder .ShippingAddress.CityName	string	Always	The name of the user's city. Also applicable to Half.com (for GetOrders). Max length: 64.
SellingManagerSoldOrder .ShippingDetails	ShippingDetailsType	Always	The shipping-related details for an item or transaction, including flat and calculated shipping costs and shipping insurance costs.
SellingManagerSoldOrder .ShippingDetails .InsuranceDetails	InsuranceDetailsType	Always	Container for domestic insurance information. Note that there are fields named InsuranceFee and InsuranceOption at the same level as this container. These were once used for representing both domestic and international insurance details. If this (newer) container is provided on input and if ShippingDetails.InsuranceFee or ShippingDetails.InsuranceOption are also provided, those two (older fields) are ignored. If this container is omitted on input, its InsuranceFee and InsuranceOption subfields are set to match whatever (the older fields) ShippingDetails.InsuranceFee and ShippingDetails.InsuranceOption are set to. For flat and calculated shipping, depending on which subfields are used. Valid only on the following sites: AU, FR, and IT
SellingManagerSoldOrder .ShippingDetails .InsuranceDetails.InsuranceFee	AmountType (double)	Always	Cost of shipping insurance set by the seller. If the buyer bought more than one of this item, this is the insurance for just a single item. Exception: for GetItemShipping, this is proportional to QuantitySold. Default is 0.00. Value should be greater than 0.00 if InsuranceOption is Optional or Required. For flat shipping only. Optional as input and only allowed if ChangePaymentInstructions is true. Valid only on the following sites: AU, FR, and IT Applicable to Half.com (for GetOrders).
SellingManagerSoldOrder .ShippingDetails .InsuranceDetails.InsuranceFee [ attribute currencyID ]	CurrencyCodeType	Always	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
SellingManagerSoldOrder .ShippingDetails .InsuranceDetails .InsuranceOption	InsuranceOptionCodeType	Always	Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Applies to both flat and calculated shipping. Optional as input and only allowed if ChangePaymentInstructions is true. Valid only on the following sites: AU, FR, and IT Applicable to Half.com (for GetOrders). Applicable values: • CustomCode (in/out) Reserved for internal or future use • IncludedInShippingHandling (in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost. • NotOffered (in/out) The seller does not offer shipping insurance to the buyer. • NotOfferedOnSite (out) Shipping insurance is not offered as a separate option on the site where the item is listed. (Some shipping services, such as DE_InsuredExpressOrCourier, include insurance as part of the service.) If another insurance option is specified in the listing request and the site does not support shipping insurance as a separate option, eBay will reset the insurance option to this value. At the time of this writing, this option is only meaningful for the eBay Germany, Austria, and Switzerland sites. • Optional (in/out) The seller offers the buyer the choice of paying for shipping insurance or not. • Required (in/out) The seller requires that the buyer pay for shipping insurance.
SellingManagerSoldOrder .ShippingDetails.SalesTax	SalesTaxType	Always	Sales tax details. US site only. Flat and calculated shipping. Not applicable to eBay Motors vehicle listings. Applicable to Half.com (for GetOrders). See Enabling Multi-jurisdiction Sales Tax.
SellingManagerSoldOrder .ShippingDetails.SalesTax .SalesTaxPercent	float	Conditionally	Percent of an item's price to be charged as the sales tax for the transaction. The value passed in is stored with a precision of 3 digits after the decimal point (##.###). Applicable to Half.com (for GetOrders).
SellingManagerSoldOrder .ShippingDetails .ShippingServiceOptions	ShippingServiceOptionsType	Conditionally, repeatable: [0..*]	Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Required if InternationalShippingServiceOption is specified. For flat shipping, a maximum shipping cost may apply when listing. See Shipping documentation for details about Maximum Flat Rate Shipping Costs. 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: ... ... ... ... ... 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 three domestic shipping services and up to three international shipping services. All domestic services must be the same shipping type (for example, Flat versus Calculated); the same is true for international shipping services offered by the seller. Not applicable to Half.com or eBay Motors vehicle listings. See Overview of the API Schema for rules regarding repeating instances of a nodes (nodes for which maxOccurs is "unbounded" or is greater than 1).
SellingManagerSoldOrder .ShippingDetails .ShippingServiceOptions .ShippingServiceCost	AmountType (double)	Conditionally	The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. Also applicable to Half.com (for GetOrders). See Determining Shipping Costs for a Listing.
SellingManagerSoldOrder .ShippingDetails .ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ]	CurrencyCodeType	Always	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. 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	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. 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: • AwaitingBuyerResponse (out) Awaiting buyer response. • AwaitingSellerResponse (out) Awaiting seller response. • CustomCode (out) Reserved for internal or future use. • FinalValueFeeCredited (out) Final value fee credited. • FinalValueFeeDenied (out) Final value fee denied. • FinalValueFeeEligible (out) Eligible for final value fee. • UnpaidItemEligible (out) Eligible for unpaid item. • UnpaidItemFiled (out) Unpaid item filed.
SellingManagerSoldOrder .VATInsuranceFee	AmountType (double)	Conditionally	Amount of applicable value added tax insurance fee.
SellingManagerSoldOrder .VATInsuranceFee [ attribute currencyID ]	CurrencyCodeType	Always	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. 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	Item ID of the transaction for which the seller wants to specify a VAT rate.
SellingManagerSoldOrder .VATRate.TransactionID	string	Conditionally	Transaction ID of the transaction for which the seller wants to specify a VAT rate.
SellingManagerSoldOrder .VATRate.VATPercent	float	Conditionally	VAT rate for the item, if any. 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	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
SellingManagerSoldOrder .VATTotalAmount	AmountType (double)	Conditionally	VAT total amount.
SellingManagerSoldOrder .VATTotalAmount [ attribute currencyID ]	CurrencyCodeType	Always	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.

GetSellingManagerSaleRecord Detail Controls

Detail Control: DetailLevel

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

GetSellingManagerSaleRecord Samples

New to making API calls? Please see Routing the Request.

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 magicalbookseller 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 transaction information for a sold item. Both the ItemID and TransactionID are required input fields.

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

<?xml version="1.0" encoding="utf-8"?>
<GetSellingManagerSaleRecordRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <Version>607</Version>
  <ItemID>170001996049</ItemID>
  <TransactionID>7426530007</TransactionID>
</GetSellingManagerSaleRecordRequest>

Output

The response includes the shipping address needed by magicalbookseller. The response also includes the sale price.

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

<?xml version="1.0" encoding="utf-8"?>
<GetSellingManagerSaleRecordResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2009-03-20T19:59:22.641Z</Timestamp>
  <Ack>Success</Ack>
  <Version>609</Version>
  <Build>e609_core_Bundled_8177180_R1</Build>
  <SellingManagerSoldOrder>
    <SellingManagerSoldTransaction>
      <ItemID>170001996049</ItemID>
      <QuantitySold>1</QuantitySold>
      <ItemPrice currencyID="CAD">300.0</ItemPrice>
      <SubtotalAmount currencyID="CAD">300.0</SubtotalAmount>
      <ItemTitle>SDK item title</ItemTitle>
    </SellingManagerSoldTransaction>
    <ShippingAddress>
      <Name>Vito De Niro</Name>
      <Street1>228476 2nd Street</Street1>
      <Street2>228476 2nd Street</Street2>
      <CityName>Ventura</CityName>
      <StateOrProvince>CA</StateOrProvince>
      <Country>US</Country>
      <PostalCode>93003</PostalCode>
    </ShippingAddress>
    <ShippingDetails>
      <SalesTax/>
    </ShippingDetails>
    <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>GenericUser</BuyerID>
    <BuyerEmail>SetPersonalInformation3@ebay.com</BuyerEmail>
  </SellingManagerSoldOrder>
</GetSellingManagerSaleRecordResponse>

GetSellingManagerSaleRecord Change History

Version	Description
635 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.
635 2009-09-16	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.
627 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.
589 2008-10-29	(added) New call.

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

Call-specific Input Fields
ItemID	ItemIDType (string)	Conditional	The item ID associated with the sale record. If not specified, either TransactionID or OrderID must be specified.
OrderID	OrderIDType (string)	Conditional	The order ID associated with the sale record. If specified, then the following, if specified in the same call, are ignored: ItemID and TransactionID.
TransactionID	string	Conditional	The transaction ID associated with the sale record. If not specified, either TransactionID or OrderID must be specified.

ErrorLanguage	string	Optional	Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong See Tags for the Identification of Languages.
MessageID	string	Optional	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Version	string	Conditional	The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects: - It indicates the version of the code lists and other data that eBay should use to process your request. - It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See: HTTP Headers (XML API Only) eBay Schema Versioning Strategy Lowest Supported Version
WarningLevel	WarningLevelCodeType	Optional	Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level.

eBay Trading API Call Reference Version 643

Prerequisites

Related Information

eBay Trading API
Call Reference Version 643