NAME

eBay::API::XML::DataType::OrderType

DESCRIPTION

A combination of two or more transactions that can be paid for with a single payment.<br> <br> We strongly recommend that you avoid mixing digital and non-digital listings in the same order. (In the future, AddOrder may enforce this recommendation.

SYNOPSIS

INHERITANCE

eBay::API::XML::DataType::OrderType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

setAdjustmentAmount()

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).

# Argument: 'ns:AmountType'

getAdjustmentAmount()

  Calls: GetOrders
  Returned: Always
  Details: DetailLevel: none

  Calls: GetOrderTransactions
  Returned: Always
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'ns:AmountType'

setAmountPaid()

Amount the buyer has paid the seller for the order. For GetOrders, applies only to Half.com.

# Argument: 'ns:AmountType'

getAmountPaid()

  Calls: GetOrders
  Returned: Always
  Details: DetailLevel: none

  Calls: GetOrderTransactions
  Returned: Always
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'ns:AmountType'

setAmountSaved()

Amount the buyer saved by having multiple items combined into a single order, versus purchasing the items separately.

# Argument: 'ns:AmountType'

getAmountSaved()

  Calls: GetOrders
  Returned: Always
  Details: DetailLevel: none

  Calls: GetOrderTransactions
  Returned: Always
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'ns:AmountType'

setBuyerUserID()

User ID of the order's buyer. Not applicable to Half.com.

# Argument: 'ns:UserIDType'

getBuyerUserID()

  Calls: GetOrders
  Returned: Always
  Details: DetailLevel: none

  Calls: GetOrderTransactions
  Returned: Always
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'ns:UserIDType'

setCheckoutStatus()

The current checkout status of the order. Also applicable to Half.com (for GetOrders).

# Argument: 'ns:CheckoutStatusType'

getCheckoutStatus()

  Calls: GetOrders
  Returned: Always
  Details: DetailLevel: none

  Calls: GetOrderTransactions
  Returned: Always
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'ns:CheckoutStatusType'

setCreatedTime()

Date and time the order was created. Also applicable to Half.com (for GetOrders).

# Argument: 'xs:dateTime'

getCreatedTime()

  Calls: GetOrders
  Returned: Always
  Details: DetailLevel: none

  Calls: GetOrderTransactions
  Returned: Always
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'xs:dateTime'

setCreatingUserRole()

Indicates whether the order is created by the buyer or by the seller.

  Calls: AddOrder
  RequiredInput: Yes

# Argument: 'ns:TradingRoleCodeType'

getCreatingUserRole()

  Calls: GetOrders
  Returned: Always
  Details: DetailLevel: none

  Calls: GetOrderTransactions
  Returned: Always
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

  Calls: GetItemTransactions
         GetSellerTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'ns:TradingRoleCodeType'

setExternalTransaction()

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.

# Argument: reference to an array of 'ns:ExternalTransactionType'

getExternalTransaction()

  Calls: GetOrderTransactions
  Returned: Conditionally
  Details: DetailLevel: ReturnAll

# Returns: reference to an array of 'ns:ExternalTransactionType'

setOrderID()

Unique identifier that eBay generates for the order.<br> <br> 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).<br> <br> Also applicable to Half.com (for GetOrders).

# Argument: 'ns:OrderIDType'

getOrderID()

  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll
  Context: WonList
           DeletedFromWonList

  Calls: GetMyeBaySelling
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll
  Context: SoldList
           DeletedFromSoldList

  Calls: GetOrders
  Returned: Always
  Details: DetailLevel: none

  Calls: GetOrderTransactions
  Returned: Always
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

  Calls: GetItemTransactions
         GetSellerTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ReturnAll

# Returns: 'ns:OrderIDType'

setOrderStatus()

The current status of the order.<br> <br> For transaction calls (like GetItemTransactions), please use the TransactionPlatform element to determine whether an item was purchased on Express on eBay.<br> <br> Also applicable to Half.com (for GetOrders).

# Argument: 'ns:OrderStatusCodeType'

