eBay Trading APIVersion 1119

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]
This field may be used if the buyer and seller have agreed on making an adjustment to the order total. 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 listing that requires a deposit, the AmountPaid value 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]
The 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 may occur if there are multiple order line items between the buyer and seller. 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 value. An ItemID value can be paired up with a corresponding TransactionID value to identify and order line item in a ReviseCheckoutStatus call.

Unless an OrderLineItemID value is used to identify a an order line item, or an OrderID value is used to identify an order, the ItemID/TransactionID pair must be specified.

If an OrderID or an OrderLineItemID value is specified, the ItemID/TransactionID pair is ignored if present in the same request.

It is also possible to identify an order line item 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 order.

If an OrderID is used in the request, the OrderLineItemID and ItemID/TransactionID pair are ignored if they are specified in the same request.

Note: As of June 2019, eBay has changed the format of order identifier values. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. Unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.

For developers and sellers who are already integrated with the Trading API's order management calls, this change shouldn't impact your integration unless you parse the existing order identifiers (e.g., OrderID or OrderLineItemID), or otherwise infer meaning from the format (e.g., differentiating between a single line item order versus a multiple line item order). Because we realize that some integrations may have logic that is dependent upon the old identifier format, eBay is rolling out this Trading API change with version control to support a transition period of approximately 9 months before applications must switch to the new format completely.

During the transition period, for developers/sellers using a Trading WSDL older than Version 1113, they can use the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header in API calls to control whether the new or old OrderID format is returned in call response payloads. To get the new OrderID format, the value of the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header must be set to 1113. During the transition period and even after, the new and old OrderID formats will still be supported/accepted in all Trading API call request payloads. After the transition period (which will be announced), only the new OrderID format will be returned in all Trading API call response payloads, regardless of the Trading WSDL version used or specified compatibility level.
See the Field Index to learn which calls use OrderID.

OrderLineItemID ( string ) [0..1]
A unique identifier for an eBay order line item. This identifier is created once there is a commitment to buy (bidder wins the auction, buyer clicks buy button, or buyer purchases item through PlaceOffer call).

Unless an ItemID/TransactionID pair is used to identify an order line item, or the OrderID is used to identify an order, the OrderLineItemID must be specified. For a multiple line item 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 may be needed if the order payment between the buyer and seller happens off of eBay's platform. If the payment happens on eBay's platform, this field will not be necessary.

See eBay's Accepted Payments Policy for more information about safe offline payment methods. Accepted payment methods will vary by category and by country.
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 eBay's system. This field may be needed if the order payment between the buyer and seller happens off of eBay's platform. If the payment happens on eBay's platform, this field will not be necessary. A user specifies Pending to indicate that the order is awaiting payment or if the the buyer has initiated payment, but the funds have not yet been sent to the seller's financial institution.
See the Field Index to learn which calls use PaymentStatus.

SalesTax ( AmountType (double) ) [0..1]
This field is used if sales tax is being applied to the order. If the sales tax amount is also being applied to the shipping charges (in addition to the item cost), the ShippingIncludedInTax boolean field should be included in the call request and set to true.
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]
This field is used to show the cost of shipping being applied to the order.
See the Field Index to learn which calls use ShippingCost.

ShippingIncludedInTax ( boolean ) [0..1]
This field is included and set to true if sales tax for the order is applied against shipping costs (in addition to the item cost).
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 the DetailName field set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present in the response. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing.

Note: This field should not be used for orders being shipping through 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 a sales transaction. This identifier is created as soon as there is a commitment to buy (bidder wins the auction, buyer clicks buy button, or buyer purchases item through PlaceOffer call). Since an auction listing can only have one sale/winning bidder during the duration of the listing, the TransactionID value for auction listings is always 0. An ItemID/TransactionID pair can be used to identify an order line item in a ReviseCheckoutStatus call.

Unless an OrderLineItemID is used to identify an order line item, or an OrderID value is used to identify an order, the ItemID/TransactionID pair must be specified. For a multiple line item order, OrderID should 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.