OrderType

Types that use OrderType:

Calls that use one or more fields of OrderType:

Fields

AdjustmentAmount ( AmountType (double) )
AmountPaid ( AmountType (double) )
AmountSaved ( AmountType (double) )
BuyerUserID ( UserIDType (string) )
CheckoutStatus ( CheckoutStatusType )
CreatedTime ( dateTime )
CreatingUserRole ( TradingRoleCodeType )
ExternalTransaction ( ExternalTransactionType )
OrderID ( OrderIDType (string) )
OrderStatus ( OrderStatusCodeType )
PaidTime ( dateTime )
PaymentMethods ( BuyerPaymentMethodCodeType )
SellerEmail
ShippedTime ( dateTime )
ShippingAddress ( AddressType )
ShippingDetails ( ShippingDetailsType )
ShippingServiceSelected ( ShippingServiceOptionsType )
Subtotal ( AmountType (double) )
Total ( AmountType (double) )
TransactionArray ( TransactionArrayType )

AdjustmentAmount ( AmountType (double) ) [0..1]
Amount by which the buyer is adjusting the order total. Used when the seller has not supplied payment details such as shipping and handling or insurance fee. Also applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use AdjustmentAmount.

AmountPaid ( AmountType (double) ) [0..1]
Amount the buyer has paid the seller for the order. For GetOrders, applies only to Half.com.
See the Field Index to learn which calls use AmountPaid.

AmountSaved ( AmountType (double) ) [0..1]
Amount the buyer saved by having multiple items combined into a single order, versus purchasing the items separately.
See the Field Index to learn which calls use AmountSaved.

BuyerUserID ( UserIDType (string) ) [0..1]
User ID of the order's buyer. Not applicable to Half.com.
See the Field Index to learn which calls use BuyerUserID.

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

CreatedTime ( dateTime ) [0..1]
Date and time the order was created. Also applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use CreatedTime.

CreatingUserRole ( see TradingRoleCodeType for possible values ) [0..1]
Indicates whether the order is created by the buyer or by the seller.
See the Field Index to learn which calls use CreatingUserRole.

ExternalTransaction ( ExternalTransactionType ) [0..*]
Not applicable to Half.com. A PayPal transaction that relates to this eBay transaction. Returned only if there is at least one PayPal transaction related to this eBay transaction.
See the Field Index to learn which calls use ExternalTransaction.

OrderID ( OrderIDType (string) ) [0..1]
Unique identifier that eBay generates for the order.

For calls like GetItemTransactions (and the Checkout notification), no OrderID will appear when only 1 item is purchased in a single end-to-end checkout flow (because the transaction would not be part of an order in this case).

Also applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use OrderID.

OrderStatus ( see OrderStatusCodeType for possible values ) [0..1]
The current status of the order.

For transaction calls (like GetItemTransactions), please use the TransactionPlatform element to determine whether an item was purchased on Express on eBay.

Also applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use OrderStatus.

PaidTime ( dateTime ) [0..1]
Date and time the order was paid. This time is specified in GMT (not Pacific time). See "Time Values" in the eBay Web Services guide for information about converting between GMT and other time zones. Also applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use PaidTime.

PaymentMethods ( see BuyerPaymentMethodCodeType for possible values ) [0..*]
The payment methods the buyer uses to pay for the order. An order can have multiple payment methods if the buyer combines several transactions into one order. Also applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use PaymentMethods.

SellerEmail
Not used by any call.

ShippedTime ( dateTime ) [0..1]
Date and time the order was shipped. This time is specified in GMT (not Pacific time). See "Time Values" in the eBay Web Services guide for information about converting between GMT and other time zones. Also applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use ShippedTime.

ShippingAddress ( AddressType ) [0..1]
Shipping address the order has been or will be sent to. Also applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use ShippingAddress.

ShippingDetails ( ShippingDetailsType ) [0..1]
The shipping-related details for an item or transaction, including flat or calculated shipping costs and shipping insurance costs. Also applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use ShippingDetails.

ShippingServiceSelected ( ShippingServiceOptionsType ) [0..1]
The shipping service selected by the buyer from the services offered by the seller. Also applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use ShippingServiceSelected.

Subtotal ( AmountType (double) ) [0..1]
The sum of the sale prices of all of the transactions in the order, where a transaction sale price is the item sale price times the quantity sold. Also applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use Subtotal.

Total ( AmountType (double) ) [0..1]
Subtotal plus the shipping cost plus the sales tax plus cost of insurance. Also applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use Total.

TransactionArray ( TransactionArrayType ) [0..1]
The set of two or more transactions that make up the order. Also applicable to Half.com (for GetOrders).

We strongly recommend that you avoid mixing transactions for digital and non-digital listings in the same order. (In the future, AddOrder may enforce this recommendation.)
See the Field Index to learn which calls use TransactionArray.

This document was generated with a customized version of the apireferencedocs tool [0.5M zip].

© 2005–2008 eBay, Inc. All rights reserved.