ReviseCheckoutStatusRequestType

A seller can use this call to update the payment details, the shipping details, and the status of an order.

Fields

AdjustmentAmount ( AmountType (double) )
AmountPaid ( AmountType (double) )
BuyerID ( string )
CheckoutStatus ( CompleteStatusCodeType )
CODCost ( AmountType (double) )
EncryptedID ( string )
ExternalTransaction ( ExternalTransactionType )
InsuranceType ( InsuranceSelectedCodeType )
ItemID ( ItemIDType (string) )
MultipleSellerPaymentID ( string )
OrderID ( string )
OrderLineItemID ( string )
PaymentMethodUsed ( BuyerPaymentMethodCodeType )
PaymentStatus ( RCSPaymentStatusCodeType )
SalesTax ( AmountType (double) )
ShippingAddress ( AddressType )
ShippingCost ( AmountType (double) )
ShippingIncludedInTax ( boolean )
ShippingInsuranceCost ( AmountType (double) )
ShippingService ( token )
TransactionID ( string )

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 motor vehicle purchased on eBay Motors, 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.

CheckoutStatus ( see CompleteStatusCodeType for possible values ) [1]
The current checkout status of the order. Often, the seller or application will mark this value as 'Complete' if payment has been made. The CheckoutStatus value cannot be updated by DE and AT sellers who are subject to the new payment process, and an attempt to do so in a ReviseCheckoutStatus call will result in a call error.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.
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]
Container consisting of a unique identifier and timestamp for the electronic payment of an order. An ExternalTransactionID is not exposed to a new DE or AT seller who is 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.
See the Field Index to learn which calls use ExternalTransaction.

InsuranceType ( see InsuranceSelectedCodeType for possible values ) [0..1]
Enumeration value that indicates whether shipping insurance was offered to and selected by the buyer.
See the Field Index to learn which calls use InsuranceType.

ItemID ( ItemIDType (string) ) [0..1]
Unique identifier for an eBay item listing. A listing can have multiple order line items (transactions), 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 Payment) order, the ItemID/TransactionID pair must be specified. For a multiple line item (Combined Payment) 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 Payment) 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, 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 Payment order through the eBay site. A Combined Payment 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 Payment) order, the OrderLineItemID must be specified. For a multiple line item (Combined Payment) 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 ( see BuyerPaymentMethodCodeType for possible values ) [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. Refer to Payment Method Differences (PaymentMethod) in the eBay Trading API Guide for information to help you determine which payment methods you are required or allowed to specify.
See the Field Index to learn which calls use PaymentMethodUsed.

PaymentStatus ( see RCSPaymentStatusCodeType for possible values ) [0..1]
Marks the order as paid or awaiting payment in My eBay. If you specify Paid, My eBay displays an icon for each 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.

The PaymentStatus value cannot be updated by DE and AT sellers who are subject to the new eBay payment process, and an attempt to do so in a ReviseCheckoutStatus call will result in a call error.

Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice.
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]
For internal use.
See the Field Index to learn which calls use ShippingAddress.

ShippingCost ( AmountType (double) ) [0..1]
The 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]
The amount of money paid for 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 (transaction). 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 Payment) order, the ItemID/TransactionID pair must be specified. For a multiple line item (Combined Payment) 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.

Copyright © 2005–2013 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.