eBay Trading APIVersion 1235

TransactionStatusType

Contains the order status, e.g. the buyer's online payment and whether the checkout process for the order is complete.

Type that uses TransactionStatusType:

Calls that use TransactionStatusType:

Fields



BuyerSelectedShipping ( boolean ) [0..1]
Indicates whether the buyer has selected shipping details during checkout. False indicates that the shipping service was selected by eBay for the buyer. For example, if the buyer has not yet completed the Review Your Purchase page, he has not picked a shipping service. If it is false, the application should ignore ShippingServiceCost and ShippingServiceSelected (items whose values are defaulted by eBay).
See the Field Index to learn which calls use BuyerSelectedShipping.

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 an 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 ( CheckoutStatusCodeType ) [0..1]
Indicates the current status of the checkout flow for the order. If the payment was successfuly processed, a value of CheckoutComplete will be returned.
See the Field Index to learn which calls use CheckoutStatus.

CompleteStatus ( CompleteStatusCodeType ) [0..1]
Indicates whether checkout is complete, incomplete, or pending for an order.
See the Field Index to learn which calls use CompleteStatus.

DigitalStatus ( DigitalStatusCodeType ) [0..1]
This enumeration value indicates the current state of a purchased digital gift card. The normal flow is for the buyer (or other recipient of the gift card) to download the gift card from the delivered email after purchase, and then to activate the card for use. This field is only applicable and returned for digital gift card order line items.
See the Field Index to learn which calls use DigitalStatus.

eBayPaymentMismatchDetails ( eBayPaymentMismatchDetailsType ) [0..1]
Not used by any call.

This container is no longer used.
See the Field Index to learn which calls use eBayPaymentMismatchDetails.

eBayPaymentStatus ( PaymentStatusCodeType ) [0..1]
Indicates the status of the buyer's payment for an order. If the payment was successfuly processed, a value of NoPaymentFailure will be returned.
See the Field Index to learn which calls use eBayPaymentStatus.

InquiryStatus ( InquiryStatusCodeType ) [0..1]
This field gives the status of a buyer's Item Not Received (INR) Inquiry. This field is only returned if the buyer has created an INR Inquiry through the site or through the Post-Order API.
See the Field Index to learn which calls use InquiryStatus.

IntegratedMerchantCreditCardEnabled ( boolean ) [0..1]
This field is no longer applicable as eBay sellers can no longer use iMCC gateway accounts to handle buyer payments.
See the Field Index to learn which calls use IntegratedMerchantCreditCardEnabled.

LastTimeModified ( dateTime ) [0..1]
Indicates date and time an order's status was last updated (in GMT).
See the Field Index to learn which calls use LastTimeModified.

PaymentHoldStatus ( PaymentHoldStatusCodeType ) [0..1]
This field indicates the type and/or status of a payment hold on the item.

Note: For the GetItemTransactions, GetOrders, and GetOrderTransactions calls, this field is only returned to the seller of the order; this field is not returned for the buyer or third party.
See the Field Index to learn which calls use PaymentHoldStatus.

PaymentInstrument ( BuyerPaymentInstrumentCodeType ) [0..1]
The enumeration value in this field indicates which payment method was used by the German buyer who was offered the 'Pay Upon Invoice' option. This field will only be returned if a German buyer was offered the 'Pay Upon Invoice' option. Otherwise, the buyer's selected payment method is returned in the PaymentMethodUsed field by the GetItemTransactions call.
See the Field Index to learn which calls use PaymentInstrument.

PaymentMethodUsed ( BuyerPaymentMethodCodeType ) [0..1]
The payment method that the buyer selected to pay for the order.

Note: Sellers no longer have to specify any electronic payment methods at listing time, but this field is still returned. The value returned in this field will generally be CreditCard, unless an eBay gift card was used by the buyer to pay a partial or full balance of the order. If this is the case, the value returned in this field will be CCAccepted. Either of these two values will be returned, but neither accurately reflects the actual payment method that the buyer used. If the order was paid for off of eBay's platform using an 'offline' payment method such as 'CashOnPickup' or 'MOCC' (money order or cashier's check), and the seller marked the order as paid, either of those values may get returned here.
See the Field Index to learn which calls use PaymentMethodUsed.

ReturnStatus ( ReturnStatusCodeType ) [0..1]
This field gives the status of a buyer's return request. This field is only returned if the buyer has initiated a return request, or has escalated an existing return request into a return case.
See the Field Index to learn which calls use ReturnStatus.