Changes since
the last release

com.ebay.sdk.call
Class ReviseCheckoutStatusCall

java.lang.Object
  extended by com.ebay.sdk.ApiCall
      extended by com.ebay.sdk.call.ReviseCheckoutStatusCall

public class ReviseCheckoutStatusCall
extends ApiCall

Wrapper class of the ReviseCheckoutStatus call of eBay SOAP API.

Title: SOAP API wrapper library.

Description: Contains wrapper classes for eBay SOAP APIs.

Copyright: Copyright (c) 2009

Company: eBay Inc.


Input property: ItemID - 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.

Input property: TransactionID - 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.

Input property: OrderId - 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.

Input property: AmountPaid - 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.
Input property: PaymentMethodUsed - 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.
Input property: CheckoutStatus - 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.
Input property: ShippingService - 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.
Input property: ShippingIncludedInTax - 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).
Input property: CheckoutMethod - This field is deprecated.
Input property: InsuranceType - This field is no longer applicable as it is not longer possible for a seller to offer a buyer shipping insurance.
Input property: PaymentStatus - 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.
Input property: AdjustmentAmount - 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.
Input property: ShippingAddress - For internal use only. Do not use.
Input property: BuyerID - 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.
Input property: ShippingInsuranceCost - This field is no longer applicable as it is not longer possible for a seller to offer a buyer shipping insurance.
Input property: SalesTax - 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.
Input property: ShippingCost - This field is used to show the cost of shipping being applied to the order.
Input property: EncryptedID - Not supported.
Input property: ExternalTransaction - 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.
Input property: MultipleSellerPaymentID - Not supported.
Input property: CODCost - 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.
Input property: OrderLineItemID - 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.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
ReviseCheckoutStatusCall()
          Constructor.
ReviseCheckoutStatusCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 AmountType getAdjustmentAmount()
          Gets the ReviseCheckoutStatusRequestType.adjustmentAmount.
 AmountType getAmountPaid()
          Gets the ReviseCheckoutStatusRequestType.amountPaid.
 java.lang.String getBuyerID()
          Gets the ReviseCheckoutStatusRequestType.buyerID.
 CheckoutMethodCodeType getCheckoutMethod()
          Gets the ReviseCheckoutStatusRequestType.checkoutMethod.
 CompleteStatusCodeType getCheckoutStatus()
          Gets the ReviseCheckoutStatusRequestType.checkoutStatus.
 AmountType getCODCost()
          Gets the ReviseCheckoutStatusRequestType.cODCost.
 java.lang.String getEncryptedID()
          Gets the ReviseCheckoutStatusRequestType.encryptedID.
 ExternalTransactionType getExternalTransaction()
          Gets the ReviseCheckoutStatusRequestType.externalTransaction.
 InsuranceSelectedCodeType getInsuranceType()
          Gets the ReviseCheckoutStatusRequestType.insuranceType.
 java.lang.String getItemID()
          Gets the ReviseCheckoutStatusRequestType.itemID.
 java.lang.String getMultipleSellerPaymentID()
          Gets the ReviseCheckoutStatusRequestType.multipleSellerPaymentID.
 java.lang.String getOrderId()
          Gets the ReviseCheckoutStatusRequestType.orderId.
 java.lang.String getOrderLineItemID()
          Gets the ReviseCheckoutStatusRequestType.orderLineItemID.
 BuyerPaymentMethodCodeType getPaymentMethodUsed()
          Gets the ReviseCheckoutStatusRequestType.paymentMethodUsed.
 RCSPaymentStatusCodeType getPaymentStatus()
          Gets the ReviseCheckoutStatusRequestType.paymentStatus.
 AmountType getSalesTax()
          Gets the ReviseCheckoutStatusRequestType.salesTax.
 AddressType getShippingAddress()
          Gets the ReviseCheckoutStatusRequestType.shippingAddress.
 AmountType getShippingCost()
          Gets the ReviseCheckoutStatusRequestType.shippingCost.
 java.lang.Boolean getShippingIncludedInTax()
          Gets the ReviseCheckoutStatusRequestType.shippingIncludedInTax.
 AmountType getShippingInsuranceCost()
          Gets the ReviseCheckoutStatusRequestType.shippingInsuranceCost.
 java.lang.String getShippingService()
          Gets the ReviseCheckoutStatusRequestType.shippingService.
 java.lang.String getTransactionID()
          Gets the ReviseCheckoutStatusRequestType.transactionID.
 ReviseCheckoutStatusResponseType reviseCheckoutStatus()
          Enables a seller to update the payment details, the shipping details, and the status of an order.
 void setAdjustmentAmount(AmountType adjustmentAmount)
          Sets the ReviseCheckoutStatusRequestType.adjustmentAmount.
 void setAmountPaid(AmountType amountPaid)
          Sets the ReviseCheckoutStatusRequestType.amountPaid.
 void setBuyerID(java.lang.String buyerID)
          Sets the ReviseCheckoutStatusRequestType.buyerID.
 void setCheckoutMethod(CheckoutMethodCodeType checkoutMethod)
          Sets the ReviseCheckoutStatusRequestType.checkoutMethod.
 void setCheckoutStatus(CompleteStatusCodeType checkoutStatus)
          Sets the ReviseCheckoutStatusRequestType.checkoutStatus.
 void setCODCost(AmountType cODCost)
          Sets the ReviseCheckoutStatusRequestType.cODCost.
 void setEncryptedID(java.lang.String encryptedID)
          Sets the ReviseCheckoutStatusRequestType.encryptedID.
 void setExternalTransaction(ExternalTransactionType externalTransaction)
          Sets the ReviseCheckoutStatusRequestType.externalTransaction.
 void setInsuranceType(InsuranceSelectedCodeType insuranceType)
          Sets the ReviseCheckoutStatusRequestType.insuranceType.
 void setItemID(java.lang.String itemID)
          Sets the ReviseCheckoutStatusRequestType.itemID.
 void setMultipleSellerPaymentID(java.lang.String multipleSellerPaymentID)
          Sets the ReviseCheckoutStatusRequestType.multipleSellerPaymentID.
 void setOrderId(java.lang.String orderId)
          Sets the ReviseCheckoutStatusRequestType.orderId.
 void setOrderLineItemID(java.lang.String orderLineItemID)
          Sets the ReviseCheckoutStatusRequestType.orderLineItemID.
 void setPaymentMethodUsed(BuyerPaymentMethodCodeType paymentMethodUsed)
          Sets the ReviseCheckoutStatusRequestType.paymentMethodUsed.
 void setPaymentStatus(RCSPaymentStatusCodeType paymentStatus)
          Sets the ReviseCheckoutStatusRequestType.paymentStatus.
 void setSalesTax(AmountType salesTax)
          Sets the ReviseCheckoutStatusRequestType.salesTax.
 void setShippingAddress(AddressType shippingAddress)
          Sets the ReviseCheckoutStatusRequestType.shippingAddress.
 void setShippingCost(AmountType shippingCost)
          Sets the ReviseCheckoutStatusRequestType.shippingCost.
 void setShippingIncludedInTax(java.lang.Boolean shippingIncludedInTax)
          Sets the ReviseCheckoutStatusRequestType.shippingIncludedInTax.
 void setShippingInsuranceCost(AmountType shippingInsuranceCost)
          Sets the ReviseCheckoutStatusRequestType.shippingInsuranceCost.
 void setShippingService(ShippingServiceCodeType shippingService)
          Backward compatible function - sets shipping service using a shipping service code type value.
 void setShippingService(java.lang.String shippingService)
          Sets the ReviseCheckoutStatusRequestType.shippingService.
 void setTransactionID(java.lang.String transactionID)
          Sets the ReviseCheckoutStatusRequestType.transactionID.
 
Methods inherited from class com.ebay.sdk.ApiCall
addDetailLevel, addSendRequestListener, execute, executeByApiName, getApiContext, getApiException, getBotBlock, getCallRetry, getDetailLevel, getEnableCompression, getEndUserIP, getErrorHandling, getInvocationID, getMessageID, getOutputSelector, getRequestXml, getResponseObject, getResponseXml, getSite, getWarningLevel, hasError, hasWarning, isEnableoAuthTokenHTTPHeader, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEnableoAuthTokenHTTPHeader, setEndUserIP, setErrorHandling, setInvocationID, setMessageID, setOutputSelector, setSite, setWarningLevel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReviseCheckoutStatusCall

public ReviseCheckoutStatusCall()
Constructor.


ReviseCheckoutStatusCall

public ReviseCheckoutStatusCall(ApiContext apiContext)
Constructor.

Parameters:
apiContext - The ApiContext object to be used to make the call.
Method Detail

reviseCheckoutStatus

public ReviseCheckoutStatusResponseType reviseCheckoutStatus()
                                                      throws ApiException,
                                                             SdkException,
                                                             java.lang.Exception
