eBay Merchant Data APIVersion 1179

OrderDetailsType

Contains information about the sold item, such as: order id, buyer information, shipping information, order creation time, payment cleared time, tax amount, insurance cost, and total cost.

Types that use OrderDetailsType:

Calls that use OrderDetailsType:

Fields



BuyerEmail ( string ) [0..1]
Displays the email address of the buyer (from their eBay user account). Used for off-eBay communication.
See the Field Index to learn which calls use BuyerEmail.

BuyerFirstName ( string ) [0..1]
Displays the first name of the buyer (from their eBay user account).
See the Field Index to learn which calls use BuyerFirstName.

BuyerLastName ( string ) [0..1]
Displays the last name of the buyer (from their eBay user account).
See the Field Index to learn which calls use BuyerLastName.

BuyerPhone ( string ) [0..1]
Buyer's primary phone number. This may return a value of "Invalid Request" if you are not authorized to see the buyer's phone number.
See the Field Index to learn which calls use BuyerPhone.

BuyerStaticAlias ( string ) [0..1]
Static anonymous email address of the buyer for eBay intermediated member-to-memmber emails. Messaging calls in the Trading API, such as GetMemeberMessages will also use this static email address.

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

BuyerUserID ( string ) [0..1]
The buyer's eBay User ID.
See the Field Index to learn which calls use BuyerUserID.

CheckoutSiteID ( int ) [0..1]
The eBay site that the buyer used when paying for the item(s).
See the Field Index to learn which calls use CheckoutSiteID.

CheckoutStatus ( CheckoutStatusType ) [0..1]
The current checkout status of the order.
See the Field Index to learn which calls use CheckoutStatus.

ExternalTransaction ( ExternalTransactionType ) [0..*]
The transaction that relates to the eBay order line item.
See the Field Index to learn which calls use ExternalTransaction.

InsuranceCost ( AmountType (double) ) [0..1]
Cost of insuring the delivery of this order with the courier.
See the Field Index to learn which calls use InsuranceCost.

OrderCreationTime ( dateTime ) [0..1]
The date and time that the order was created.
See the Field Index to learn which calls use OrderCreationTime.

OrderID ( string ) [0..1]
A unique identifier for a single or multiple line item order. When a buyer purchases multiple items from the same listing, each item purchased will have an Order Line Item ID and all items in that purchase will have the same Order ID.

Note: In June 2019, eBay introduced a new order ID format, but allowed developers/sellers to decide whether to immediately adopt the new format, or to continue working with the old format. Users who wanted to adopt the new format, could either use a Trading WSDL Version 1113 (or newer), or they could even use an older Trading WSDL but set the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header value to 1113 in API calls. 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.

Note that the unique identifier of a 'non-immediate payment' order will change as it goes from an unpaid order to a paid order. Due to this scenario, all calls that accept Order ID values as filters in the request payload, including the GetOrders call, will support the identifiers for both unpaid and paid orders. The new order ID 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.

Sellers can check to see if an order has been paid by looking for a value of 'Complete' in the CheckoutStatus.Status field in the response of GetOrders or GetOrderTransactions call, or in the Status.CompleteStatus field in the response of GetItemTransactions or GetSellerTransactions call. Sellers should not fulfill orders until buyer has made payment.
See the Field Index to learn which calls use OrderID.

OrderItemDetails ( OrderItemDetailsType ) [0..1]
Contains the data for each line item in the order.
See the Field Index to learn which calls use OrderItemDetails.

OrderSalePrice ( AmountType (double) ) [0..1]
Amount seller charged to buyer, not amount of fees that seller owes eBay.
See the Field Index to learn which calls use OrderSalePrice.

OrderTotalCost ( AmountType (double) ) [0..1]
The total cost of the order, which includes the sale price of all order line items, shipping costs, and taxes.

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

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

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

PaymentClearedTime ( dateTime ) [0..1]
The date and time that the payment was acknowledged. Only returned if payment has been marked as sent (checkout is complete). If a buyer has completed checkout using PayPal, the Payment is automatically marked as sent. Otherwise, the buyer must mark it manually on the MyeBay page.
See the Field Index to learn which calls use PaymentClearedTime.

PaymentHoldStatus ( PaymentHoldStatusCodeType ) [0..1]
Contains the status of a PayPal payment hold on the item.
See the Field Index to learn which calls use PaymentHoldStatus.

