|
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.SendInvoiceCall
public class SendInvoiceCall
Wrapper class of the SendInvoice 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 item listing. Unless OrderID or
OrderLineItemID is provided in the request, the ItemID (or SKU) is
required and must be paired with the corresponding TransactionID to
identify a single line item order. For a multiple line item (Combined Invoice) order, OrderID should be used.
TransactionID
- Unique identifier for an eBay order line item (transaction). 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. Unless OrderID or OrderLineItemID is provided in the request, the TransactionID is required and must be paired with the corresponding ItemID to identify a single line item order. For a multiple line item (Combined Invoice) order, OrderID should be used.
OrderID
- A unique identifier that identifies a single line item or multiple line
item (Combined Invoice) orders.
InternationalShippingServiceOptions
- If the buyer has an International shipping address, use this container
to offer up to four International shipping services (or five if one of them is a Global Shipping Program service). If International
shipping services are offered, (domestic) ShippingServiceOptions should
not be included in the request.
ShippingServiceOptions
- If the buyer has a domestic shipping address, use this container
to offer up to four domestic shipping services. If domestic
shipping services are offered, InternationalShippingServiceOptions should
not be included in the request.
SalesTax
- Container consisting of sales tax details. The amount of sales tax to
add to the price of an order is dependent on the sales tax rate in the
buyer's state and whether sales tax is being applied to the cost of the
order only or the cost of the order plus shipping.
InsuranceOption
- Specifies whether an insurance fee is required. An InsuranceOption value of IncludedInShippingHandling cannot be used if the item will use calculated shipping. Some shipping carriers automatically include shipping insurance for qualifying items.InsuranceFee
- Insurance cost, as set by seller, if ShippingType = 1.
Specify if InsuranceOption is optional or required. Must be greater than zero value if a value of Optional or Required is passed in InsuranceOption. Value specified should be the total cost of insuring the item.PaymentMethods
- This optional field allows a US or German seller to add specific payment methods that were not in the original item listing. The only valid values for this field are 'PayPal' for a US listing, or 'MoneyXferAcceptedInCheckout' (CIP+) for a DE listing.
PayPalEmailAddress
- If the PaymentMethods field is used and set to PayPal, the seller provides his/her PayPal email address in this field.
CheckoutInstructions
- This field allows the seller to provide a message or instructions
regarding checkout/payment or the return policy.
EmailCopyToSeller
- Flag indicating whether or not the seller wishes to receive an email copy of
the invoice sent to the buyer.
CODCost
- This dollar value indicates the money due from the buyer upon delivery of the item.
SKU
- The seller's unique identifier for an item that is being tracked by this
SKU. If OrderID or OrderLineItemID are not provided, both SKU (or
ItemID) and corresponding TransactionID must be provided to uniquely
identify a single line item order. For a multiple line item (Combined
Payment) order, OrderID must be used.
OrderLineItemID
- A unique identifier for an eBay order line item. This field is created
as soon as there is a commitment to buy from the seller, and its value
is based upon the concatenation of ItemID and TransactionID, with a
hyphen in between these two IDs.
AdjustmentAmount
- This field allows the seller to adjust the total cost of the order to account for an extra charge or to pass down a discount to the buyer.
Field Summary |
---|
Fields inherited from class com.ebay.sdk.ApiCall |
---|
apiException, sendReqListeners |
Constructor Summary | |
---|---|
SendInvoiceCall()
Constructor. |
|
SendInvoiceCall(ApiContext apiContext)
Constructor. |
Method Summary | |
---|---|
AmountType |
getAdjustmentAmount()
Gets the SendInvoiceRequestType.adjustmentAmount. |
String |
getCheckoutInstructions()
Gets the SendInvoiceRequestType.checkoutInstructions. |
AmountType |
getCODCost()
Gets the SendInvoiceRequestType.cODCost. |
Boolean |
getEmailCopyToSeller()
Gets the SendInvoiceRequestType.emailCopyToSeller. |
AmountType |
getInsuranceFee()
Gets the SendInvoiceRequestType.insuranceFee. |
InsuranceOptionCodeType |
getInsuranceOption()
Gets the SendInvoiceRequestType.insuranceOption. |
InternationalShippingServiceOptionsType[] |
getInternationalShippingServiceOptions()
Gets the SendInvoiceRequestType.internationalShippingServiceOptions. |
String |
getItemID()
Gets the SendInvoiceRequestType.itemID. |
String |
getOrderID()
Gets the SendInvoiceRequestType.orderID. |
String |
getOrderLineItemID()
Gets the SendInvoiceRequestType.orderLineItemID. |
BuyerPaymentMethodCodeType[] |
getPaymentMethods()
Gets the SendInvoiceRequestType.paymentMethods. |
String |
getPayPalEmailAddress()
Gets the SendInvoiceRequestType.payPalEmailAddress. |
SalesTaxType |
getSalesTax()
Gets the SendInvoiceRequestType.salesTax. |
SendInvoiceRequestType |
getSendInvoiceRequest()
Gets the SendInvoiceRequestType.sendInvoiceRequest. |
ShippingServiceOptionsType[] |
getShippingServiceOptions()
Gets the SendInvoiceRequestType.shippingServiceOptions. |
String |
getSKU()
Gets the SendInvoiceRequestType.sKU. |
String |
getTransactionID()
Gets the SendInvoiceRequestType.transactionID. |
void |
sendInvoice()
Enables a seller to send an order invoice to a buyer. |
void |
setAdjustmentAmount(AmountType adjustmentAmount)
Sets the SendInvoiceRequestType.adjustmentAmount. |
void |
setCheckoutInstructions(String checkoutInstructions)
Sets the SendInvoiceRequestType.checkoutInstructions. |
void |
setCODCost(AmountType cODCost)
Sets the SendInvoiceRequestType.cODCost. |
void |
setEmailCopyToSeller(Boolean emailCopyToSeller)
Sets the SendInvoiceRequestType.emailCopyToSeller. |
void |
setInsuranceFee(AmountType insuranceFee)
Sets the SendInvoiceRequestType.insuranceFee. |
void |
setInsuranceOption(InsuranceOptionCodeType insuranceOption)
Sets the SendInvoiceRequestType.insuranceOption. |
void |
setInternationalShippingServiceOptions(InternationalShippingServiceOptionsType[] internationalShippingServiceOptions)
Sets the SendInvoiceRequestType.internationalShippingServiceOptions. |
void |
setItemID(String itemID)
Sets the SendInvoiceRequestType.itemID. |
void |
setOrderID(String orderID)
Sets the SendInvoiceRequestType.orderID. |
void |
setOrderLineItemID(String orderLineItemID)
Sets the SendInvoiceRequestType.orderLineItemID. |
void |
setPaymentMethods(BuyerPaymentMethodCodeType[] paymentMethods)
Sets the SendInvoiceRequestType.paymentMethods. |
void |
setPayPalEmailAddress(String payPalEmailAddress)
Sets the SendInvoiceRequestType.payPalEmailAddress. |
void |
setSalesTax(SalesTaxType salesTax)
Sets the SendInvoiceRequestType.salesTax. |
void |
setSendInvoiceRequest(SendInvoiceRequestType sendInvoiceRequest)
Sets the SendInvoiceRequestType.sendInvoiceRequest. |
void |
setShippingServiceOptions(ShippingServiceOptionsType[] shippingServiceOptions)
Sets the SendInvoiceRequestType.shippingServiceOptions. |
void |
setSKU(String sKU)
Sets the SendInvoiceRequestType.sKU. |
void |
setTransactionID(String transactionID)
Sets the SendInvoiceRequestType.transactionID. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SendInvoiceCall()
public SendInvoiceCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public void sendInvoice() throws ApiException, SdkException, Exception
ApiException
SdkException
Exception
public SendInvoiceRequestType getSendInvoiceRequest()
public void setSendInvoiceRequest(SendInvoiceRequestType sendInvoiceRequest)
sendInvoiceRequest
- SendInvoiceRequestTypepublic AmountType getAdjustmentAmount()
public void setAdjustmentAmount(AmountType adjustmentAmount)
adjustmentAmount
- AmountTypepublic AmountType getCODCost()
public void setCODCost(AmountType cODCost)
cODCost
- AmountTypepublic String getCheckoutInstructions()
public void setCheckoutInstructions(String checkoutInstructions)
checkoutInstructions
- Stringpublic Boolean getEmailCopyToSeller()
public void setEmailCopyToSeller(Boolean emailCopyToSeller)
emailCopyToSeller
- Booleanpublic AmountType getInsuranceFee()
public void setInsuranceFee(AmountType insuranceFee)
insuranceFee
- AmountTypepublic InsuranceOptionCodeType getInsuranceOption()
public void setInsuranceOption(InsuranceOptionCodeType insuranceOption)
insuranceOption
- InsuranceOptionCodeTypepublic InternationalShippingServiceOptionsType[] getInternationalShippingServiceOptions()
public void setInternationalShippingServiceOptions(InternationalShippingServiceOptionsType[] internationalShippingServiceOptions)
internationalShippingServiceOptions
- InternationalShippingServiceOptionsType[]public String getItemID()
public void setItemID(String itemID)
itemID
- Stringpublic String getOrderID()
public void setOrderID(String orderID)
orderID
- Stringpublic String getOrderLineItemID()
public void setOrderLineItemID(String orderLineItemID)
orderLineItemID
- Stringpublic String getPayPalEmailAddress()
public void setPayPalEmailAddress(String payPalEmailAddress)
payPalEmailAddress
- Stringpublic BuyerPaymentMethodCodeType[] getPaymentMethods()
public void setPaymentMethods(BuyerPaymentMethodCodeType[] paymentMethods)
paymentMethods
- BuyerPaymentMethodCodeType[]public String getSKU()
public void setSKU(String sKU)
sKU
- Stringpublic SalesTaxType getSalesTax()
public void setSalesTax(SalesTaxType salesTax)
salesTax
- SalesTaxTypepublic ShippingServiceOptionsType[] getShippingServiceOptions()
public void setShippingServiceOptions(ShippingServiceOptionsType[] shippingServiceOptions)
shippingServiceOptions
- ShippingServiceOptionsType[]public String getTransactionID()
public void setTransactionID(String transactionID)
transactionID
- String
|
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.