eBay Trading APIVersion 1257
 

SendInvoiceRequestType ( AbstractRequestType )

This call enables a seller to send an order invoice to a buyer. Optionally, and when applicable, this call can also be used to update the shipping service options available for shipment, to provide payment or checkout instructions to the buyer, to make a cost adjustment for the order/order line item, or to provide one or more offline payment methods (for orders where offline payment is an option).

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]
This field is included and set to true if 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]
Not used by any call.

This field is no longer applicable as it is no 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]
Not used by any call.

This field is no longer applicable as it is no 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 service options (or five if one of them is Global Shipping Program). If one or more international shipping service options are offered through this container, the (domestic) ShippingServiceOptions container should not be included in the same request.
See the Field Index to learn which calls use InternationalShippingServiceOptions.

ItemID ( ItemIDType (string) ) [0..1]
Unique identifier of the eBay listing. Unless OrderID or OrderLineItemID is provided in the request, the ItemID value (or SKU value) is conditionally required and must be paired with the corresponding TransactionID value to identify an order line item. For a multiple line item 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 order.

Unless the ItemID value (or SKU value) and corresponding TransactionID value, or the OrderLineItemID value is provided in the request to identify a single line item order, the OrderID value must be specified. If OrderID value is specified, OrderLineItemID, ItemID, TransactionID, and SKU fields are ignored if present in the same request.

Note: Note that the unique identifier of a 'non-immediate payment' order will change as it goes from an unpaid order to a paid order. Due to this scenario, all Trading API calls that accept Order ID values as filters in the request payload will support the identifiers for both unpaid and paid orders.

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. Sellers should not fulfill orders until buyer has made payment.
See the Field Index to learn which calls use OrderID.

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

PaymentMethods ( BuyerPaymentMethodCodeType ) [0..*]
This field should only be used if the seller needs to add one or more offline payment options for an order that requires/supports offline payment. A seller should not submit any online payment methods here since eBay now controls the available online payment options that are available to buyers, and not the seller.
See the Field Index to learn which calls use PaymentMethods.

PayPalEmailAddress ( string ) [0..1]
DO NOT USE. This field is no longer applicable.
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 if the buyer lives in a state/jurisdiction where sales tax is not already collected automatically by eBay and remitted to the tax authority. 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 November 4, 2021, eBay now collects and remits sales tax to the tax authorities for all but one US state (Missouri) and five US territories. So, in most cases, this container will not be applicable and should not be used in a request. For more information, see the eBay sales tax collection help topic.
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 service options. If one or more domestic shipping service options are offered through this container, the InternationalShippingServiceOptions container should not be included in the same 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 order, OrderID must be used.

This field should 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 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 value is required and must be paired with the corresponding ItemID value to identify an order line item. For a multiple line item order, OrderID should be used.
See the Field Index to learn which calls use TransactionID.