eBay Trading APIVersion 1039

ReviseCheckoutStatus

Use this call to update the payment details, the shipping details, and the status of an order.

Usage Details

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.

Testing ReviseCheckoutStatus

You can test ReviseCheckoutStatus in the Sandbox as follows:

  1. Create a listing. For ease of testing, give it a "Buy It Now" option. Capture the resulting ItemID.
  2. With a user other than the one who listed the item, buy the item.
  3. Capture the resulting OrderLineItemID.
  4. Call ReviseCheckoutStatus with the correct OrderLineItemID, set CheckoutStatus to Complete, set PaymentStatus to Paid, and (to simulate the seller accepting a different payment amount) supply a value for AmountPaid that is different from the Buy It Now price.
  5. Call GetOrders, passing the same OrderLineItemID value into the OrderIDArray.OrderID request field, and note the value of OrderArray.Order.AmountPaid. in the response.

Related Information

See Checkout.

See also the reference documentation for this call:



Input

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 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.
AdjustmentAmount
  [ attribute currencyID ]
CurrencyCodeType Optional 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.

For a list of possible enumeration values, see CurrencyCodeType.
AmountPaid AmountType (double) Conditional 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.
AmountPaid
  [ attribute currencyID ]
CurrencyCodeType Optional 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.

For a list of possible enumeration values, see CurrencyCodeType.
BuyerID string Conditional 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.
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:

Complete
(in/out) This value indicates that the order or order line item is complete. Generally speaking, an order or order line item is complete when payment from the buyer has been initiated and has been processed.

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 Other Shipping Features.

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. 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.

Max length: 19 (Note: ItemIDs are usually 9 to 12 digits).
MultipleSellerPaymentID string Optional Not supported.
OrderID string Optional 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.
OrderLineItemID string Conditional 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.
Max length: 100.
PaymentMethodUsed BuyerPaymentMethodCodeType Conditional 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.

Applicable values: See PaymentMethodUsed.
PaymentStatus RCSPaymentStatusCodeType Optional 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.

Applicable values:

Paid
(in) Order line item payment is completed.
Pending
(in) Order line item is awaiting payment.

(Not all values in RCSPaymentStatusCodeType apply to this field.)
SalesTax AmountType (double) Optional The sales tax amount for the order. This field should be used if sales tax was applied to the order.
SalesTax
  [ attribute currencyID ]
CurrencyCodeType Optional The sales tax amount for the order. This field should be used if sales tax was applied to the order.

For a list of possible enumeration values, see CurrencyCodeType.
ShippingCost AmountType (double) Optional Amount of money paid for shipping.
ShippingCost
  [ attribute currencyID ]
CurrencyCodeType Optional Amount of money paid for shipping.

For a list of possible enumeration values, see CurrencyCodeType.
ShippingIncludedInTax boolean Optional An indicator of whether shipping costs were included in the taxable amount.
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 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.

Applicable values: See ShippingServiceCodeType
TransactionID string Conditional 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.

Max length: 19 (Note: TransactionIDs are usually 9 to 12 digits.).
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. Specify the standard RFC 3066 language identification tag (e.g., en_US).

ID Country
en_AU Australia
de_AT Austria
nl_BE Belgium (Dutch)
fr_BE Belgium (French)
en_CA Canada
fr_CA Canada (French)
zh_CN China
fr_FR France
de_DE Germany
zh_HK Hong Kong
en_IN India
en_IE Ireland
it_IT Italy
nl_NL Netherlands
en_SG Singapore
es_ES Spain
de_CH Switzerland
en_GB United Kingdom
en_US United States

See Tags for the Identification of Languages.

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., 859). The version you specify for a call has these basic effects:
  • It indicates the version of the code lists and other data that eBay should use to process your request.
  • It indicates the schema version you are using.
You need to use a version that is greater than or equal to the lowest supported version.
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:
    Routing the Request (Gateway URLs)
    eBay Schema Versioning Strategy
    Lowest Supported Version

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
(in) The WarningLevel value is set to 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
(in) The WarningLevel value is set to 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.



Output

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:

CustomCode
(out) Reserved for internal or future use.
Failure
(out) This value indicates that the call request processing failed.
Success
(out) This value indicates that the call request was processed successfully without any issues.
Warning
(out) This value indicates that the call request was successful, but processing was not without any issues. These issues can be checked in the Errors container, that will also be returned when one or more known issues occur with the call request.

