OrderType

There are single line item and multiple line item orders. A single payment is made for both order types.

We strongly recommend that you avoid mixing digital and non-digital listings in the same Combined Payment order.

Types that use OrderType:

Calls that use one or more fields of OrderType:

Fields

AdjustmentAmount ( AmountType (double) )
AmountPaid ( AmountType (double) )
AmountSaved ( AmountType (double) )
BundlePurchase
BuyerCheckoutMessage ( string )
BuyerUserID ( UserIDType (string) )
CheckoutStatus ( CheckoutStatusType )
CreatedTime ( dateTime )
CreatingUserRole ( TradingRoleCodeType )
EIASToken ( string )
ExternalTransaction ( ExternalTransactionType )
IntegratedMerchantCreditCardEnabled ( boolean )
IsMultiLegShipping ( boolean )
MultiLegShippingDetails ( MultiLegShippingDetailsType )
OrderID ( OrderIDType (string) )
OrderStatus ( OrderStatusCodeType )
PaidTime ( dateTime )
PaymentHoldDetails ( PaymentHoldDetailType )
PaymentHoldStatus ( PaymentHoldStatusCodeType )
PaymentMethods ( BuyerPaymentMethodCodeType )
RefundAmount ( AmountType (double) )
RefundArray ( RefundArrayType )
RefundStatus ( string )
SellerEmail
ShippedTime ( dateTime )
ShippingAddress ( AddressType )
ShippingDetails ( ShippingDetailsType )
ShippingServiceSelected ( ShippingServiceOptionsType )
Subtotal ( AmountType (double) )
Total ( AmountType (double) )
TransactionArray ( TransactionArrayType )

AdjustmentAmount ( AmountType (double) ) [1]
This value indicates the dollar amount by which the buyer has adjusted the order total. Adjustments to order costs may include shipping and handling, shipping insurance, buyer discounts, or added services. A positive amount indicates the amount is an extra charge being paid to the seller by the buyer. A negative value indicates this amount is a credit given to the buyer by the seller.

Applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use AdjustmentAmount.

AmountPaid ( AmountType (double) ) [0..1]
This value indicates the total amount of the order. This amount includes the sale price of each line item, shipping and handling charges, shipping insurance (if offered and selected by the buyer), additional services, and any applied sales tax. This value is returned after the buyer has completed checkout (the CheckoutStatus.Status output field reads 'Complete').

Note: For auction listings on North American sites and on eBay Motors Parts and Accessories, the AmountPaid value minus any applied sales tax is the amount subject to the final value fee calculation. The sales tax amount is returned in the ShippingDetails.SalesTax.SalesTaxAmount field. For more information on how final value fees are calculated, see the final value fees help page.
Applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use AmountPaid.

AmountSaved ( AmountType (double) ) [1]
This value indicates the shipping discount experienced by the buyer as a result of creating a Combined Payment order. This value is returned as 0.00 for single line item orders.
See the Field Index to learn which calls use AmountSaved.

BundlePurchase
Not used by any call.

BuyerCheckoutMessage ( string ) [0..1]
This field is returned if the buyer left a message for the seller during checkout.
See the Field Index to learn which calls use BuyerCheckoutMessage.

BuyerUserID ( UserIDType (string) ) [1]
eBay user ID of the order's buyer.

Not applicable to Half.com.
See the Field Index to learn which calls use BuyerUserID.

CheckoutStatus ( CheckoutStatusType ) [1]
Container consisting of details related to the current checkout status of the order.

Applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use CheckoutStatus.

CreatedTime ( dateTime ) [1]
Timestamp that indicates the date and time that the order was created. For single line item orders, this value is the same as CreatedDate in the Transaction container.

Applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use CreatedTime.

CreatingUserRole ( see TradingRoleCodeType for possible values ) [0..1]
This value indicates whether a Combined Payment order was created by the buyer or by the seller. This field is only returned for Combined Payment orders.
See the Field Index to learn which calls use CreatingUserRole.

EIASToken ( string ) [0..1]
Unique identifier for the user that does not change when the eBay user name is changed. Use when an application needs to associate a new eBay user name with the corresponding eBay user.

Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.
See the Field Index to learn which calls use EIASToken.

ExternalTransaction ( ExternalTransactionType ) [0..*]
Container consisting of payment details for an eBay order. PayPal transactions may include a buyer payment or refund, or a fee or credit applied to the seller's account. This field is only returned after payment for the order has occurred. For orders in which the seller's funds are being held by PayPal, the PaymentHoldDetails container and PaymentHoldStatus< /b> field will be returned instead of the ExternalTransaction container.

Not applicable to Half.com.
See the Field Index to learn which calls use ExternalTransaction.

IntegratedMerchantCreditCardEnabled ( boolean ) [0..1]
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.
See the Field Index to learn which calls use IntegratedMerchantCreditCardEnabled.

IsMultiLegShipping ( boolean ) [0..1]
If IsMultilegShipping is true, the order or transaction uses the Global Shipping Program, in which the shipment has a domestic leg and an international leg. The buyer's shipping address is in a country other than the country where the items were listed, and the seller has specified InternationalPriorityShipping as the default international shipping service in the listings of all the items in the shipment.

If IsMultilegShipping is false, the order or transaction doesn't use the Global Shipping Program. The shipment might use a different international shipping service, or it might be domestic.
See the Field Index to learn which calls use IsMultiLegShipping.

