This type is used to express the details of an order. An order may contain one or more line items (purchases) from the same buyer. Regardless of how many line items an order has, only one payment is made for the order.
The GetOrders and GetOrderTransactions calls return many of the fields of this type.
The GetItemTransactions and GetSellerTransactions calls will only return order-level details if the IncludeContainingOrder boolean field is included in the call request and set to true
.
The AddOrder call is used to combine two or more unpaid order line items (between the same seller and buyer) into a 'Combined Invoice' order. While combining these order line items into one 'Combined Invoice' order, the seller can make adjustments to accepted payment methods, shipping details (including costs), and the total cost of the order. Sometimes, sellers will reduce the cost of shipping if one or more order line items can be shipped together in the same package.
The GetMyeBaySelling call returns order details if the seller wishes to view listings that have sold, and the GetMyeBayBuying call returns order details if the buyer wishes to view items they have won or purchased.
Types that use OrderType:
Calls that use OrderType:
AddOrder, GetItemTransactions, GetMyeBayBuying, GetMyeBaySelling, GetOrders, GetOrderTransactions, GetSellerTransactions
SalesTax
(in US) or GST
(in Australia or New Zealand), the tax amount that the buyer paid is in this amount. Complete
.
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. true
if one or more line items in the order are subject to a tax (US sales tax or Australian Goods and Services tax) that eBay will collect and remit to the proper taxing authority on the buyer's behalf. This field is also returned if false
(not subject to eBay Collect and Remit). A Transaction.eBayCollectAndRemitTaxes container is returned for any order line items subject to such a tax, and the type and amount of this tax is displayed in the Transaction.eBayCollectAndRemitTaxes.TaxDetails container. 1000000000000
will be returned to all third parties. 1113
. During the transition period and even after, the new and old OrderID formats will still be supported/accepted in all Trading API call request payloads. After the transition period (which will be announced), only the new OrderID format will be returned in all Trading API call response payloads, regardless of the Trading WSDL version used or specified compatibility level.
true
indicates that the order can be paid for with a credit card through the seller's payment gateway account. true
, at least one order line item in the order will not be shipped directly to the buyer. Instead, the item(s) may be shipped to eBay's Global Shipping Program (GSP) partner who will handle the international leg of shipment, or the item may be shipped to eBay's Authenticity Guarantee service partner if the item is subject to the Authenticity Guarantee service program. In both cases, the partner's shipping address can be found in the MultiLegShippingDetails.SellerShipmentToLogisticsProvider.ShipToAddress container. 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.
false
.
1000000000000
or 1000000000000-1000000000000
.<OrderID/>
).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. 1113
. If a user is using a Trading WSDL older than 1107, this field will not be returned.
None
is shown). CreditCard
enumeration value should be passed into this field or the call may fail. CreditCard
, regardless of which payment method that the buyer used (or is planning to use). CreditCard
into this field.PayPal
as an accepted payment method, or opt in to the eBay managed payments program. If IMCC
is passed in as a value, this value will be ignored and dropped (and listing will possibly get blocked if IMCC
is the only specified payment method).
SalesTax
(in US) or GST
(in Australia or New Zealand), the tax amount that the buyer paid is in this amount. For a multiple line item order, the seller will need to look at and add up the TaxDetails.TaxAmount values for each line item to see how much sales tax is applicable for the whole order. Copyright © 2005–2021 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.