eBay Trading APIVersion 1061

ReviseCheckoutStatusRequestType ( AbstractRequestType )

Enables a seller to update the payment details, the shipping details, and the status of an order.

Call that uses ReviseCheckoutStatusRequestType:

Fields



AdjustmentAmount ( AmountType (double) ) [0..1]
Discount or charge agreed to by the buyer and seller. A positive value indicates that the amount is an extra charge being paid to the seller by the buyer. A negative value indicates that the amount is a discount given to the buyer by the seller.
See the Field Index to learn which calls use AdjustmentAmount.

AmountPaid ( AmountType (double) ) [0..1]
The total amount paid by the buyer. For a US eBay Motors item, AmountPaid is the total amount paid by the buyer for the deposit. AmountPaid is optional if CheckoutStatus is Incomplete and required if it is Complete.
See the Field Index to learn which calls use AmountPaid.

BuyerID ( string ) [0..1]
eBay user ID for the order's buyer. A single line item order can actually be identified by a BuyerID/ItemID pair, but this approach is not recommended since an error is returned if there are multiple order line items for that combination. BuyerID is ignored if any other valid filter or filter combination is used in the same request.
See the Field Index to learn which calls use BuyerID.

CheckoutMethod ( CheckoutMethodCodeType ) [0..1]
Not used by any call.

This field is deprecated.
See the Field Index to learn which calls use CheckoutMethod.

CheckoutStatus ( CompleteStatusCodeType ) [0..1]
This field is included and its value is set to Complete if the seller is using the ReviseCheckoutStatus call to mark the order as 'Paid' by including the PaymentStatus field and setting its value to Paid.
See the Field Index to learn which calls use CheckoutStatus.

CODCost ( AmountType (double) ) [0..1]
This dollar value indicates the money due from the buyer upon delivery of the item.

This field should only be specified in the ReviseCheckoutStatus request if 'COD' (cash-on-delivery) was the payment method selected by the buyer and it is included as the PaymentMethodUsed value in the same request.
See the Field Index to learn which calls use CODCost.

EncryptedID ( string ) [0..1]
Not supported.
See the Field Index to learn which calls use EncryptedID.

ExternalTransaction ( ExternalTransactionType ) [0..1]
This container is used if payment for the order occurred off of eBay, and the seller wants to pass in the external payment reference ID.
See the Field Index to learn which calls use ExternalTransaction.

InsuranceType ( InsuranceSelectedCodeType ) [0..1]
Not used by any call.

This field is no longer applicable as it is not longer possible for a seller to offer a buyer shipping insurance.
See the Field Index to learn which calls use InsuranceType.

ItemID ( ItemIDType (string) ) [0..1]
Unique identifier for an eBay listing. A listing can have multiple order line items, but only one ItemID. An ItemID can be paired up with a corresponding TransactionID and used as an input filter for ReviseCheckoutStatus.

Unless an OrderLineItemID is used to identify a single line item order, or the OrderID is used to identify a single or multiple line item (Combined Invoice) order, the ItemID/TransactionID pair must be specified. For a multiple line item (Combined Invoice) order, OrderID should be used. If OrderID or OrderLineItemID are specified, the ItemID/TransactionID pair is ignored if present in the same request.

It is also possible to identify a single line item order with a ItemID/BuyerID combination, but this is not the most ideal approach since an error is returned if there are multiple order line items for that combination.
See the Field Index to learn which calls use ItemID.

MultipleSellerPaymentID ( string ) [0..1]
Not supported.
See the Field Index to learn which calls use MultipleSellerPaymentID.

OrderID ( string ) [0..1]
A unique identifier that identifies a single line item or multiple line item (Combined Invoice) 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 Invoice order, the OrderID value is created by eBay when the buyer or seller (sharing multiple, common order line items) combines multiple order line items into a Combined Invoice order through the eBay site. A Combined Invoice order can also be created by the seller through the AddOrder call. The OrderID can be used as an input filter for ReviseCheckoutStatus.

OrderID overrides an OrderLineItemID or ItemID/TransactionID pair if these fields are also specified in the same request.
See the Field Index to learn which calls use OrderID.