MultiLegShippingDetails ( MultiLegShippingDetailsType ) [0..1]
Contains details about the domestic leg of a Global Shipping Program shipment.

This information is not returned if IsMultilegShipping is false.
See the Field Index to learn which calls use MultiLegShippingDetails.

OrderID ( OrderIDType (string) ) [0..1]
A unique identifier that identifies a single line item or multiple line item order.

For a single line item order, the OrderID value is identical to the OrderLineItemID value that is generated upon creation of the order line item. For a Combined Payment order or an order that goes through the eBay shopping cart flow, the OrderID value is automatically created by eBay. A Combined Payment order can be created through the site by a buyer or seller when the buyer or seller share multiple, common order line items. A Combined Payment order can also be created by the seller through the AddOrder call.

An OrderID value overrides an OrderLineItemID value or an ItemID/TransactionID pair if these fields are also specified in the same request.

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]
This enumeration value indicates the current status of the order.

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

PaidTime ( dateTime ) [0..1]
Timestamp indicating the date and time of order payment. This field is not returned until payment has been made by the buyer.

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.

Applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use PaidTime.

PaymentHoldDetails ( PaymentHoldDetailType ) [0..1]
This container consists of information related to the payment hold on the order, including the reason why the buyer's payment for the order is being held, the expected release date of the funds into the seller's account, and possible action(s) the seller can take to expedite the payout of funds into their account. This container is only returned if PayPal has placed a payment hold on the order.

An American seller (selling on US or US Motors sites) and a Canadian seller (selling on CA and CA- FR sites) may be subject to PayPal payment holds (that last from three to 21 days) if that seller is new to selling on eBay or is classified as a "Below Standard" seller. For other reasons why a seller's funds may be held by PayPal, see the PaymentHoldReason field.
See the Field Index to learn which calls use PaymentHoldDetails.

PaymentHoldStatus ( see PaymentHoldStatusCodeType for possible values ) [0..1]
This field indicates the type and/or status of a payment hold on the item.
See the Field Index to learn which calls use PaymentHoldStatus.

PaymentMethods ( see BuyerPaymentMethodCodeType for possible values ) [1..*]
This field indicates a payment method available to the buyer to pay for the order. There can be multiple PaymentMethods fields.

For DE and AT orders subject to the new eBay payment process, only one PaymentMethods field will be returned, and the value will always be 'StandardPayment'.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.

Applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use PaymentMethods.

RefundAmount ( AmountType (double) ) [0..1]
Amount of the refund issued to the buyer. This field is only returned for a DE/AT order subject to the new eBay payment process, and if a refund was issued to the buyer.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.
See the Field Index to learn which calls use RefundAmount.

RefundArray ( RefundArrayType ) [0..1]
Container consisting of one or more refunds for Half.com orders or DE/AT orders subject to the new eBay payment process. This container is returned only if a refund to a Half.com buyer has occurred or a refund was issued for an order subject to the new eBay payment Process.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.
See the Field Index to learn which calls use RefundArray.

RefundStatus ( string ) [0..1]
String value indicating the result of a refund (Success, Failure, Pending) to the buyer for an DE/AT order subject to the new eBay payment process.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.
See the Field Index to learn which calls use RefundStatus.

SellerEmail
Not used by any call.

ShippedTime ( dateTime ) [0..1]
Timestamp indicating the date and time of order shipment. This field is not returned until the order has been marked as shipped. Note that sellers have the ability to set the shipped time up to three calendar days in the future.

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.

Applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use ShippedTime.

ShippingAddress ( AddressType ) [1]
Container holding the shipping address of the buyer involved in the order.

Applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use ShippingAddress.

ShippingDetails ( ShippingDetailsType ) [1]
Container consisting of all shipping-related details for an order, including domestic and international shipping service options, shipment tracking information, and shipping insurance information.

Applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use ShippingDetails.

ShippingServiceSelected ( ShippingServiceOptionsType ) [1]
Container consisting of details about the domestic or international shipping service selected by the buyer.

Note: For GetOrders and GetOrderTransactions, if you provide OrderLineItemID values in the OrderID field, this container does not return accurate shipping service and cost information for multiple line item orders. You must provide the order's combined OrderID value to ensure that the ShippingService and ShippingServiceCost fields return the correct values for the order.

Applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use ShippingServiceSelected.

Subtotal ( AmountType (double) ) [1]
The subtotal amount for the order is the total cost of all order line items. This value does not include any shipping/handling, shipping insurance, or sales tax costs.

Applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use Subtotal.

Total ( AmountType (double) ) [1]
The Total amount equals the Subtotal value plus the shipping/handling, shipping insurance, and sales tax costs.

Applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use Total.

TransactionArray ( TransactionArrayType ) [1]
Container consisting of one or more line items that comprise an order. The data for an order line item is stored in the Transaction container. For the AddOrder call, there will always be at least two order line items in the container, but no more than 40.

We strongly recommend that you avoid mixing transactions for digital and non-digital listings in the same Combined Payment order. (In the future, AddOrder may enforce this recommendation.)

Applicable to Half.com (for GetOrders).
See the Field Index to learn which calls use TransactionArray.

Copyright © 2005–2013 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.