Changes since
the last release

com.ebay.sdk.call
Class SendInvoiceCall

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

public class SendInvoiceCall
extends ApiCall

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.


Input property: ItemID - Unique identifier for an eBay 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 order, OrderID should be used.
Input property: TransactionID - Unique identifier for an eBay sales transaction. This identifier is created once there is a commitment from a buyer to purchase an item. Since an auction listing can only have one sales transaction during the duration of the listing, the TransactionID value 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 order, OrderID should be used.
Input property: OrderID - A unique identifier that identifies a single line item or multiple line item order.

Unless the ItemID (or SKU) and corresponding TransactionID, or the OrderLineItemID is provided in the request to identify a single line item order, the OrderID must be specified. If OrderID is specified, OrderLineItemID, ItemID, TransactionID, and SKU are ignored if present 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.

Note: For sellers integrated with the new order ID format, please note that the identifier for an order will change as it goes from unpaid to paid status. Sellers can check to see if an order has been paid by looking for a value of 'Complete' in the CheckoutStatus.Status field in the response of GetOrders or GetOrderTransactions call, or in the Status.CompleteStatus field in the response of GetItemTransactions or GetSellerTransactions call. When using a SendInvoice call, either of these order IDs (paid or unpaid status) can be used to update an order. Similarly, either of these order IDs (paid or unpaid status) can be used in GetOrders or GetOrderTransactions call to retrieve specific order(s).
Input property: 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.

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

Input property: SalesTax - This container is used if the seller wishes to apply sales tax to the order. The amount of sales tax applied to the 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 and handling.

Note: As of January 1, 2019, buyers in some US states will automatically be charged sales tax for eBay purchases. eBay will collect and remit this sales tax to the proper taxing authority on the buyer's behalf. So, if the order's buyer is in a state that is subject to 'eBay Collect and Remit Tax', the seller should not send the buyer any sales tax information, since eBay will be handling the sales tax instead without buyer's assistance. For a list of the US states that will become subject to 'eBay Collect and Remit' (and effective dates), see the eBay sales tax collection help topic.
Input property: InsuranceOption - This field is no longer applicable as it is no longer possible for a seller to offer a buyer shipping insurance.
Input property: InsuranceFee - This field is no longer applicable as it is no longer possible for a seller to offer a buyer shipping insurance.
Input property: PaymentMethods - This optional field allows a US or German seller to add specific payment methods that were not in the original listing. The only valid values for this field are 'PayPal' for a US listing (or 'CreditCard' for sellers opted in to eBay Managed Payments), or 'MoneyXferAcceptedInCheckout' (CIP+) for a listing on the Germany site.
Input property: PayPalEmailAddress - If the PaymentMethods field is used and set to PayPal, the seller provides his/her PayPal email address in this field.
Input property: CheckoutInstructions - This field allows the seller to provide a message or instructions regarding checkout/payment, or the return policy.
Input property: EmailCopyToSeller - This field is included and set to true if the seller wishes to receive an email copy of the invoice sent to the buyer.
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 SendInvoice request if 'COD' (cash-on-delivery) was the payment method selected by the buyer and it is included as the PaymentMethods value in the same request.
Input property: 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 order, OrderID must be used.

This field can only be used if the Item.InventoryTrackingMethod field (set with the AddFixedPriceItem or RelistFixedPriceItem calls) is set to SKU.
Input property: OrderLineItemID - A unique identifier for an eBay order line item. 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).

Unless the ItemID (or SKU) and corresponding TransactionID is used to identify a single line item order, or the OrderID is used to identify a single or multiple line item order, the OrderLineItemID must be specified. For a multiple line item order, OrderID should be used. If OrderLineItemID is specified, ItemID, TransactionID, and SKU are ignored if present in the same request.
Input property: 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.

The currency used in this field must be the same currency of the listing site. A positive value in this field indicates that the amount is an extra charge being paid to the seller by the buyer, and a negative value indicates that the amount is a discount given to the buyer by the seller.