Enables a seller to update the payment details, the shipping details, and the status of an order.

Returns:
The ReviseCheckoutStatusResponseType object.
Throws:
ApiException
SdkException
java.lang.Exception

getAdjustmentAmount

public AmountType getAdjustmentAmount()
Gets the ReviseCheckoutStatusRequestType.adjustmentAmount.

Returns:
AmountType

setAdjustmentAmount

public void setAdjustmentAmount(AmountType adjustmentAmount)
Sets the ReviseCheckoutStatusRequestType.adjustmentAmount.

Parameters:
adjustmentAmount - AmountType

getAmountPaid

public AmountType getAmountPaid()
Gets the ReviseCheckoutStatusRequestType.amountPaid.

Returns:
AmountType

setAmountPaid

public void setAmountPaid(AmountType amountPaid)
Sets the ReviseCheckoutStatusRequestType.amountPaid.

Parameters:
amountPaid - AmountType

getBuyerID

public java.lang.String getBuyerID()
Gets the ReviseCheckoutStatusRequestType.buyerID.

Returns:
String

setBuyerID

public void setBuyerID(java.lang.String buyerID)
Sets the ReviseCheckoutStatusRequestType.buyerID.

Parameters:
buyerID - String

getCODCost

public AmountType getCODCost()
Gets the ReviseCheckoutStatusRequestType.cODCost.

Returns:
AmountType

setCODCost

public void setCODCost(AmountType cODCost)
Sets the ReviseCheckoutStatusRequestType.cODCost.

Parameters:
cODCost - AmountType

getCheckoutMethod

public CheckoutMethodCodeType getCheckoutMethod()
Gets the ReviseCheckoutStatusRequestType.checkoutMethod.

Returns:
CheckoutMethodCodeType

setCheckoutMethod

public void setCheckoutMethod(CheckoutMethodCodeType checkoutMethod)
Sets the ReviseCheckoutStatusRequestType.checkoutMethod.

Parameters:
checkoutMethod - CheckoutMethodCodeType

getCheckoutStatus

public CompleteStatusCodeType getCheckoutStatus()
Gets the ReviseCheckoutStatusRequestType.checkoutStatus.

Returns:
CompleteStatusCodeType

setCheckoutStatus

public void setCheckoutStatus(CompleteStatusCodeType checkoutStatus)
Sets the ReviseCheckoutStatusRequestType.checkoutStatus.

Parameters:
checkoutStatus - CompleteStatusCodeType

getEncryptedID

public java.lang.String getEncryptedID()
Gets the ReviseCheckoutStatusRequestType.encryptedID.

Returns:
String

setEncryptedID

public void setEncryptedID(java.lang.String encryptedID)
Sets the ReviseCheckoutStatusRequestType.encryptedID.

Parameters:
encryptedID - String

getExternalTransaction

public ExternalTransactionType getExternalTransaction()
Gets the ReviseCheckoutStatusRequestType.externalTransaction.

Returns:
ExternalTransactionType

setExternalTransaction

public void setExternalTransaction(ExternalTransactionType externalTransaction)
Sets the ReviseCheckoutStatusRequestType.externalTransaction.

Parameters:
externalTransaction - ExternalTransactionType

getInsuranceType

public InsuranceSelectedCodeType getInsuranceType()
Gets the ReviseCheckoutStatusRequestType.insuranceType.

Returns:
InsuranceSelectedCodeType

setInsuranceType

public void setInsuranceType(InsuranceSelectedCodeType insuranceType)
Sets the ReviseCheckoutStatusRequestType.insuranceType.

Parameters:
insuranceType - InsuranceSelectedCodeType

getItemID

public java.lang.String getItemID()
Gets the ReviseCheckoutStatusRequestType.itemID.

Returns:
String

setItemID

public void setItemID(java.lang.String itemID)
Sets the ReviseCheckoutStatusRequestType.itemID.

Parameters:
itemID - String

getMultipleSellerPaymentID

public java.lang.String getMultipleSellerPaymentID()
Gets the ReviseCheckoutStatusRequestType.multipleSellerPaymentID.

Returns:
String

setMultipleSellerPaymentID

public void setMultipleSellerPaymentID(java.lang.String multipleSellerPaymentID)
Sets the ReviseCheckoutStatusRequestType.multipleSellerPaymentID.

Parameters:
multipleSellerPaymentID - String

getOrderId

public java.lang.String getOrderId()
Gets the ReviseCheckoutStatusRequestType.orderId.

Returns:
String

setOrderId

