complexType "ns:SendInvoiceRequestType"

Overview

Namespace

WSDL

Schema

Component

Index

PREV C-TYPE NEXT C-TYPE

FRAMES NO FRAMES NS-Bindings

SUMMARY: XML REP | DERIVED | USE

DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD

eBay Trading API

complexType "ns:SendInvoiceRequestType"

Namespace:	urn:ebay:apis:eBLBaseComponents
Content:	complex, 26 elements, elem. wildcard
Defined:	globally in Schema in ebaySvc.wsdl; see XML source
Includes:	definitions of 16 elements
Used:	at 1 location

Component Diagram

XML Representation Summary

<...>

Content:

</...>

All Direct / Indirect Based Elements (1):

ns:SendInvoiceRequest

Known Usage Locations

As direct type of elements (1):

ns:SendInvoiceRequest

Annotation

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.

Type Definition Detail

Type Derivation Tree

ns:AbstractRequestType (extension)

ns:SendInvoiceRequestType

XML Source (w/o annotations (17); see within schema source)

<xs:complexType name="SendInvoiceRequestType">

<xs:complexContent>

<xs:extension base="ns:AbstractRequestType">

<xs:sequence>

<xs:element minOccurs="0" name="ItemID" type="ns:ItemIDType"/>

<xs:element minOccurs="0" name="TransactionID" type="xs:string"/>

<xs:element minOccurs="0" name="OrderID" type="ns:OrderIDType"/>

<xs:element maxOccurs="unbounded" minOccurs="0" name="InternationalShippingServiceOptions" type="ns:InternationalShippingServiceOptionsType"/>

<xs:element maxOccurs="unbounded" minOccurs="0" name="ShippingServiceOptions" type="ns:ShippingServiceOptionsType"/>

<xs:element minOccurs="0" name="SalesTax" type="ns:SalesTaxType"/>

<xs:element minOccurs="0" name="InsuranceOption" type="ns:InsuranceOptionCodeType"/>

<xs:element minOccurs="0" name="InsuranceFee" type="ns:AmountType"/>

<xs:element maxOccurs="unbounded" minOccurs="0" name="PaymentMethods" type="ns:BuyerPaymentMethodCodeType"/>

<xs:element minOccurs="0" name="PayPalEmailAddress" type="xs:string"/>

<xs:element minOccurs="0" name="CheckoutInstructions" type="xs:string"/>

<xs:element minOccurs="0" name="EmailCopyToSeller" type="xs:boolean"/>

<xs:element minOccurs="0" name="CODCost" type="ns:AmountType"/>

<xs:element minOccurs="0" name="SKU" type="ns:SKUType"/>

<xs:element minOccurs="0" name="OrderLineItemID" type="xs:string"/>

<xs:element minOccurs="0" name="AdjustmentAmount" type="ns:AmountType"/>

</xs:sequence>

</xs:extension>

</xs:complexContent>

</xs:complexType>

Content Element Detail (all declarations defined in this component; 16/27)

ns:AdjustmentAmount

Type:

ns:AmountType, simple content

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.

Component Diagram

XML Representation Summary

<ns:AdjustmentAmount

currencyID

("AFA" | "ALL" | "DZD" | "ADP" | "AOA" | "ARS" | "AMD" | "AWG" | "AZM" | "BSD" | "BHD" | "BDT" | "BBD" | "BYR" | "BZD" | "BMD" | "BTN" | "INR" | "BOV" | "BOB" | "BAM" | "BWP" | "BRL" | "BND" | "BGL" | "BGN" | "BIF" | "KHR" | "CAD" | "CVE" | "KYD" | "XAF" | "CLF" | "CLP" | "CNY" | "COP" | "KMF" | "CDF" | "CRC" | "HRK" | "CUP" | "CYP" | "CZK" | "DKK" | "DJF" | "DOP" | "TPE" | "ECV" | "ECS" | "EGP" | "SVC" | "ERN" | "EEK" | "ETB" | "FKP" | "FJD" | "GMD" | "GEL" | "GHC" | "GIP" | "GTQ" | "GNF" | "GWP" | "GYD" | "HTG" | "HNL" | "HKD" | "HUF" | "ISK" | "IDR" | "IRR" | "IQD" | "ILS" | "JMD" | "JPY" | "JOD" | "KZT" | "KES" | "AUD" | "KPW" | "KRW" | "KWD" | "KGS" | "LAK" | "LVL" | "LBP" | "LSL" | "LRD" | "LYD" | "CHF" | "LTL" | "MOP" | "MKD" | "MGF" | "MWK" | "MYR" | "MVR" | "MTL" | "EUR" | "MRO" | "MUR" | "MXN" | "MXV" | "MDL" | "MNT" | "XCD" | "MZM" | "MMK" | "ZAR" | "NAD" | "NPR" | "ANG" | "XPF" | "NZD" | "NIO" | "NGN" | "NOK" | "OMR" | "PKR" | "PAB" | "PGK" | "PYG" | "PEN" | "PHP" | "PLN" | "USD" | "QAR" | "ROL" | "RUB" | "RUR" | "RWF" | "SHP" | "WST" | "STD" | "SAR" | "SCR" | "SLL" | "SGD" | "SKK" | "SIT" | "SBD" | "SOS" | "LKR" | "SDD" | "SRG" | "SZL" | "SEK" | "SYP" | "TWD" | "TJS" | "TZS" | "THB" | "XOF" | "TOP" | "TTD" | "TND" | "TRL" | "TMM" | "UGX" | "UAH" | "AED" | "GBP" | "USS" | "USN" | "UYU" | "UZS" | "VUV" | "VEB" | "VND" | "MAD" | "YER" | "YUM" | "ZMK" | "ZWD" | "ATS" | "CustomCode")

