Note: We recommend that you use the CompleteSale call instead of ReviseCheckoutStatus to update the status and/or details of your order. ReviseCheckoutStatus has been staged for deprecation and this endpoint will be decommissioned in July 2021. If your use case is to provide shipment tracking information for one or more line items of a paid order, you can use the createShippingFulfillment method of the Fulfillment API to do this task.
Use this call to update the payment details, the shipping details, and the status of an order.
A seller can use this call to:
If ReviseCheckoutStatus is called more than once for the same order (such as when checkout is marked as completed and later revised to incomplete), later calls only change values for arguments that are specified in the call. If any optional argument is not specified in the call, the value to which it corresponds is not changed from its original value.
You can test ReviseCheckoutStatus in the Sandbox as follows:
See Processing Checkouts.
See also the reference documentation for this call:
Output Detail Controls Samples Change History |
See also Samples.
The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.
The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).
<?xml version="1.0" encoding="utf-8"?> <ReviseCheckoutStatusRequest xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- Call-specific Input Fields --> <AdjustmentAmount currencyID="CurrencyCodeType"> AmountType (double) </AdjustmentAmount> <AmountPaid currencyID="CurrencyCodeType"> AmountType (double) </AmountPaid> <BuyerID> string </BuyerID> <CheckoutStatus> CompleteStatusCodeType </CheckoutStatus> <CODCost currencyID="CurrencyCodeType"> AmountType (double) </CODCost> <EncryptedID> string </EncryptedID> <ExternalTransaction> ExternalTransactionType <ExternalTransactionID> string </ExternalTransactionID> <ExternalTransactionTime> dateTime </ExternalTransactionTime> </ExternalTransaction> <ItemID> ItemIDType (string) </ItemID> <MultipleSellerPaymentID> string </MultipleSellerPaymentID> <OrderID> string </OrderID> <OrderLineItemID> string </OrderLineItemID> <PaymentMethodUsed> BuyerPaymentMethodCodeType </PaymentMethodUsed> <PaymentStatus> RCSPaymentStatusCodeType </PaymentStatus> <SalesTax currencyID="CurrencyCodeType"> AmountType (double) </SalesTax> <ShippingCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingCost> <ShippingIncludedInTax> boolean </ShippingIncludedInTax> <ShippingService> token </ShippingService> <TransactionID> string </TransactionID> <!-- Standard Input Fields --> <ErrorLanguage> string </ErrorLanguage> <InvocationID> UUIDType (string) </InvocationID> <MessageID> string </MessageID> <Version> string </Version> <WarningLevel> WarningLevelCodeType </WarningLevel> </ReviseCheckoutStatusRequest>
Argument | Type | Occurrence | Meaning |
---|
Call-specific Input Fields [Jump to standard fields] |
AdjustmentAmount | AmountType (double) | Optional | 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. |
AdjustmentAmount [ attribute currencyID ] |
CurrencyCodeType | Optional |
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. For a list of possible enumeration values, see CurrencyCodeType. |
AmountPaid | AmountType (double) | Conditional |
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 .
|
AmountPaid [ attribute currencyID ] |
CurrencyCodeType | Optional |
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 .For a list of possible enumeration values, see CurrencyCodeType. |
BuyerID | string | Conditional | 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. |
CheckoutStatus | CompleteStatusCodeType | Conditional |
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 .
Applicable values: Note: If the PaymentMethodUsed is CashOnPickup , the CheckoutStatus.Status value in GetOrders will be Complete at checkout time, even though the seller may not have been officially paid yet. The CheckoutStatus.Status value in GetOrders will remain as Complete even if the seller uses ReviseCheckoutStatus to change the checkout status to Pending . However, the eBayPaymentStatus value in GetOrders will change from NoPaymentFailure to PaymentInProcess . (Not all values in CompleteStatusCodeType apply to this field.) |
CODCost | AmountType (double) | Optional |
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 Specifying the Cash on Delivery Option in Shipping Details. |
CODCost [ attribute currencyID ] |
CurrencyCodeType | Optional |
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. For a list of possible enumeration values, see CurrencyCodeType. |
EncryptedID | string | Optional |
Not supported. Max length: 20. |
ExternalTransaction | ExternalTransactionType | Optional | 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. |
ExternalTransaction .ExternalTransactionID |
string | Conditional | Unique identifier for a PayPal payment of an eBay order. If the order was purchased with a payment method other than PayPal, "SIS" is returned, which stands for "Send Information To Seller." This field is only returned after payment has been made. |
ExternalTransaction .ExternalTransactionTime |
dateTime | Conditional | Timestamp for payment transaction. |
ItemID | ItemIDType (string) | Conditional |
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. |
MultipleSellerPaymentID | string | Optional | Not supported. |
OrderID | string | Optional |
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: In June 2019, eBay introduced a new order ID format, but allowed developers/sellers to decide whether to immediately adopt the new format, or to continue working with the old format. Users who wanted to adopt the new format, could either use a Trading WSDL Version 1113 (or newer), or they could even use an older Trading WSDL but set the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header value to 1113 in API calls. Beginning in June 2020, only the new order ID format will be returned in response payloads for paid orders, regardless of the WSDL version number or compatibility level. Note that the unique identifier of a 'non-immediate payment' order will change as it goes from an unpaid order to a paid order. Due to this scenario, all calls that accept Order ID values as filters in the request payload, including the ReviseCheckoutStatus call, will support the identifiers for both unpaid and paid orders. The new order ID 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. Sellers can check to see if an order has been paid by looking for a value of 'Complete' in the CheckoutStatus.Status field in the response of GetOrders or GetOrderTransactions call, or in the Status.CompleteStatus field in the response of GetItemTransactions or GetSellerTransactions call. Sellers should not fulfill orders until buyer has made payment. Max length: 40. |
OrderLineItemID | string | Conditional |
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. |
PaymentMethodUsed | BuyerPaymentMethodCodeType | Conditional |
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. Applicable values: See PaymentMethodUsed. |
PaymentStatus | RCSPaymentStatusCodeType | Optional |
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.
Applicable values: (Not all values in RCSPaymentStatusCodeType apply to this field.) |
SalesTax | AmountType (double) | Optional |
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 .
|
SalesTax [ attribute currencyID ] |
CurrencyCodeType | Optional |
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 .For a list of possible enumeration values, see CurrencyCodeType. |
ShippingCost | AmountType (double) | Optional | This field is used to show the cost of shipping being applied to the order. |
ShippingCost [ attribute currencyID ] |
CurrencyCodeType | Optional |
This field is used to show the cost of shipping being applied to the order. For a list of possible enumeration values, see CurrencyCodeType. |
ShippingIncludedInTax | boolean | Optional |
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).Default: false. |
ShippingService | token | Optional |
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. Applicable values: See ShippingServiceCodeType |
TransactionID | string | Conditional |
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. |
Standard Input Fields |
ErrorLanguage | string | Optional |
Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Below are some examples from different countries.
|
||||||||||||||||||||||||||||||||||||||||
InvocationID | UUIDType (string) | Optional |
A unique identifier for a particular call. If the same InvocationID is passed in after it has been passed in once on a call that succeeded for a particular application and user, then an error will be returned. The identifier can only contain digits from 0-9 and letters from A-F. The identifier must be 32 characters long. For example, 1FB02B2-9D27-3acb-ABA2-9D539C374228. Max length: 32. |
||||||||||||||||||||||||||||||||||||||||
MessageID | string | Optional |
Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable. |
||||||||||||||||||||||||||||||||||||||||
Version | string | Conditional |
The version number of the API code that you are programming against (e.g., 1149). The version you specify for a call has these basic effects:
For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See:
|
||||||||||||||||||||||||||||||||||||||||
WarningLevel | WarningLevelCodeType | Optional |
Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests performed in the Production environment. Applicable values: High if the user wishes to receive warnings when the application passes unrecognized or deprecated elements in an API call request. Setting the WarningLevel value to High is not recommended in a production environment. Instead, it should only be used during the development/debugging stage.Low if the user does not wish to receive warnings when the application passes unrecognized or deprecated elements in an API call request. This is the default value if WarningLevel is not specified in the call request.See Warning Level. |
Input Detail Controls Samples Change History |
See also Samples.
The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).
See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).
<?xml version="1.0" encoding="utf-8"?> <ReviseCheckoutStatusResponse xmlns="urn:ebay:apis:eBLBaseComponents"> <!-- (No call-specific Output fields) --> <!-- Standard Output Fields --> <Ack> AckCodeType </Ack> <Build> string </Build> <CorrelationID> string </CorrelationID> <DuplicateInvocationDetails> DuplicateInvocationDetailsType <DuplicateInvocationID> UUIDType (string) </DuplicateInvocationID> <InvocationTrackingID> string </InvocationTrackingID> <Status> InvocationStatusType </Status> </DuplicateInvocationDetails> <Errors> ErrorType <ErrorClassification> ErrorClassificationCodeType </ErrorClassification> <ErrorCode> token </ErrorCode> <ErrorParameters ParamID="string"> ErrorParameterType <Value> string </Value> </ErrorParameters> <!-- ... more ErrorParameters nodes allowed here ... --> <LongMessage> string </LongMessage> <SeverityCode> SeverityCodeType </SeverityCode> <ShortMessage> string </ShortMessage> </Errors> <!-- ... more Errors nodes allowed here ... --> <HardExpirationWarning> string </HardExpirationWarning> <Timestamp> dateTime </Timestamp> <Version> string </Version> </ReviseCheckoutStatusResponse>
Return Value | Type | Occurrence | Meaning |
---|
(No call-specific fields) |
Standard Output Fields |
Ack | AckCodeType | Always |
A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for the Ack field.
Applicable values: (Not all values in AckCodeType apply to this field.) Code so that your app gracefully handles any future changes to this list. |
Build | string | Always | This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues. |
CorrelationID | string | Conditionally |
Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable. |
DuplicateInvocationDetails | DuplicateInvocationDetailsType | Conditionally | Information that explains a failure due to a duplicate InvocationID being passed in. |
DuplicateInvocationDetails .DuplicateInvocationID |
UUIDType (string) | Conditionally | This value represents the duplicate InvocationID or InvocationTrackingID that was used in the call request. |
DuplicateInvocationDetails .InvocationTrackingID |
string | Conditionally | This unique identifier identifies the business item the previous API invocation created. For example, the Item ID of the item created by an AddItem call. |
DuplicateInvocationDetails .Status |
InvocationStatusType | Conditionally |
This enumeration value indicates the status of the previous call that used the InvocationID or InvocationTrackingID specified in the DuplicateInvocationID.
Applicable values: Code so that your app gracefully handles any future changes to this list. |
Errors | ErrorType | Conditionally,
repeatable: [0..*] |
A list of application-level errors (if any) that occurred when eBay processed the request.
See Error Handling. |
Errors.ErrorClassification | ErrorClassificationCodeType | Conditionally |
API errors are divided between two classes: system errors and request errors.
Applicable values: Code so that your app gracefully handles any future changes to this list. |
Errors.ErrorCode | token | Conditionally | A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document. |
Errors.ErrorParameters | ErrorParameterType | Conditionally,
repeatable: [0..*] |
This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned. |
Errors.ErrorParameters [ attribute ParamID ] |
string | Conditionally | This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned. |
Errors.ErrorParameters.Value | string | Conditionally | This is the value of the request parameter noted in the ParamID attribute. So, if the ParamID value was ItemID, the value in this field would be the actual value of that ItemID. |
Errors.LongMessage | string | Conditionally | A more detailed description of the condition that raised the error. |
Errors.SeverityCode | SeverityCodeType | Conditionally |
Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.
Applicable values: If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
See the Compatible Application Check section of the eBay Features Guide for more information. When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future. Code so that your app gracefully handles any future changes to this list. |
Errors.ShortMessage | string | Conditionally | A brief description of the condition that raised the error. |
HardExpirationWarning | string | Conditionally | Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token. |
Timestamp | dateTime | Always |
This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the Time Values section in the eBay Features Guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed. |
Version | string | Always | The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response. |
Input Output Samples Change History |
This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.
Input Output Detail Controls Change History |
New to making API calls? Please see Making a Call.
Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.
Adjusts the amount of the item price after the sale.
Description
The following sample shows an item amount being adjusted. Because the item was a Chinese auction, the TransactionID is 0
.
Input
XML format.
<?xml version="1.0" encoding="utf-8"?>
<ReviseCheckoutStatusRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<RequesterCredentials>
<eBayAuthToken>ABC...123</eBayAuthToken>
</RequesterCredentials>
<AdjustmentAmount>-3.23</AdjustmentAmount>
<AmountPaid currencyID="USD">12.43</AmountPaid>
<ItemID>9204269499</ItemID>
<TransactionID>0</TransactionID>
<CheckoutStatus>Complete</CheckoutStatus>
</ReviseCheckoutStatusRequest>
Output
XML format.
<?xml version="1.0" encoding="utf-8"?>
<ReviseCheckoutStatusResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<Timestamp>2019-11-06T18:32:47.963Z</Timestamp>
<Ack>Success</Ack>
<Version>1131</Version>
<Build>E1131_CORE_APIXO_19102180_R1</Build>
</ReviseCheckoutStatusResponse>
Input Output Detail Controls Samples |
Change Date | Description |
---|---|
1145 2020-03-13 |
|
1113 2019-06-21 |
|
1107 2019-05-10 |
|
1085 2018-10-26 |
|
0945 2015-10-15 |
|
0899 2014-11-04 |
|
0849 2013-11-05 |
|
0791 2012-09-12 |
|
0719 2011-04-27 |
|
0705 2011-01-19 |
|
0653 2010-01-20 |
|
0555 2008-03-05 |
|
0537 2007-10-31 |
|
0477 2006-09-06 |
|
0409 2005-05-18 |
|
Copyright © 2005–2020 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.