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

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

Input property: OrderId - 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.
Input property: AmountPaid - 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.
Input property: PaymentMethodUsed - 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.
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 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.
Input property: ShippingIncludedInTax - An indicator of whether shipping costs were included in the taxable amount.
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 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.
Input property: AdjustmentAmount - 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.
Input property: ShippingAddress - For internal use only. Do not use.
Input property: BuyerID - 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.
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 - The sales tax amount for the order. This field should be used if sales tax was applied to the order.
Input property: ShippingCost - Amount of money paid for shipping.
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 - 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.

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.