eBay Trading APIVersion 1131

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.
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 success or failure of the buyer's online payment for an order. Applicable for the payment method that the buyer chose for the order. If the payment failed, the value returned indicates the reason for the failure.
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 being returned with a value of true indicates that the order line item can be paid for with a credit card through the seller's payment gateway account.

Note: Beginning on May 1, 2019, eBay will no longer support electronic payments through Integrated Merchant Credit Card accounts. To accept online credit card payments from buyers, a seller must use specify PayPal as an accepted payment method, or opt in to eBay Managed Payments program (if the program is available to that seller).
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.
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. If checkout is not yet complete, PaymentMethodUsed, which is returned by the GetItemTransactions call, is set to whatever the buyer selected as his or her preference on the Review Your Purchase page.

Note: For sellers opted in to the eBay Managed Payments program, the enumeration value returned in this field will be CreditCard, regardless of the actual payment method used by the buyer to pay for the order.
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.