(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:

CustomCode
 
Failure
(out)
InProgress
(out)
Success
(out)

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:

CustomCode
(out) Reserved for internal or future use.
RequestError
(out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data.
SystemError
(out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.

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:

CustomCode
(out) Reserved for internal or future use.
Error
(out) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data.

If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
  • If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to eBay.
  • If the source of the problem is on eBay's side, An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.


See the Compatible Application Check section of the eBay Features Guide for more information.
Warning
(out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.

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.



Detail Controls


DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.



Samples

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.

Available sample:

Sample: Basic Call

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>2016-01-24T04:12:59.904Z</Timestamp>
  <Ack>Success</Ack>
  <Version>967</Version>
  <Build>e967_core_Bundled_2333383_R1</Build>
</ReviseCheckoutStatusResponse>


Back to list of samples



Change History

Change Date Description
945
2015-10-15
  • BuyerPaymentMethodCodeType (modified): Sellers can no longer specify Moneybookers, ProPay, or Paymate as values in a PaymentMethods field when adding, revising, or relisting an item. One of these values can only be used in the PaymentMethodUsed field if the order payment using one of these payment methods went through during checkout. Currently, sellers are not be forced to update existing listings that already feature these payment methods.
899
2014-11-04
  • BuyerPaymentMethodCodeType (modified): 'QIWI' added as enumeration value. This payment method can only be specified on the US site and is only applicable to Russian buyers.
849
2013-11-05
  • PaymentMethodUsed (modified): 'CreditCard' and 'DirectDebit' added as acceptable buyer payment methods. These two values should only be used to revise an active eBay Now order.
  • ShippingService (modified): 'eBayNowImmediateDelivery' added as an acceptable value in the ShippingService field. This value should only be used to revise an active eBay Now order.
791
2012-09-12
  • ShippingService (modified): New International shipping services added for UK and DE sites as part of the EU delivery estimate project. For UK, these new enumeration values are UK_ParcelForceIntlExpress, UK_ParcelForceIntlValue, and UK_ParcelForceIntlEconomy. For DE, these new enumeration values are DE_DeutschePostBriefIntlEcon and DE_DeutschePostBriefIntlPriority.
719
2011-04-27
  • ShippingServiceCodeType (modified): 15 new shipping services added for the Australia and Canada sites. The nine new Australia carrier-specific shipping services include AU_AusPostRegisteredPostInternationalPaddedBag1kg, AU_AusPostRegisteredPostInternationalPaddedBag500g, AU_AusPostRegisteredPostInternationalParcel, AU_AustralianAirExpressFlatRate1kg, AU_AustralianAirExpressFlatRate3kg, AU_AustralianAirExpressFlatRate5kg, AU_AustralianAirExpressMetro15kg, AU_eBayAusPost3kgFlatRateSatchel, and AU_eBayAusPost500gFlatRateSatchel. The nine new Australia generic service level shipping services include AU_EconomyDeliveryFromOutsideAU, AU_ExpeditedDeliveryFromOutsideAU, AU_ExpressDelivery, AU_Freight, and AU_StandardDelivery. The new Canada shipping service is CA_Freight.
705
2011-01-19
  • OrderLineItemID (added): The OrderLineItemID value can be used to identify a single line item order (instead of ItemID/TransactionID pair). The OrderLineItemID value can also be passed into the OrderID field (for single line item orders only).
653
2010-01-20
  • PaymentStatus (doc change): Removed references to using PaymentStatus as a filter, and clarified the usage of this field.
555
2008-03-05
  • CODCost (added): Applicable beginning in April. Applies to the Italy site (site ID 101). Enables you to specify the cost of cash-on-delivery shipping.
537
2007-10-31
  • BuyerPaymentMethodCodeType.PaisaPayEscrow, BuyerPaymentMethodCodeType.PaisaPayEscrowEMI (added): Now supports a new payment method PaisaPayEscrow and PaisaPayEscrowEMI for India site.
477
2006-09-06
  • BuyerPaymentMethodCodeType.ELV (added): Now supports a new payment method, enabling Express Germany to introduce bank payments through Elektronisches Lastschriftverfahren (direct debit). With ELV, a purchase amount is automatically deducted from a buyer's bank account, after the buyer has provided his or her bank details and agreed to the deduction.
409
2005-05-18
  • InvocationID (added): Call now supports this input parameter.