eBay Trading APIVersion 1055

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 Invoice order.

Types that use OrderType:

Calls that use OrderType:

Fields

RefundArray ( RefundArrayType )


AdjustmentAmount ( AmountType (double) ) [0..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.
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.
See the Field Index to learn which calls use AmountPaid.

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

BundlePurchase ( boolean ) [0..1]
Not used by any call.

Reserved for future use.
See the Field Index to learn which calls use BundlePurchase.

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.

BuyerPackageEnclosures ( BuyerPackageEnclosuresType ) [0..1]
This container is returned in GetOrders (and other order management calls) if the 'Pay Upon Invoice' option is being offered to the buyer, and the seller is including payment instructions in the shipping package(s) for the order. The 'Pay Upon Invoice' option is only available on the German site.
See the Field Index to learn which calls use BuyerPackageEnclosures.

BuyerTaxIdentifier ( TaxIdentifierType ) [0..*]
This container consists of taxpayer identification for the buyer. Although this container may be used for other purposes at a later date, it is currently used by sellers selling on the Italy or Spain site to retrieve the taxpayer ID of the buyer.

It is now required that buyers registered on the Italy site provide their Codice Fiscale ID (similar to the Social Security Number for US citizens) before buying an item on the Italy site.

On the Spain site, a Spanish seller has the option to require that Spanish buyers (registered on Spain site) provide a tax ID before checkout. This option is set by the seller at the account level. Once a Spanish buyer provides a tax ID, this tax ID is associated with his/her account, and once a tax ID is associated with the account, Spanish buyer will be asked to provide the tax ID during checkout on all eBay sites. Buyers with a registered address outside of Spain will not be asked to provide a tax ID during checkout.

This container is only returned for Spanish or Italian sellers when the buyer was asked to provide tax identifier information during checkout. A BuyerTaxIdentifier container will be returned for each tax ID that is associated with the buyer's account.
See the Field Index to learn which calls use BuyerTaxIdentifier.

BuyerUserID ( UserIDType (string) ) [0..1]
eBay user ID of the order's buyer.
See the Field Index to learn which calls use BuyerUserID.

CancelDetail ( CancelDetailType ) [0..*]
This container consists of details related to an eBay order that has been cancelled or is in the process of possibly being cancelled. Order cancellation requests can be viewed and managed with the cancellation API calls that are available in the Post Order API.
See the Field Index to learn which calls use CancelDetail.

CancelReason ( token ) [0..1]
This value indicates the reason why the order cancellation was initiated. This field is only returned if an order cancellation has been initiated by the buyer or seller. Typical buyer-initiated cancellation reasons include 'OrderPlacedByMistake', 'WontArriveInTime', or 'FoundCheaperPrice'. Sellers may initiate an order cancellation on behalf of the buyer. In this scenario, the seller should state the cancellation reason as 'BuyerCancelOrder'. If the seller is cancelling an order because he/she is out of stock on an item, the seller should state the cancellation reason as 'OutOfStock'. Unfortunately, in this scenario, the seller will receive a seller defect for this cancellation reason. Other order cancellation reasons are specific to eBay On Demand Delivery orders. eBay On Demand Delivery is similar to the eBay Now service in the US (now retired), and is only available in the UK. See for the complete list of enumeration values that can be returned in this field.

Note: Currently, the CancelReason field is being returned under the Order container and under the CancelDetail container. However, there are plans to deprecate this field from OrderType in the future.
See the Field Index to learn which calls use CancelReason.

CancelReasonDetails ( string ) [0..1]
The detailed reason for the cancellation of an eBay order. This field is only returned if it is available when a cancellation request has been made on the order, or if the order is currently going through the cancellation process, or if the order has already been cancelled.

Note: Currently, the CancelReasonDetails field is being returned under the Order container and under the CancelDetail container. However, there are plans to deprecate this field from OrderType in the future.
See the Field Index to learn which calls use CancelReasonDetails.

CancelStatus ( CancelStatusCodeType ) [0..1]
The current status for the order cancellation request if it exists. This field is only returned if a cancellation request has been made on the order, or if the order is currently going through the cancellation process, or if the order has already been cancelled.
See the Field Index to learn which calls use CancelStatus.

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

ContainseBayPlusTransaction ( boolean ) [0..1]
If true, the order contains a transaction for an item that was purchased under the eBay Plus program. eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top Rated eBay sellers must opt in to eBay Plus to be able offer the program on qualifying listings. Sellers must commit to next-day delivery of those items.

Note: Currently, eBay Plus is available only to buyers in Germany (DE).
See the Field Index to learn which calls use ContainseBayPlusTransaction.

CreatedTime ( dateTime ) [0..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.
See the Field Index to learn which calls use CreatedTime.

CreatingUserRole ( TradingRoleCodeType ) [0..1]
This value indicates whether a Combined Invoice order was created by the buyer or by the seller. This field is only returned for Combined Invoice 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.

ExtendedOrderID ( string ) [0..1]
A unique identifier for an eBay order. Unlike the OrderID field, the format for this field is the same for both single and multiple line item orders. ExtendedOrderID values will be used to identify orders in the Post-Order APIs. For Trading API Get calls, OrderID values should still be used.

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 correct Order ID is returned to the buyer or seller, but a dummy Order ID value of 1000000000000 will be returned to all third parties.
See the Field Index to learn which calls use ExtendedOrderID.

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 field will be returned instead of the ExternalTransaction container.

Note: In an upcoming release, ExternalTransaction will be replaced by the more versatile MonetaryDetails container, so you are encouraged to start using MonetaryDetails now.
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.

LogisticsPlanType ( token ) [0..1]
This field will be returned at the order level only if the buyer purchased a digital gift card, which is delivered by email, or if the buyer purchased an item that is enabled with the 'Click and Collect' feature.

Currently, LogisticsPlanType has two applicable values: PickUpDropOff, which indicates that the buyer selected the 'Click and Collect' option. With Click and Collect, buyers are able to purchase from thousands of sellers on the eBay UK and Australia sites, and then pick up their order from the nearest 'eBay Collection Point', including over 750 Argos stores in the UK. The Click and Collect feature is only available on the eBay UK and Australia sites; or, DigitalDelivery, which indicates that the order is a digital gift card that will be delivered to the buyer or recipient of the gift card by email.
See the Field Index to learn which calls use LogisticsPlanType.

MonetaryDetails ( PaymentsInformationType ) [0..1]
Contains information about how funds exchanged for an order are allocated to payees.

For example, for an order made under eBay's Global Shipping Program, users can see the portion of the buyer's payment that is allocated as shipping and import charges remitted to the international shipping provider. Currently, only payment information is returned.

Note: In an upcoming release, MonetaryDetails will replace the ExternalTransaction container, so you are encouraged to start using MonetaryDetails now.
See the Field Index to learn which calls use MonetaryDetails.

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 for an eBay order. For a single line item order, this value is actually the OrderLineItemID value, which is a concatenation of ItemID and TransactionID, with a hyphen in between these two values, such as 121124971073-1094989827002 for a fixed-price listing, or 121124971074-0 for an auction listing. For a multiple line item order (known as a Combined Invoice order), the OrderID value is created by eBay when the buyer/seller combines multiple line items into one order, and the buyer makes one payment for all line items from the same seller. "Combined Invoice" orders are created through the Web flow, or when the buyer or seller creates a "Combined Invoice" order by using the AddOrder call. An example of "Combined Invoice" order ID is 155643809010.

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

For GetOrders, GetOrderTransactions, and GetItemTransactions only: This field is returned with the correct order ID only to the buyer, the seller, or PayPal (if PayPal is the payment method). For third parties (except PayPal):
  • If using a Trading WSDL older than version 1019, the Order ID will be returned to third parties as dummy data in the form of 1000000000000 or 1000000000000-1000000000000.
  • If using Trading WSDL version 1019 or newer, the Order ID will be returned to third parties as an empty field (<OrderID/>).
See the Field Index to learn which calls use OrderID.

OrderStatus ( OrderStatusCodeType ) [0..1]
This enumeration value indicates the current status of the order.
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 field will not be returned for orders where the buyer has received partial or full refunds.

This time is specified in GMT (not Pacific time). See eBay Features Guide for information about converting between GMT and other time zones.
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 ( PaymentHoldStatusCodeType ) [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 ( BuyerPaymentMethodCodeType ) [0..*]
This field indicates a payment method available to the buyer to pay for the order. There will be a PaymentMethods field for each payment method available to the buyer.
See the Field Index to learn which calls use PaymentMethods.

PickupDetails ( PickupDetailsType ) [0..1]
Container consisting of an array of PickupOptions containers. Each PickupOptions container consists of the pickup method and its priority. The priority of each pickup method controls the order (relative to other pickup methods) in which the corresponding pickup method will appear in the View Item and Checkout page.

For GetOrders and GetOrderTransactions, this container is always returned prior to order payment if the seller created/revised/relisted the item with the EligibleForPickupInStore and/or EligibleForPickupDropOff flag in the call request set to 'true'. If and when the In-Store pickup method (US only) or 'Click and Collect' pickup method (UK and Australia only) is selected by the buyer and payment for the order is made, this container will no longer be returned in the response, and will essentially be replaced by the PickupMethodSelected container.

Note: A seller must be eligible for the In-Store Pickup feature or Click and Collect feature to list an item that is eligible for In-Store Pickup or Click and Collect. At this time, the In-Store Pickup and Click and Collect features are generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup or Click and Collect functionality in the Sandbox environment, including listing items enabled with these features, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of pickup status changes using the Inbound Notifications API.
See the Field Index to learn which calls use PickupDetails.

PickupMethodSelected ( PickupMethodSelectedType ) [0..1]
Container consisting of details related to the selected pickup method, including the pickup method type, the merchant's store ID, the status of the pickup, and the pickup reference code (if provided by merchant).

This container is only returned when the buyer has selected the In-Store Pickup or Click and Collect option and has paid for the order. All fields in the PickupMethodSelected container are static, except for the PickupStatus field, which can change states based on the notifications that a merchant sends to eBay through the Inbound Notifications API.

Note: A seller must be eligible for the In-Store Pickup or Click and Collect feature to list an item that is eligible for these features. At this time, the In-Store Pickup and Click and Collect features are generally only available to large retail merchants, and can only be applied to multi-quantity, fixed-price listings. Merchants/developers can test In-Store Pickup functionality in the Sandbox environment, including listing items enabled with the In-Store Pickup feature, creating store locations and adding inventory to these stores using the Inventory Management API, and informing eBay of In-Store Pickup status changes using the Inbound Notifications API.
See the Field Index to learn which calls use PickupMethodSelected.

RefundAmount ( AmountType (double) ) [0..1]
Amount of the refund issued to the buyer. This field is only returned if the buyer has received a refund from the seller.
See the Field Index to learn which calls use RefundAmount.

RefundArray ( RefundArrayType ) [0..1]
Not used by any call.

Note: This container was only used for Half.com orders, and since the Half.com site was taken down, this container is no longer applicable. Container consisting of one or more refunds for Half.com orders. This container is returned only if a refund to a Half.com buyer has occurred.
See the Field Index to learn which calls use RefundArray.

RefundStatus ( string ) [0..1]
This string value indicates the result of a seller's refund to the buyer. Its value are 'Success', 'Failure' or 'Pending'. This field is only returned if the buyer has received a refund from the seller, or is due to receive a refund.
See the Field Index to learn which calls use RefundStatus.

SellerEIASToken ( string ) [0..1]
This is a unique identifier for the seller that does not change when the eBay user name is changed. This is useful when an application needs to associate a new eBay user name with the corresponding eBay user.
See the Field Index to learn which calls use SellerEIASToken.

SellerEmail ( string ) [0..1]
The email address of the seller involved in the order. The email address of the seller is only returned if it is the same seller making the call.
See the Field Index to learn which calls use SellerEmail.

SellerUserID ( UserIDType (string) ) [0..1]
This is the eBay user ID of the order's seller.
See the Field Index to learn which calls use SellerUserID.

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 eBay Features Guide for information about converting between GMT and other time zones.
See the Field Index to learn which calls use ShippedTime.

ShippingAddress ( AddressType ) [0..1]
Container holding the shipping address of the buyer involved in the order.
See the Field Index to learn which calls use ShippingAddress.

ShippingConvenienceCharge ( AmountType (double) ) [0..1]
The dollar value in this field indicates the amount that the seller is being charged (at order level) for the convenience of an eBay On Demand Delivery.

Note: This field was first created for eBay Now, but eBay Now has been officially retired in all US locations. However, a feature similar to eBay Now, called 'eBay On Demand Delivery', is available in some parts of London, so this field is still applicable on the eBay UK site.
See the Field Index to learn which calls use ShippingConvenienceCharge.

ShippingDetails ( ShippingDetailsType ) [0..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.
See the Field Index to learn which calls use ShippingDetails.

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

Note: If one or more OrderID values are used in the call request, the "Combined Invoice" Order ID value must be specified for multiple line item orders to ensure that the shipping service and cost information is accurate. If the individual OrderLineItemID values for each line item are specified in the OrderID field instead, the shipping service and cost information will not be accurate.
See the Field Index to learn which calls use ShippingServiceSelected.

Subtotal ( AmountType (double) ) [0..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.
See the Field Index to learn which calls use Subtotal.

Total ( AmountType (double) ) [0..1]
The Total amount equals the Subtotal value plus the shipping/handling, shipping insurance, and sales tax costs.
See the Field Index to learn which calls use Total.

TransactionArray ( TransactionArrayType ) [0..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 Invoice order. (In the future, AddOrder may enforce this recommendation.)
See the Field Index to learn which calls use TransactionArray.