OrderLineItemID ( string ) [0..1]
OrderLineItemID is a unique identifier for an eBay order line item and is based upon the concatenation of ItemID and TransactionID, with a hyphen in between these two IDs. For a single line item order, the OrderLineItemID value can be passed into the OrderID field to revise the checkout status of the order.

Unless an ItemID/TransactionID pair is used to identify a single line item order, or the OrderID is used to identify a single or multiple line item (Combined Invoice) order, the OrderLineItemID must be specified. For a multiple line item (Combined Invoice) order, OrderID should be used. If OrderLineItemID is specified, the ItemID/TransactionID pair are ignored if present in the same request.
See the Field Index to learn which calls use OrderLineItemID.

PaymentMethodUsed ( BuyerPaymentMethodCodeType ) [0..1]
Payment method used by the buyer. This field is required if CheckoutStatus is Complete and the payment method is a trusted payment method other than PayPal. See eBay's Accepted Payments Policy. If the payment method is PayPal, this field should not be used since only PayPal can set this field's value to "PayPal". ReviseCheckoutStatus cannot be used for a non-trusted payment method. Note:Required or allowed payment methods vary by site and category.
See the Field Index to learn which calls use PaymentMethodUsed.

PaymentStatus ( RCSPaymentStatusCodeType ) [0..1]
This field is used to mark the order as paid or awaiting payment in My eBay. If you specify 'Paid', My eBay displays an icon for each line item in the order to indicate that the order status is Paid. If you specify 'Pending', this indicates that the order is awaiting payment (some applications may use 'Pending' when the buyer has paid, but the funds have not yet been sent to the seller's financial institution).

ReviseCheckoutStatus cannot be used to update payment and checkout status for a non-trusted payment method. See eBay's Accepted Payments Policy for more information on trusted payment methods. If the payment method is PayPal, this field should not be used since PayPal automatically set this field's value to "Paid" upon receiving the buyer's payment.
See the Field Index to learn which calls use PaymentStatus.

SalesTax ( AmountType (double) ) [0..1]
The sales tax amount for the order. This field should be used if sales tax was applied to the order.
See the Field Index to learn which calls use SalesTax.

ShippingAddress ( AddressType ) [0..1]
Not used by any call.

For internal use only. Do not use.
See the Field Index to learn which calls use ShippingAddress.

ShippingCost ( AmountType (double) ) [0..1]
Amount of money paid for shipping.
See the Field Index to learn which calls use ShippingCost.

ShippingIncludedInTax ( boolean ) [0..1]
An indicator of whether shipping costs were included in the taxable amount.
See the Field Index to learn which calls use ShippingIncludedInTax.

ShippingInsuranceCost ( AmountType (double) ) [0..1]
Not used by any call.

This field is no longer applicable as it is not longer possible for a seller to offer a buyer shipping insurance.
See the Field Index to learn which calls use ShippingInsuranceCost.

ShippingService ( token ) [0..1]
The shipping service selected by the buyer from among the shipping services offered by the seller (such as UPS Ground). For a list of valid values, call GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.

Note: ReviseCheckoutStatus is not available for the Global Shipping program; specifying InternationalPriorityShipping as a value for this field will produce an error.
See the Field Index to learn which calls use ShippingService.

TransactionID ( string ) [0..1]
Unique identifier for an eBay order line item. An order line item is created once there is a commitment from a buyer to purchase an item. Since an auction listing can only have one order line item during the duration of the listing, the TransactionID for auction listings is always 0. Along with its corresponding ItemID, a TransactionID is used and referenced during an order checkout flow and after checkout has been completed. The ItemID/TransactionID pair can be used as an input filter for ReviseCheckoutStatus.

Unless an OrderLineItemID is used to identify a single line item order, or the OrderID is used to identify a single or multiple line item (Combined Invoice) order, the ItemID/TransactionID pair must be specified. For a multiple line item (Combined Invoice) order, OrderID must be used. If OrderID or OrderLineItemID are specified, the ItemID/TransactionID pair is ignored if present in the same request.
See the Field Index to learn which calls use TransactionID.