Content:

{ xs:double }

</ns:AdjustmentAmount>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="AdjustmentAmount" type="ns:AmountType"/>

ns:CheckoutInstructions

Type:

xs:string, predefined, simple content

This field allows the seller to provide a message or instructions regarding checkout/payment, or the return policy.

XML Representation Summary

<ns:CheckoutInstructions>

Content:

{ xs:string }

</ns:CheckoutInstructions>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="CheckoutInstructions" type="xs:string"/>

ns:CODCost

Type:

ns:AmountType, simple content

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.

Component Diagram

XML Representation Summary

<ns:CODCost

currencyID

Content:

{ xs:double }

</ns:CODCost>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="CODCost" type="ns:AmountType"/>

ns:EmailCopyToSeller

Type:

xs:boolean, predefined, simple content

This field is included and set to true if the seller wishes to receive an email copy of the invoice sent to the buyer.

XML Representation Summary

<ns:EmailCopyToSeller>

Content:

{ xs:boolean }

</ns:EmailCopyToSeller>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="EmailCopyToSeller" type="xs:boolean"/>

ns:InsuranceFee

Type:

ns:AmountType, simple content

This field is no longer applicable as it is no longer possible for a seller to offer a buyer shipping insurance.

Component Diagram

XML Representation Summary

<ns:InsuranceFee

currencyID

Content:

{ xs:double }

</ns:InsuranceFee>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="InsuranceFee" type="ns:AmountType"/>

ns:InsuranceOption

Type:

ns:InsuranceOptionCodeType, simple content

This field is no longer applicable as it is no longer possible for a seller to offer a buyer shipping insurance.

XML Representation Summary

<ns:InsuranceOption>

Content:

{ enumeration of xs:token }

</ns:InsuranceOption>

Simple Content

Enumeration:

"Optional"	-	The seller offers the buyer the choice of paying for shipping insurance or not.
"Required"	-	The seller requires that the buyer pay for shipping insurance.
"NotOffered"	-	The seller does not offer shipping insurance to the buyer.
"IncludedInShippingHandling"	-	The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost.
"NotOfferedOnSite"	-	Shipping insurance is not offered as a separate option on the site where the item is listed. (Some shipping services, such as DE_InsuredExpressOrCourier, include insurance as part of the service.) If another insurance option is specified in the listing request and the site does not support shipping insurance as a separate option, eBay will reset the insurance option to this value. At the time of this writing, this option is only meaningful for the eBay Germany, Austria, and Switzerland sites.
"CustomCode"	-	Reserved for internal or future use

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="InsuranceOption" type="ns:InsuranceOptionCodeType"/>

ns:InternationalShippingServiceOptions

Type:

ns:InternationalShippingServiceOptionsType, complex content

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.

Component Diagram

XML Representation Summary

<ns:InternationalShippingServiceOptions>

Content:

ns:ShippingService?, ns:ShippingServiceCost?, ns:ShippingServiceAdditionalCost?, ns:ShippingServicePriority?, ns:ShipToLocation*, ns:ShippingInsuranceCost?, ns:ImportCharge?, ns:ShippingServiceCutOffTime?, {any}*

</ns:InternationalShippingServiceOptions>

XML Source (w/o annotations (1); see within schema source)

