Trading_OrderType Class Reference

Inherits from	NSObject
Conforms to	PicoBindable
Declared in	Trading_OrderType.h Trading_OrderType.m

Overview

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.

@ingroup EBayAPIInterface

Tasks

orderID
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).
property
orderStatus
This enumeration value indicates the current status of the order.

Applicable to Half.com (for GetOrders).
property
adjustmentAmount
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).
property
amountPaid
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).
property
amountSaved
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.
property
checkoutStatus
Container consisting of details related to the current checkout status of the
order.

Applicable to Half.com (for GetOrders).
property
shippingDetails
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).
property
creatingUserRole
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.
property
createdTime
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).
property
paymentMethods
```
   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).
property
sellerEmail
The email address of the seller involved in the order.
property
shippingAddress
Container holding the shipping address of the buyer involved in the order.

Applicable to Half.com (for GetOrders).
property
shippingServiceSelected
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).
property
subtotal
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).
property
total
The Total amount equals the Subtotal value plus the shipping/handling, shipping insurance, and sales tax costs.

Applicable to Half.com (for GetOrders).
property
externalTransaction
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
DE and AT orders going through the new eBay payment process, the
PaymentHoldDetails container and PaymentHoldStatus
field will be returned instead of the ExternalTransaction
container.

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

Not applicable to Half.com.
property
transactionArray
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).
property
buyerUserID
eBay user ID of the order’s buyer.

Not applicable to Half.com.
property
paidTime
Timestamp indicating the date and time of order payment. This field is not returned until payment has been made and checkout is complete.

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).
property
shippedTime
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).
property
integratedMerchantCreditCardEnabled
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.
property
bundlePurchase
Reserved for future use.
property
buyerCheckoutMessage
This field is returned if the buyer left a message for the seller during
checkout.
property
eiasToken
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.
property
paymentHoldStatus
This field indicates the type and/or status of a payment hold on the item.
property
paymentHoldDetails
This container will be returned for DE and AT orders going through the new eBay
payment process. This container consists of the expected payout distribution to the
seller’s account, as well as possible actions that a seller can take to expedite the
payout for the order.

Note:
The introduction of the new eBay payment process for the entire German and
Austrian eBay marketplace has been delayed until further notice.
property
refundArray
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.
property
refundAmount
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.
property
refundStatus
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.
property
isMultiLegShipping
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.

property
multiLegShippingDetails
Contains details about the domestic leg of a Global Shipping Program shipment.

This information is not returned if IsMultilegShipping is false.
property
any
(public property)
property

Properties

adjustmentAmount

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

@property (nonatomic, retain) Trading_AmountType *adjustmentAmount

Discussion

type : class Trading_AmountType

Declared In

Trading_OrderType.h

amountPaid

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

@property (nonatomic, retain) Trading_AmountType *amountPaid

Discussion

type : class Trading_AmountType

Declared In

Trading_OrderType.h

amountSaved

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.

@property (nonatomic, retain) Trading_AmountType *amountSaved

Discussion

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.

type : class Trading_AmountType

Declared In

Trading_OrderType.h

any

(public property)

@property (nonatomic, retain) NSMutableArray *any

Discussion

(public property)

entry type : PicoAnyElement, wrapper for primitive anyelement

Declared In

Trading_OrderType.h

bundlePurchase

Reserved for future use.

@property (nonatomic, retain) NSNumber *bundlePurchase

Discussion

Reserved for future use.

type : NSNumber, wrapper for primitive bool

Declared In

Trading_OrderType.h

buyerCheckoutMessage

This field is returned if the buyer left a message for the seller during
checkout.

@property (nonatomic, retain) NSString *buyerCheckoutMessage

Discussion

This field is returned if the buyer left a message for the seller during
checkout.

type : NSString, wrapper for primitive string

Declared In

Trading_OrderType.h

buyerUserID

eBay user ID of the order’s buyer.

Not applicable to Half.com.

@property (nonatomic, retain) NSString *buyerUserID

Discussion

eBay user ID of the order’s buyer.

Not applicable to Half.com.

type : NSString, wrapper for primitive string

Declared In

Trading_OrderType.h

checkoutStatus

Container consisting of details related to the current checkout status of the
order.

Applicable to Half.com (for GetOrders).

@property (nonatomic, retain) Trading_CheckoutStatusType *checkoutStatus

Discussion

Container consisting of details related to the current checkout status of the
order.

Applicable to Half.com (for GetOrders).

type : class Trading_CheckoutStatusType

Declared In

Trading_OrderType.h

createdTime

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

@property (nonatomic, retain) NSDate *createdTime

Discussion

type : NSDate, wrapper for primitive date

Declared In

Trading_OrderType.h

creatingUserRole

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.

@property (nonatomic, retain) NSString *creatingUserRole

Discussion

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.

type: string constant in Trading_TradingRoleCodeType.h

Declared In

Trading_OrderType.h

eiasToken

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.

@property (nonatomic, retain) NSString *eiasToken

Discussion

type : NSString, wrapper for primitive string

Declared In

Trading_OrderType.h

externalTransaction

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
DE and AT orders going through the new eBay payment process, the
PaymentHoldDetails container and PaymentHoldStatus
field will be returned instead of the ExternalTransaction
container.

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

Not applicable to Half.com.

@property (nonatomic, retain) NSMutableArray *externalTransaction

Discussion

entry type : class Trading_ExternalTransactionType

Declared In

Trading_OrderType.h

integratedMerchantCreditCardEnabled

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.

@property (nonatomic, retain) NSNumber *integratedMerchantCreditCardEnabled

Discussion

type : NSNumber, wrapper for primitive bool

Declared In

Trading_OrderType.h

isMultiLegShipping

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.

@property (nonatomic, retain) NSNumber *isMultiLegShipping

Discussion

type : NSNumber, wrapper for primitive bool

Declared In

Trading_OrderType.h

multiLegShippingDetails

Contains details about the domestic leg of a Global Shipping Program shipment.

This information is not returned if IsMultilegShipping is false.

@property (nonatomic, retain) Trading_MultiLegShippingDetailsType *multiLegShippingDetails

Discussion

Contains details about the domestic leg of a Global Shipping Program shipment.

This information is not returned if IsMultilegShipping is false.

type : class Trading_MultiLegShippingDetailsType

Declared In

Trading_OrderType.h

orderID

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

@property (nonatomic, retain) NSString *orderID

Discussion

type : NSString, wrapper for primitive string

Declared In

Trading_OrderType.h

orderStatus

This enumeration value indicates the current status of the order.

Applicable to Half.com (for GetOrders).

@property (nonatomic, retain) NSString *orderStatus

Discussion

This enumeration value indicates the current status of the order.

Applicable to Half.com (for GetOrders).

type: string constant in Trading_OrderStatusCodeType.h

Declared In

Trading_OrderType.h

paidTime

Timestamp indicating the date and time of order payment. This field is not returned until payment has been made and checkout is complete.

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

@property (nonatomic, retain) NSDate *paidTime

Discussion

type : NSDate, wrapper for primitive date

Declared In

Trading_OrderType.h

paymentHoldDetails

This container will be returned for DE and AT orders going through the new eBay
payment process. This container consists of the expected payout distribution to the
seller’s account, as well as possible actions that a seller can take to expedite the
payout for the order.

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

@property (nonatomic, retain) Trading_PaymentHoldDetailType *paymentHoldDetails

Discussion

type : class Trading_PaymentHoldDetailType

Declared In

Trading_OrderType.h

paymentHoldStatus

This field indicates the type and/or status of a payment hold on the item.

@property (nonatomic, retain) NSString *paymentHoldStatus

Discussion

This field indicates the type and/or status of a payment hold on the item.

type: string constant in Trading_PaymentHoldStatusCodeType.h

Declared In

Trading_OrderType.h

paymentMethods

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

@property (nonatomic, retain) NSMutableArray *paymentMethods

Discussion

   This field indicates a payment method available to the buyer to pay for the

entry type : string constant in Trading_BuyerPaymentMethodCodeType.h

Declared In

Trading_OrderType.h

refundAmount

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.

@property (nonatomic, retain) Trading_AmountType *refundAmount

Discussion

type : class Trading_AmountType

Declared In

Trading_OrderType.h

refundArray

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.

@property (nonatomic, retain) Trading_RefundArrayType *refundArray

Discussion

type : class Trading_RefundArrayType

Declared In

Trading_OrderType.h

refundStatus

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.

@property (nonatomic, retain) NSString *refundStatus

Discussion

type : NSString, wrapper for primitive string

Declared In

Trading_OrderType.h

sellerEmail

The email address of the seller involved in the order.

@property (nonatomic, retain) NSString *sellerEmail

Discussion

The email address of the seller involved in the order.

type : NSString, wrapper for primitive string

Declared In

Trading_OrderType.h

shippedTime

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

@property (nonatomic, retain) NSDate *shippedTime

Discussion

type : NSDate, wrapper for primitive date

Declared In

Trading_OrderType.h

shippingAddress

Container holding the shipping address of the buyer involved in the order.

Applicable to Half.com (for GetOrders).

@property (nonatomic, retain) Trading_AddressType *shippingAddress

Discussion

Container holding the shipping address of the buyer involved in the order.

Applicable to Half.com (for GetOrders).

type : class Trading_AddressType

Declared In

Trading_OrderType.h

shippingDetails

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

@property (nonatomic, retain) Trading_ShippingDetailsType *shippingDetails

Discussion

type : class Trading_ShippingDetailsType

Declared In

Trading_OrderType.h

shippingServiceSelected

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

@property (nonatomic, retain) Trading_ShippingServiceOptionsType *shippingServiceSelected

Discussion

type : class Trading_ShippingServiceOptionsType

Declared In

Trading_OrderType.h

subtotal

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

@property (nonatomic, retain) Trading_AmountType *subtotal

Discussion

type : class Trading_AmountType

Declared In

Trading_OrderType.h

total

The Total amount equals the Subtotal value plus the shipping/handling, shipping insurance, and sales tax costs.

Applicable to Half.com (for GetOrders).

@property (nonatomic, retain) Trading_AmountType *total

Discussion

The Total amount equals the Subtotal value plus the shipping/handling, shipping insurance, and sales tax costs.

Applicable to Half.com (for GetOrders).

type : class Trading_AmountType

Declared In

Trading_OrderType.h

transactionArray

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

@property (nonatomic, retain) Trading_TransactionArrayType *transactionArray

Discussion

type : class Trading_TransactionArrayType

Declared In

Trading_OrderType.h