Version:
1.0
Author:
Ron Murphy

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.
 java.lang.String getCheckoutInstructions()
          Gets the SendInvoiceRequestType.checkoutInstructions.
 AmountType getCODCost()
          Gets the SendInvoiceRequestType.cODCost.
 java.lang.Boolean getEmailCopyToSeller()
          Gets the SendInvoiceRequestType.emailCopyToSeller.
 AmountType getInsuranceFee()
          Gets the SendInvoiceRequestType.insuranceFee.
 InsuranceOptionCodeType getInsuranceOption()
          Gets the SendInvoiceRequestType.insuranceOption.
 InternationalShippingServiceOptionsType[] getInternationalShippingServiceOptions()
          Gets the SendInvoiceRequestType.internationalShippingServiceOptions.
 java.lang.String getItemID()
          Gets the SendInvoiceRequestType.itemID.
 java.lang.String getOrderID()
          Gets the SendInvoiceRequestType.orderID.
 java.lang.String getOrderLineItemID()
          Gets the SendInvoiceRequestType.orderLineItemID.
 BuyerPaymentMethodCodeType[] getPaymentMethods()
          Gets the SendInvoiceRequestType.paymentMethods.
 java.lang.String getPayPalEmailAddress()
          Gets the SendInvoiceRequestType.payPalEmailAddress.
 SalesTaxType getSalesTax()
          Gets the SendInvoiceRequestType.salesTax.
 SendInvoiceRequestType getSendInvoiceRequest()
          Gets the SendInvoiceRequestType.sendInvoiceRequest.
 ShippingServiceOptionsType[] getShippingServiceOptions()
          Gets the SendInvoiceRequestType.shippingServiceOptions.
 java.lang.String getSKU()
          Gets the SendInvoiceRequestType.sKU.
 java.lang.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(java.lang.String checkoutInstructions)
          Sets the SendInvoiceRequestType.checkoutInstructions.
 void setCODCost(AmountType cODCost)
          Sets the SendInvoiceRequestType.cODCost.
 void setEmailCopyToSeller(java.lang.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(java.lang.String itemID)
          Sets the SendInvoiceRequestType.itemID.
 void setOrderID(java.lang.String orderID)
          Sets the SendInvoiceRequestType.orderID.
 void setOrderLineItemID(java.lang.String orderLineItemID)
          Sets the SendInvoiceRequestType.orderLineItemID.
 void setPaymentMethods(BuyerPaymentMethodCodeType[] paymentMethods)
          Sets the SendInvoiceRequestType.paymentMethods.
 void setPayPalEmailAddress(java.lang.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(java.lang.String sKU)
          Sets the SendInvoiceRequestType.sKU.
 void setTransactionID(java.lang.String transactionID)
          Sets the SendInvoiceRequestType.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

SendInvoiceCall

public SendInvoiceCall()
Constructor.


SendInvoiceCall

public SendInvoiceCall(ApiContext apiContext)
Constructor.

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

sendInvoice

public void sendInvoice()
                 throws ApiException,
                        SdkException,
                        java.lang.Exception
Enables a seller to send an order invoice to a buyer. Where applicable, updates to shipping, payment methods, and sales tax made in this request are applied to the specified order as a whole and to the individual order line items whose data are stored in individual Transaction objects.

Throws:
ApiException
SdkException
java.lang.Exception

getSendInvoiceRequest

public SendInvoiceRequestType getSendInvoiceRequest()
Gets the SendInvoiceRequestType.sendInvoiceRequest.

Returns:
SendInvoiceRequestType

setSendInvoiceRequest

public void setSendInvoiceRequest(SendInvoiceRequestType sendInvoiceRequest)
Sets the SendInvoiceRequestType.sendInvoiceRequest.

Parameters:
sendInvoiceRequest - SendInvoiceRequestType

getAdjustmentAmount

public AmountType getAdjustmentAmount()
Gets the SendInvoiceRequestType.adjustmentAmount.

Returns:
AmountType

setAdjustmentAmount

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

Parameters:
adjustmentAmount - AmountType

getCODCost

public AmountType getCODCost()
Gets the SendInvoiceRequestType.cODCost.

Returns:
AmountType

setCODCost

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

Parameters:
cODCost - AmountType

getCheckoutInstructions

public java.lang.String getCheckoutInstructions()
Gets the SendInvoiceRequestType.checkoutInstructions.

Returns:
String

setCheckoutInstructions

public void setCheckoutInstructions(java.lang.String checkoutInstructions)
Sets the SendInvoiceRequestType.checkoutInstructions.

Parameters:
checkoutInstructions - String

getEmailCopyToSeller

public java.lang.Boolean getEmailCopyToSeller()
Gets the SendInvoiceRequestType.emailCopyToSeller.

Returns:
Boolean

setEmailCopyToSeller

public void setEmailCopyToSeller(java.lang.Boolean emailCopyToSeller)
Sets the SendInvoiceRequestType.emailCopyToSeller.

Parameters:
emailCopyToSeller - Boolean

getInsuranceFee

public AmountType getInsuranceFee()
Gets the SendInvoiceRequestType.insuranceFee.

Returns:
AmountType

setInsuranceFee

public void setInsuranceFee(AmountType insuranceFee)
Sets the SendInvoiceRequestType.insuranceFee.

Parameters:
insuranceFee - AmountType

getInsuranceOption

public InsuranceOptionCodeType getInsuranceOption()
Gets the SendInvoiceRequestType.insuranceOption.

Returns:
InsuranceOptionCodeType

setInsuranceOption

public void setInsuranceOption(InsuranceOptionCodeType insuranceOption)
Sets the SendInvoiceRequestType.insuranceOption.

Parameters:
insuranceOption - InsuranceOptionCodeType

getInternationalShippingServiceOptions

public InternationalShippingServiceOptionsType[] getInternationalShippingServiceOptions()
Gets the SendInvoiceRequestType.internationalShippingServiceOptions.

Returns:
InternationalShippingServiceOptionsType[]

setInternationalShippingServiceOptions

public void setInternationalShippingServiceOptions(InternationalShippingServiceOptionsType[] internationalShippingServiceOptions)
Sets the SendInvoiceRequestType.internationalShippingServiceOptions.

Parameters:
internationalShippingServiceOptions - InternationalShippingServiceOptionsType[]

getItemID

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

Returns:
String

setItemID

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

Parameters:
itemID - String

getOrderID

public java.lang.String getOrderID()
Gets the SendInvoiceRequestType.orderID.

Returns:
String

setOrderID

public void setOrderID(java.lang.String orderID)
Sets the SendInvoiceRequestType.orderID.

Parameters:
orderID - String

getOrderLineItemID

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

Returns:
String

setOrderLineItemID

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

Parameters:
orderLineItemID - String

getPayPalEmailAddress

public java.lang.String getPayPalEmailAddress()
Gets the SendInvoiceRequestType.payPalEmailAddress.

Returns:
String

setPayPalEmailAddress

public void setPayPalEmailAddress(java.lang.String payPalEmailAddress)
Sets the SendInvoiceRequestType.payPalEmailAddress.

Parameters:
payPalEmailAddress - String

getPaymentMethods

public BuyerPaymentMethodCodeType[] getPaymentMethods()
Gets the SendInvoiceRequestType.paymentMethods.

Returns:
BuyerPaymentMethodCodeType[]

setPaymentMethods

public void setPaymentMethods(BuyerPaymentMethodCodeType[] paymentMethods)
Sets the SendInvoiceRequestType.paymentMethods.

Parameters:
paymentMethods - BuyerPaymentMethodCodeType[]

getSKU

public java.lang.String getSKU()
Gets the SendInvoiceRequestType.sKU.

Returns:
String

setSKU

public void setSKU(java.lang.String sKU)
Sets the SendInvoiceRequestType.sKU.

Parameters:
sKU - String

getSalesTax

public SalesTaxType getSalesTax()
Gets the SendInvoiceRequestType.salesTax.

Returns:
SalesTaxType

setSalesTax

public void setSalesTax(SalesTaxType salesTax)
Sets the SendInvoiceRequestType.salesTax.

Parameters:
salesTax - SalesTaxType

getShippingServiceOptions

public ShippingServiceOptionsType[] getShippingServiceOptions()
Gets the SendInvoiceRequestType.shippingServiceOptions.

Returns:
ShippingServiceOptionsType[]

setShippingServiceOptions

public void setShippingServiceOptions(ShippingServiceOptionsType[] shippingServiceOptions)
Sets the SendInvoiceRequestType.shippingServiceOptions.

Parameters:
shippingServiceOptions - ShippingServiceOptionsType[]

getTransactionID

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

Returns:
String

setTransactionID

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

Parameters:
transactionID - String

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.