getOrderStatus()

  Calls: GetOrders
  Returned: Always
  Details: DetailLevel: none

  Calls: GetOrderTransactions
  Returned: Always
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

  Calls: GetItemTransactions
         GetSellerTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ReturnAll

# Returns: 'ns:OrderStatusCodeType'

setPaidTime()

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).

# Argument: 'xs:dateTime'

getPaidTime()

  Calls: GetOrders
  Returned: Conditionally
  Details: DetailLevel: none

  Calls: GetOrderTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'xs:dateTime'

setPaymentMethods()

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).

  Calls: AddOrder
  RequiredInput: No

# Argument: reference to an array of 'ns:BuyerPaymentMethodCodeType'

getPaymentMethods()

  Calls: GetOrders
  Returned: Always
  Details: DetailLevel: none

  Calls: GetOrderTransactions
  Returned: Always
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: reference to an array of 'ns:BuyerPaymentMethodCodeType'

setSellerEmail()

The email of the order's seller.

# Argument: 'xs:string'

getSellerEmail()

# Returns: 'xs:string'

setShippedTime()

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).

# Argument: 'xs:dateTime'

getShippedTime()

  Calls: GetOrders
  Returned: Conditionally
  Details: DetailLevel: none

  Calls: GetOrderTransactions
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'xs:dateTime'

setShippingAddress()

Shipping address the order has been or will be sent to. Also applicable to Half.com (for GetOrders).

# Argument: 'ns:AddressType'

getShippingAddress()

  Calls: GetOrders
  Returned: Always
  Details: DetailLevel: none

  Calls: GetOrderTransactions
  Returned: Always
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'ns:AddressType'

setShippingDetails()

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).

  Calls: AddOrder
  RequiredInput: No

# Argument: 'ns:ShippingDetailsType'

getShippingDetails()

  Calls: GetOrders
  Returned: Always
  Details: DetailLevel: none

  Calls: GetOrderTransactions
  Returned: Always
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'ns:ShippingDetailsType'

setShippingServiceSelected()

The shipping service selected by the buyer from the services offered by the seller. Also applicable to Half.com (for GetOrders).

# Argument: 'ns:ShippingServiceOptionsType'

getShippingServiceSelected()

  Calls: GetOrders
  Returned: Always
  Details: DetailLevel: none

  Calls: GetOrderTransactions
  Returned: Always
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'ns:ShippingServiceOptionsType'

setSubtotal()

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).

# Argument: 'ns:AmountType'

getSubtotal()

  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll
  Context: WonList
           DeletedFromWonList

  Calls: GetMyeBaySelling
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll
  Context: SoldList
           DeletedFromSoldList

  Calls: GetOrders
  Returned: Always
  Details: DetailLevel: none

  Calls: GetOrderTransactions
  Returned: Always
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'ns:AmountType'

setTotal()

Subtotal plus the shipping cost plus the sales tax plus cost of insurance. Also applicable to Half.com (for GetOrders).

  Calls: AddOrder
  RequiredInput: Yes

# Argument: 'ns:AmountType'

getTotal()

  Calls: GetOrders
  Returned: Always
  Details: DetailLevel: none

  Calls: GetOrderTransactions
  Returned: Always
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

# Returns: 'ns:AmountType'

setTransactionArray()

The set of two or more transactions that make up the order. Also applicable to Half.com (for GetOrders).<br> <br> 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.)

  Calls: AddOrder
  RequiredInput: Yes

# Argument: 'ns:TransactionArrayType'

getTransactionArray()

  Calls: GetOrders
  Returned: Always
  Details: DetailLevel: none

  Calls: GetOrderTransactions
  Returned: Always
  Details: DetailLevel: none, ItemReturnDescription, ReturnAll

  Calls: GetMyeBayBuying
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll
  Context: WonList
           DeletedFromWonList

  Calls: GetMyeBaySelling
  Returned: Conditionally
  Details: DetailLevel: none, ReturnSummary, ReturnAll
  Context: SoldList
           DeletedFromSoldList

# Returns: 'ns:TransactionArrayType'