|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ebay.sdk.ApiCall
com.ebay.sdk.call.ReviseCheckoutStatusCall
public class ReviseCheckoutStatusCall
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.
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. 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.
OrderId
- A unique identifier that identifies a single line item or multiple line
item (Combined Invoice) order.
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.
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.
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
.
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. InternationalPriorityShipping
as a value for this field will produce an error.
ShippingIncludedInTax
- An indicator of whether shipping costs were included in the
taxable amount.
CheckoutMethod
- This field is deprecated.
InsuranceType
- This field is no longer applicable as it is not longer possible for a seller to offer a buyer shipping insurance.
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).
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.
ShippingAddress
- For internal use only. Do not use.
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.
ShippingInsuranceCost
- This field is no longer applicable as it is not longer possible for a seller to offer a buyer shipping insurance.
SalesTax
- The sales tax amount for the order. This field should be used if sales tax
was applied to the order.
ShippingCost
- Amount of money paid for shipping.
EncryptedID
- Not supported.
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.
MultipleSellerPaymentID
- Not supported.
CODCost
- This dollar value indicates the money due from the buyer upon delivery of the item.
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.
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ReviseCheckoutStatusCall()
public ReviseCheckoutStatusCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public ReviseCheckoutStatusResponseType reviseCheckoutStatus() throws ApiException, SdkException, java.lang.Exception
ApiException
SdkException
java.lang.Exception
public AmountType getAdjustmentAmount()
public void setAdjustmentAmount(AmountType adjustmentAmount)
adjustmentAmount
- AmountTypepublic AmountType getAmountPaid()
public void setAmountPaid(AmountType amountPaid)
amountPaid
- AmountTypepublic java.lang.String getBuyerID()
public void setBuyerID(java.lang.String buyerID)
buyerID
- Stringpublic AmountType getCODCost()
public void setCODCost(AmountType cODCost)
cODCost
- AmountTypepublic CheckoutMethodCodeType getCheckoutMethod()
public void setCheckoutMethod(CheckoutMethodCodeType checkoutMethod)
checkoutMethod
- CheckoutMethodCodeTypepublic CompleteStatusCodeType getCheckoutStatus()
public void setCheckoutStatus(CompleteStatusCodeType checkoutStatus)
checkoutStatus
- CompleteStatusCodeTypepublic java.lang.String getEncryptedID()
public void setEncryptedID(java.lang.String encryptedID)
encryptedID
- Stringpublic ExternalTransactionType getExternalTransaction()
public void setExternalTransaction(ExternalTransactionType externalTransaction)
externalTransaction
- ExternalTransactionTypepublic InsuranceSelectedCodeType getInsuranceType()
public void setInsuranceType(InsuranceSelectedCodeType insuranceType)
insuranceType
- InsuranceSelectedCodeTypepublic java.lang.String getItemID()
public void setItemID(java.lang.String itemID)
itemID
- Stringpublic java.lang.String getMultipleSellerPaymentID()
public void setMultipleSellerPaymentID(java.lang.String multipleSellerPaymentID)
multipleSellerPaymentID
- Stringpublic java.lang.String getOrderId()
public void setOrderId(java.lang.String orderId)
orderId
- Stringpublic java.lang.String getOrderLineItemID()
public void setOrderLineItemID(java.lang.String orderLineItemID)
orderLineItemID
- Stringpublic BuyerPaymentMethodCodeType getPaymentMethodUsed()
public void setPaymentMethodUsed(BuyerPaymentMethodCodeType paymentMethodUsed)
paymentMethodUsed
- BuyerPaymentMethodCodeTypepublic RCSPaymentStatusCodeType getPaymentStatus()
public void setPaymentStatus(RCSPaymentStatusCodeType paymentStatus)
paymentStatus
- RCSPaymentStatusCodeTypepublic AmountType getSalesTax()
public void setSalesTax(AmountType salesTax)
salesTax
- AmountTypepublic AddressType getShippingAddress()
public void setShippingAddress(AddressType shippingAddress)
shippingAddress
- AddressTypepublic AmountType getShippingCost()
public void setShippingCost(AmountType shippingCost)
shippingCost
- AmountTypepublic java.lang.Boolean getShippingIncludedInTax()
public void setShippingIncludedInTax(java.lang.Boolean shippingIncludedInTax)
shippingIncludedInTax
- Booleanpublic AmountType getShippingInsuranceCost()
public void setShippingInsuranceCost(AmountType shippingInsuranceCost)
shippingInsuranceCost
- AmountTypepublic java.lang.String getShippingService()
public void setShippingService(java.lang.String shippingService)
shippingService
- Stringpublic java.lang.String getTransactionID()
public void setTransactionID(java.lang.String transactionID)
transactionID
- Stringpublic void setShippingService(ShippingServiceCodeType shippingService)
shippingService
- ShippingServiceCodeType
|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.