PickupDetails ( PickupDetailsType ) [0..1]
Contains all local pickup related information.
See the Field Index to learn which calls use PickupDetails.

PickupMethodSelected ( PickupMethodSelectedType ) [0..1]
Contains the information about buyer selected pickup method
See the Field Index to learn which calls use PickupMethodSelected.

SellingManagerSaleRecordID ( int ) [0..1]
For users of the Selling Manager or Selling Manager Pro tools only. If you are not using Selling Manager or Selling Manager Pro, this field will not be returned in your response.

Unique identifier for the record, assigned by eBay. An example of a recordId: 1111:222:333:444:x.
See the Field Index to learn which calls use SellingManagerSaleRecordID.

ShipCityName ( string ) [0..1]
Displays the buyer's city name (from the shipping address on their eBay user account). Only returned if payment has been marked as sent (checkout is complete). If a buyer has completed checkout using PayPal, the Payment is automatically marked as sent. Otherwise, the buyer must mark it manually on the MyeBay page.
See the Field Index to learn which calls use ShipCityName.

ShipCountryName ( token ) [0..1]
Displays the buyer's ISO 3166 country code (from the shipping address on their eBay user account). Only returned if payment has been marked as sent.
See the Field Index to learn which calls use ShipCountryName.

ShippingCost ( AmountType (double) ) [0..1]
Calculated shipping cost based on item weight, buyer's postal code, and shipping service.
See the Field Index to learn which calls use ShippingCost.

ShippingService ( string ) [0..1]
Name of the shipping service for display purposes.

Note that this value can change for aesthetic purposes, whereas the ShippingServiceToken will not. Therefore, for all practical purposes, use ShippingServiceToken when programmatically reading and processing.
See the Field Index to learn which calls use ShippingService.

ShippingServiceToken ( string ) [0..1]
Value used for the shipping service. For a list of valid values, call GeteBayDetails with DetailName set to ShippingServiceDetails.lt;br>
Related fields:
Item.ShippingDetails.InternationalShippingServiceOption.ShippingService in AddFixedPriceItem
Item.ShippingDetails.ShippingServiceOptions.ShippingService in AddFixedPriceItem
See the Field Index to learn which calls use ShippingServiceToken.

ShipPostalCode ( string ) [0..1]
Displays the buyer's postal code or zip code (from the shipping address on their eBay user account). Only returned if payment has been marked as sent.
See the Field Index to learn which calls use ShipPostalCode.

ShipRecipientName ( string ) [0..1]
Displays the buyer's recipient name for shipping (from the shipping address on their eBay user account). Only returned if payment has been marked as sent.
See the Field Index to learn which calls use ShipRecipientName.

ShipReferenceId ( string ) [0..1]
Uniquely identifies an order shipped using the Global Shipping Program. This value is generated by eBay when the order is completed. The international shipping provider uses the ReferenceID as the primary reference when processing the shipment. Sellers must include this value on the package immediately above the street address of the international shipping provider. Example: "Reference #1234567890123456"
See the Field Index to learn which calls use ShipReferenceId.

ShipStateOrProvince ( string ) [0..1]
Displays the buyer's state or province name (from the shipping address on their eBay user account). Only returned if payment has been marked as sent.
See the Field Index to learn which calls use ShipStateOrProvince.

ShipStreet1 ( string ) [0..1]
Displays the buyer's street name (from the shipping address on their eBay user account). Only returned if payment has been marked as sent.
See the Field Index to learn which calls use ShipStreet1.

ShipStreet2 ( string ) [0..1]
Displays the second line of a buyer's street name (if one exists in the shipping address on their eBay user account). Only returned if payment has been marked as sent.
See the Field Index to learn which calls use ShipStreet2.

TaxAmount ( AmountType (double) ) [0..1]
Calculated tax fee based on the sale price and the sales tax at the seller's location.
See the Field Index to learn which calls use TaxAmount.

TotalIncludeseBayCollectedTax ( boolean ) [0..1]
This boolean field is returned as true if the OrderTotalCost value includes eBay 'Collect and Remit' taxes. eBay 'Collect and Remit' taxes include US state-mandated sales tax and 'Goods and Services' taxes that are applicable to orders from Australian and New Zealand sellers.

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

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

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