public void setOrderId(java.lang.String orderId)
Sets the ReviseCheckoutStatusRequestType.orderId.

Parameters:
orderId - String

getOrderLineItemID

public java.lang.String getOrderLineItemID()
Gets the ReviseCheckoutStatusRequestType.orderLineItemID.

Returns:
String

setOrderLineItemID

public void setOrderLineItemID(java.lang.String orderLineItemID)
Sets the ReviseCheckoutStatusRequestType.orderLineItemID.

Parameters:
orderLineItemID - String

getPaymentMethodUsed

public BuyerPaymentMethodCodeType getPaymentMethodUsed()
Gets the ReviseCheckoutStatusRequestType.paymentMethodUsed.

Returns:
BuyerPaymentMethodCodeType

setPaymentMethodUsed

public void setPaymentMethodUsed(BuyerPaymentMethodCodeType paymentMethodUsed)
Sets the ReviseCheckoutStatusRequestType.paymentMethodUsed.

Parameters:
paymentMethodUsed - BuyerPaymentMethodCodeType

getPaymentStatus

public RCSPaymentStatusCodeType getPaymentStatus()
Gets the ReviseCheckoutStatusRequestType.paymentStatus.

Returns:
RCSPaymentStatusCodeType

setPaymentStatus

public void setPaymentStatus(RCSPaymentStatusCodeType paymentStatus)
Sets the ReviseCheckoutStatusRequestType.paymentStatus.

Parameters:
paymentStatus - RCSPaymentStatusCodeType

getSalesTax

public AmountType getSalesTax()
Gets the ReviseCheckoutStatusRequestType.salesTax.

Returns:
AmountType

setSalesTax

public void setSalesTax(AmountType salesTax)
Sets the ReviseCheckoutStatusRequestType.salesTax.

Parameters:
salesTax - AmountType

getShippingAddress

public AddressType getShippingAddress()
Gets the ReviseCheckoutStatusRequestType.shippingAddress.

Returns:
AddressType

setShippingAddress

public void setShippingAddress(AddressType shippingAddress)
Sets the ReviseCheckoutStatusRequestType.shippingAddress.

Parameters:
shippingAddress - AddressType

getShippingCost

public AmountType getShippingCost()
Gets the ReviseCheckoutStatusRequestType.shippingCost.

Returns:
AmountType

setShippingCost

public void setShippingCost(AmountType shippingCost)
Sets the ReviseCheckoutStatusRequestType.shippingCost.

Parameters:
shippingCost - AmountType

getShippingIncludedInTax

public java.lang.Boolean getShippingIncludedInTax()
Gets the ReviseCheckoutStatusRequestType.shippingIncludedInTax.

Returns:
Boolean

setShippingIncludedInTax

public void setShippingIncludedInTax(java.lang.Boolean shippingIncludedInTax)
Sets the ReviseCheckoutStatusRequestType.shippingIncludedInTax.

Parameters:
shippingIncludedInTax - Boolean

getShippingInsuranceCost

public AmountType getShippingInsuranceCost()
Gets the ReviseCheckoutStatusRequestType.shippingInsuranceCost.

Returns:
AmountType

setShippingInsuranceCost

public void setShippingInsuranceCost(AmountType shippingInsuranceCost)
Sets the ReviseCheckoutStatusRequestType.shippingInsuranceCost.

Parameters:
shippingInsuranceCost - AmountType

getShippingService

public java.lang.String getShippingService()
Gets the ReviseCheckoutStatusRequestType.shippingService.

Returns:
String

setShippingService

public void setShippingService(java.lang.String shippingService)
Sets the ReviseCheckoutStatusRequestType.shippingService.

Parameters:
shippingService - String

getTransactionID

public java.lang.String getTransactionID()
Gets the ReviseCheckoutStatusRequestType.transactionID.

Returns:
String

setTransactionID

public void setTransactionID(java.lang.String transactionID)
Sets the ReviseCheckoutStatusRequestType.transactionID.

Parameters:
transactionID - String

setShippingService

public void setShippingService(ShippingServiceCodeType shippingService)
Backward compatible function - sets shipping service using a shipping service code type value.

Parameters:
shippingService - ShippingServiceCodeType

Changes since
the last release

The information contained in this document is proprietary and confidential. Use of this information and the eBay API requires a Non-Disclosure Agreement (NDA) between the user and eBay Inc. For information regarding a qualifying NDA, contact Developer Relations: developer-relations@ebay.com
© 2004-2009 eBay Inc. All rights reserved.