eBay Trading API Call Reference Version 821 Support     Knowledge Base     Forums     All Tutorials     All Code Samples Users Guide Call Reference Making an API Call Tutorials Release Notes

Call Index Field Index Enumeration Index Type Index Deprecated Objects Errors by Number Input Output Detail Controls Samples Change History Top Errors for ReviseCheckoutStatus User Notes

ReviseCheckoutStatus

A seller can use this call to:

• update the payment status to complete for an order that was paid for with a trusted payment method other than PayPal. If PayPal was used as the payment method, PayPal updates the payment status to Paid automatically. See eBay's Accepted Payments Policy for more information on trusted payment methods. (Note: the orders of new sellers on the DE and AT sites who are subject to the new payment process may not updated using ReviseCheckoutStatus. A call error will result if there is an attempt to update these orders.)
• update the payment method used
• update the status of an order (Note: the orders of new sellers on the DE and AT sites who are subject to the new payment process may not updated using ReviseCheckoutStatus. A call error will result if there is an attempt to update these orders.)
• update the shipping address of an order
• specify a new final price
• revise the payment details if the payment from the buyer failed, and the payment method was something other than an eBay/PayPal payment

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
    Listing an Item

See also the reference documentation for this call:

• ReviseItem - Enables a seller to change the properties of a currently active listing. Also for Half.com.

Back to top

ReviseCheckoutStatus Input

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

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>
  <InsuranceType> InsuranceSelectedCodeType </InsuranceType>
  <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>
  <ShippingAddress> AddressType
  </ShippingAddress>
  <ShippingCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingCost>
  <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
  <ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
  <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>

Back to top

ReviseCheckoutStatus Output

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

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>

Back to top

ReviseCheckoutStatus Detail Controls

Detail Control: DetailLevel

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

Back to top

ReviseCheckoutStatus Samples

New to making API calls? Please see Routing the Request.

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

• Basic Call ↓ - Adjusts the amount of the item price after the sale.
• Third-Party Checkout ↓ - The following sample shows the checkout status of an item being revised by an application qualified for third-party checkout.

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 (HTTP POST). Also available is the .txt version of this XML.

<?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. Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<ReviseCheckoutStatusResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2006-01-24T04:12:59.904Z</Timestamp>
  <Ack>Success</Ack>
  <Version>445</Version>
  <Build>e445_core_Bundled_2333383_R1</Build>
</ReviseCheckoutStatusResponse>

Back to list of samples

The following sample shows the checkout status of an item being revised by an application qualified for third-party checkout.

Description

For the checkout status of the item to be successfully revised, the ThirdPartyCheckout status of the item must be set to true.

Input

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<ReviseCheckoutStatusRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <Version>505</Version>
  <AdjustmentAmount>4.00</AdjustmentAmount>
  <AmountPaid>18.00</AmountPaid>
  <ItemID>110025737313</ItemID>
  <CheckoutStatus>Complete</CheckoutStatus>
  <TransactionID>0</TransactionID>
  <PaymentMethodUsed>MOCC</PaymentMethodUsed>
  <ShippingService>UPSGround</ShippingService>
  <ShippingIncludedInTax>true</ShippingIncludedInTax>
  <AdjustmentAmount>-4.00</AdjustmentAmount>
  <ShippingAddress>
    <Name>Muggle Born</Name>
    <Street1>77 Hogwarts Lane</Street1>
    <Street2/>
    <CityName>San Jose</CityName>
    <StateOrProvince>California</StateOrProvince>
    <Country>US</Country>
    <PostalCode>94040</PostalCode>
  </ShippingAddress>
  <ShippingInsuranceCost>0.00</ShippingInsuranceCost>
  <ShippingCost>5.00</ShippingCost>
</ReviseCheckoutStatusRequest>

Output

XML format. Also available is the .txt version of this XML.

<?xml version="1.0" encoding="UTF-8" ?>
<ReviseCheckoutStatusResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2007-12-05T22:16:39.600Z</Timestamp>
  <Ack>Success</Ack>
  <Version>539</Version>
  <Build>e539_core_Bundled_5642307_R1</Build>
</ReviseCheckoutStatusResponse>

Back to list of samples

Back to top

ReviseCheckoutStatus Change History

Back to top

User-Contributed Notes

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.