eBay Trading APIVersion 1067

SendInvoiceRequestType ( AbstractRequestType )

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.

Call that uses SendInvoiceRequestType:

Fields



AdjustmentAmount ( AmountType (double) ) [0..1]
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.
See the Field Index to learn which calls use AdjustmentAmount.

CheckoutInstructions ( string ) [0..1]
This field allows the seller to provide a message or instructions regarding checkout/payment, or the return policy.
See the Field Index to learn which calls use CheckoutInstructions.

CODCost ( AmountType (double) ) [0..1]
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.
See the Field Index to learn which calls use CODCost.

EmailCopyToSeller ( boolean ) [0..1]
Flag indicating whether or not the seller wishes to receive an email copy of the invoice sent to the buyer.
See the Field Index to learn which calls use EmailCopyToSeller.

InsuranceFee ( AmountType (double) ) [0..1]
This field is no longer applicable as it is not longer possible for a seller to offer a buyer shipping insurance.
See the Field Index to learn which calls use InsuranceFee.

InsuranceOption ( InsuranceOptionCodeType ) [0..1]
This field is no longer applicable as it is not longer possible for a seller to offer a buyer shipping insurance.
See the Field Index to learn which calls use InsuranceOption.

InternationalShippingServiceOptions ( InternationalShippingServiceOptionsType ) [0..*]
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.
See the Field Index to learn which calls use InternationalShippingServiceOptions.

ItemID ( ItemIDType (string) ) [0..1]
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 (Combined Invoice) order, OrderID should be used.
See the Field Index to learn which calls use ItemID.

OrderID ( OrderIDType (string) ) [0..1]
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. A Combined Invoice order can also be created by the seller through the AddOrder call.

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.
See the Field Index to learn which calls use OrderID.

OrderLineItemID ( string ) [0..1]
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.

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 (Combined Invoice) order, the OrderLineItemID must be specified. For a multiple line item (Combined Invoice) order, OrderID should be used. If OrderLineItemID is specified, ItemID, TransactionID, and SKU are ignored if present in the same request.
See the Field Index to learn which calls use OrderLineItemID.

PaymentMethods ( BuyerPaymentMethodCodeType ) [0..*]
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.
See the Field Index to learn which calls use PaymentMethods.

PayPalEmailAddress ( string ) [0..1]
If the PaymentMethods field is used and set to PayPal, the seller provides his/her PayPal email address in this field.
See the Field Index to learn which calls use PayPalEmailAddress.

SalesTax ( SalesTaxType ) [0..1]
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.
See the Field Index to learn which calls use SalesTax.

ShippingServiceOptions ( ShippingServiceOptionsType ) [0..*]
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.
See the Field Index to learn which calls use ShippingServiceOptions.

SKU ( SKUType (string) ) [0..1]
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.

This field can only be used if the Item.InventoryTrackingMethod field (set with the AddFixedPriceItem or RelistFixedPriceItem calls) is set to SKU.
See the Field Index to learn which calls use SKU.

TransactionID ( string ) [0..1]
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. 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.
See the Field Index to learn which calls use TransactionID.