<xs:element maxOccurs="unbounded" minOccurs="0" name="InternationalShippingServiceOptions" type="ns:InternationalShippingServiceOptionsType"/>

ns:ItemID

Type:

ns:ItemIDType, simple content

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.

XML Representation Summary

<ns:ItemID>

Content:

{ xs:string }

</ns:ItemID>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ItemID" type="ns:ItemIDType"/>

ns:OrderID

Type:

ns:OrderIDType, simple content

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: In June 2019, eBay introduced a new order ID format, but allowed developers/sellers to decide whether to immediately adopt the new format, or to continue working with the old format. Users who wanted to adopt the new format, could either use a Trading WSDL Version 1113 (or newer), or they could even use an older Trading WSDL but set the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header value to 1113 in API calls. Beginning in June 2020, only the new order ID format will be returned in response payloads for paid orders, regardless of the WSDL version number or compatibility level.

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 calls that accept Order ID values as filters in the request payload, including the SendInvoice call, will support the identifiers for both unpaid and paid orders. The new order ID 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.

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.

XML Representation Summary

<ns:OrderID>

Content:

{ xs:string }

</ns:OrderID>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="OrderID" type="ns:OrderIDType"/>

ns:OrderLineItemID

Type:

xs:string, predefined, simple content

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.

XML Representation Summary

<ns:OrderLineItemID>

Content:

{ xs:string }

</ns:OrderLineItemID>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="OrderLineItemID" type="xs:string"/>

ns:PaymentMethods

Type:

ns:BuyerPaymentMethodCodeType, simple content

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.

XML Representation Summary

<ns:PaymentMethods>

Content:

{ enumeration of xs:token }

</ns:PaymentMethods>

Simple Content

Enumeration:

see details at ns:BuyerPaymentMethodCodeType

XML Source (w/o annotations (1); see within schema source)

<xs:element maxOccurs="unbounded" minOccurs="0" name="PaymentMethods" type="ns:BuyerPaymentMethodCodeType"/>

ns:PayPalEmailAddress

Type:

xs:string, predefined, simple content

If the PaymentMethods field is used and set to PayPal, the seller provides his/her PayPal email address in this field.

XML Representation Summary

<ns:PayPalEmailAddress>

Content:

{ xs:string }

</ns:PayPalEmailAddress>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="PayPalEmailAddress" type="xs:string"/>

ns:SalesTax

Type:

ns:SalesTaxType, complex content

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.

Component Diagram

XML Representation Summary

<ns:SalesTax>

Content:

ns:SalesTaxPercent?, ns:SalesTaxState?, ns:ShippingIncludedInTax?, ns:SalesTaxAmount?, {any}*

</ns:SalesTax>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="SalesTax" type="ns:SalesTaxType"/>

ns:ShippingServiceOptions

Type:

ns:ShippingServiceOptionsType, complex content

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.

Component Diagram

XML Representation Summary

<ns:ShippingServiceOptions>

Content:

ns:ShippingInsuranceCost?, ns:ShippingService?, ns:ShippingServiceCost?, ns:ShippingServiceAdditionalCost?, ns:ShippingServicePriority?, ns:ExpeditedService?, ns:ShippingTimeMin?, ns:ShippingTimeMax?, ns:FreeShipping?, ns:LocalPickup?, ns:ImportCharge?, ns:ShippingPackageInfo*, ns:ShippingServiceCutOffTime?, ns:LogisticPlanType?, {any}*

</ns:ShippingServiceOptions>

XML Source (w/o annotations (1); see within schema source)

<xs:element maxOccurs="unbounded" minOccurs="0" name="ShippingServiceOptions" type="ns:ShippingServiceOptionsType"/>

ns:SKU

Type:

ns:SKUType, simple content

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.

XML Representation Summary

<ns:SKU>

Content:

{ xs:string }

</ns:SKU>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="SKU" type="ns:SKUType"/>

ns:TransactionID

Type:

xs:string, predefined, simple content

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.

XML Representation Summary

<ns:TransactionID>

Content:

{ xs:string }

</ns:TransactionID>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="TransactionID" type="xs:string"/>

Overview

Namespace

WSDL

Schema

Component

Index

PREV C-TYPE NEXT C-TYPE

FRAMES NO FRAMES NS-Bindings

SUMMARY: XML REP | DERIVED | USE

DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD

eBay Trading API

WSDL documentation generated with FlexDoc/XML 1.13 using FlexDoc/XML WSDLDoc 1.2.5 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit.