SendInvoice - Call Reference - eBay Trading API

SendInvoice

Enables a seller to send an invoice to a buyer involved in a single transaction or order.

See also the reference documentation for these calls:

AddItem - Defines a single new item and lists it on a specified eBay site. Returns the item ID for the new listing, and returns fees the seller will incur for the listing (not including the Final Value Fee, which cannot be calculated until the item is sold).
GetItemTransactions - Retrieves transaction information for a specified itemID. The call returns zero, one, or multiple transactions, depending on the number of items sold from the listing.
GetSellerTransactions - Retrieves transaction information for the user for which the call is made, and not for any other user. (To retrieve transactions for another seller's listings, use GetItemTransactions.)

SendInvoice Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<SendInvoiceRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
  <!-- Call-specific Input Fields -->
  <CheckoutInstructions> string </CheckoutInstructions>
  <CODCost currencyID="CurrencyCodeType"> AmountType (double) </CODCost>
  <EmailCopyToSeller> boolean </EmailCopyToSeller>
  <InsuranceFee currencyID="CurrencyCodeType"> AmountType (double) </InsuranceFee>
  <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
  <InternationalShippingServiceOptions> InternationalShippingServiceOptionsType 
    <ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
    <ShippingService> token </ShippingService>
    <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
    <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
    <ShippingServicePriority> int </ShippingServicePriority>
    <ShipToLocation> string </ShipToLocation>
    <!-- ... more ShipToLocation nodes here ... -->
  </InternationalShippingServiceOptions>
  <!-- ... more InternationalShippingServiceOptions nodes here ... -->
  <ItemID> ItemIDType (string) </ItemID>
  <OrderID> OrderIDType (string) </OrderID>
  <PaymentMethods> BuyerPaymentMethodCodeType </PaymentMethods>
  <!-- ... more PaymentMethods nodes here ... -->
  <PayPalEmailAddress> string </PayPalEmailAddress>
  <SalesTax> SalesTaxType 
    <SalesTaxAmount currencyID="CurrencyCodeType"> AmountType (double) </SalesTaxAmount>
    <SalesTaxPercent> float </SalesTaxPercent>
    <SalesTaxState> string </SalesTaxState>
    <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
  </SalesTax>
  <ShippingServiceOptions> ShippingServiceOptionsType 
    <ShippingInsuranceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingInsuranceCost>
    <ShippingService> token </ShippingService>
    <ShippingServiceAdditionalCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceAdditionalCost>
    <ShippingServiceCost currencyID="CurrencyCodeType"> AmountType (double) </ShippingServiceCost>
    <ShippingServicePriority> int </ShippingServicePriority>
    <ShippingSurcharge currencyID="CurrencyCodeType"> AmountType (double) </ShippingSurcharge>
  </ShippingServiceOptions>
  <!-- ... more ShippingServiceOptions nodes here ... -->
  <SKU> SKUType (string) </SKU>
  <TransactionID> string </TransactionID>
</SendInvoiceRequest>

Argument	Type	Occurrence	Meaning

Standard Input Fields [Jump to call-specific fields]

ErrorLanguage	string	Optional	Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong See Tags for the Identification of Languages.
MessageID	string	Optional	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Version	string	Conditional	The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects: - It indicates the version of the code lists and other data that eBay should use to process your request. - It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See: HTTP Headers (XML API Only) eBay Schema Versioning Strategy Lowest Supported Version
WarningLevel	WarningLevelCodeType	Optional	Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level.

Call-specific Input Fields
CheckoutInstructions	string	Optional	Seller's Payment instructions/message to the buyer and return policy. Default is null. Max length: 500.
CODCost	AmountType (double)	Optional	Italy site (site ID 101) only. Enables you to specify the cash-on-delivery (COD) cost, for COD shipping. See Specifying the Cash on Delivery Option in Shipping Details.
CODCost [ attribute currencyID ]	CurrencyCodeType	Optional	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
EmailCopyToSeller	boolean	Optional	Specifies whether the seller wishes to be copied on the invoice email that will be sent to the buyer. Default will be true.
InsuranceFee	AmountType (double)	Optional	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. Not applicable to invoices for digital listings. Default: 0.0. See Determining Shipping Costs for a Listing.
InsuranceFee [ attribute currencyID ]	CurrencyCodeType	Optional	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
InsuranceOption	InsuranceOptionCodeType	Optional	Specifies whether 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. Not applicable to invoices for digital listings. Applicable values: • CustomCode (in/out) Reserved for internal or future use • IncludedInShippingHandling (in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost. • NotOffered (in/out) The seller does not offer shipping insurance to the buyer. • Optional (in/out) The seller offers the buyer the choice of paying for shipping insurance or not. • Required (in/out) The seller requires that the buyer pay for shipping insurance. (Not all values in InsuranceOptionCodeType apply to this field.) See Determining Shipping Costs for a Listing.
InternationalShippingServiceOptions	InternationalShippingServiceOptionsType	Optional, repeatable: [0..*]	If the buyer's shipping address is international, use this to offer up to three shipping services, and omit all domestic ShippingServiceOptions. Any shipping insurance cost specified should be the same for all services offered. Not applicable to invoices for digital listings.
InternationalShippingServiceOptions .ShippingInsuranceCost	AmountType (double)	Optional	The insurance cost associated with shipping a single item with this shipping service. Exception: for GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only. Valid only on the following sites: AU, FR, and IT Also applicable to Half.com (for GetOrders). See Shipping.
InternationalShippingServiceOptions .ShippingInsuranceCost [ attribute currencyID ]	CurrencyCodeType	Optional	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
InternationalShippingServiceOptions .ShippingService	token	Optional	An international shipping service offered for shipping the item. For a list of valid values that you can cache for future use, call GeteBayDetails with DetailName set to ShippingServiceDetails. For flat and calculated shipping. See GeteBayDetails. Applicable values: See ShippingServiceCodeType
InternationalShippingServiceOptions .ShippingServiceAdditionalCost	AmountType (double)	Optional	Cost of shipping each additional item beyond the first item. Should be zero for single-item listings. Default value is 0.00. For flat shipping only.
InternationalShippingServiceOptions .ShippingServiceAdditionalCost [ attribute currencyID ]	CurrencyCodeType	Optional	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
InternationalShippingServiceOptions .ShippingServiceCost	AmountType (double)	Optional	The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. See Shipping.
InternationalShippingServiceOptions .ShippingServiceCost [ attribute currencyID ]	CurrencyCodeType	Optional	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
InternationalShippingServiceOptions .ShippingServicePriority	int	Optional	Seller-preferred presentation order relative to other service options. Valid values are: 1, 2 and 3 (first, second and third choices). For flat and calculated shipping.
InternationalShippingServiceOptions .ShipToLocation	string	Optional, repeatable: [0..*]	An international location or region to where the item seller will ship the item. Use GeteBayDetails to determine which locations are valid per site. These values are string equivalents of values found in ShippingRegionCodeType and CountryCodeType. For the AddItem family of calls, this field is required if any international shipping service is specified. See ShipToLocation. Applicable values: See CountryCodeType, ShippingRegionCodeType
ItemID	ItemIDType (string)	Conditional	eBay's ID for the item from which the transaction was created. If OrderID is not provided, both ItemID (or SKU) and TransactionID must be provided to uniquely identify a single transaction. Max length: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).
OrderID	OrderIDType (string)	Conditional	Unique ID for a multi-transaction order. Either this OrderID must be specified or ItemID (or SKU) plus TransactionID must be specified. If OrderID is specified, ItemID, TransactionID, and SKU are ignored if present in the same request. Changes to the checkout status are applied to the specified order as a whole (and thus to the child transactions associated with the order).
PaymentMethods	BuyerPaymentMethodCodeType	Optional, repeatable: [0..*]	Optional ability for the seller to add certain payment methods on transaction if they were not originally specified on the item. Valid values are PayPal in the US, and MoneyXferAcceptedInCheckout (CIP+) in Germany. Applicable values: See PaymentMethods.
PayPalEmailAddress	string	Optional	Provide PayPal email address if the payment method added is PayPal. For digital listings, this must be an email address associated with a verified PayPal Premier or Business account.
SalesTax	SalesTaxType	Optional	The details of the sales tax added to the invoice.
SalesTax.SalesTaxAmount	AmountType (double)	Optional	(US only) The amount of sales tax, calculated for a transaction based on the SalesTaxPercent and pricing information. GetItemTransactions can return incorrect sales tax if the name of a state is not abbreviated (e.g. if the value is "Illinois" rather than "IL") in TransactionArray.Transaction.Buyer.BuyerInfo.ShippingAddress.StateOrProvince. If the name of a state is not abbreviated, sales tax should be obtained by using the ItemID and TransactionID to call GetOrderTransactions. Applicable to Half.com (for GetOrders).
SalesTax.SalesTaxAmount [ attribute currencyID ]	CurrencyCodeType	Optional	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
SalesTax.SalesTaxPercent	float	Optional	Percent of an item's price to be charged as the sales tax for the transaction. The value passed in is stored with a precision of 3 digits after the decimal point (##.###). Applicable to Half.com (for GetOrders).
SalesTax.SalesTaxState	string	Optional	State or jurisdiction for which the sales tax is being collected. Only returned if the seller specified a value. Applicable to Half.com (for GetOrders).
SalesTax.ShippingIncludedInTax	boolean	Optional	(US only) Whether shipping costs were part of the base amount that was taxed. Flat or calculated shipping. Applicable to Half.com (for GetOrders).
ShippingServiceOptions	ShippingServiceOptionsType	Optional, repeatable: [0..*]	If the buyer's shipping address is domestic, use this to offer up to three shipping services, and omit all InternationalShippingServiceOptions. Any shipping insurance cost specified should be the same for all services offered. Not applicable to invoices for digital listings.
ShippingServiceOptions .ShippingInsuranceCost	AmountType (double)	Optional	The insurance cost associated with shipping a single item with this shipping service. Exception: for GetItemShipping, this is proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only. Also applicable to Half.com (for GetOrders). See Determining Shipping Costs for a Listing.
ShippingServiceOptions .ShippingInsuranceCost [ attribute currencyID ]	CurrencyCodeType	Optional	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
ShippingServiceOptions .ShippingService	token	Optional	A domestic shipping service offered for shipping the item (for example, UPS Ground). For a list of valid values that you can cache for future use, call GeteBayDetails with DetailName set to ShippingServiceDetails. For flat and calculated shipping. Also applicable to Half.com (for GetOrders). If there are two or more services and one is "pickup", "pickup" must not be specified as the first service. See GeteBayDetails. Applicable values: See ShippingServiceCodeType
ShippingServiceOptions .ShippingServiceAdditionalCost	AmountType (double)	Optional	The cost of shipping each additional item beyond the first item. For input, this is required if the listing is for multiple items and should be zero for single-item listings. Default value is 0.00. For flat shipping only. Not applicable to Half.com. See Determining Shipping Costs for a Listing.
ShippingServiceOptions .ShippingServiceAdditionalCost [ attribute currencyID ]	CurrencyCodeType	Optional	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
ShippingServiceOptions .ShippingServiceCost	AmountType (double)	Optional	The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) When returned by GetItemShipping, it includes the packaging and handling cost. For flat and calculated shipping. Also applicable to Half.com (for GetOrders). See Determining Shipping Costs for a Listing.
ShippingServiceOptions .ShippingServiceCost [ attribute currencyID ]	CurrencyCodeType	Optional	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
ShippingServiceOptions .ShippingServicePriority	int	Optional	Seller-preferred presentation order relative to other service options. Valid values: 1 (1st choice), 2 (2nd choice), 3 (3rd choice). For flat and calculated shipping. Not applicable to Half.com.
ShippingServiceOptions .ShippingSurcharge	AmountType (double)	Optional	An additional fee to charge US buyers who ship via UPS to Alaska, Hawaii or Puerto Rico. Can only be assigned a value for the eBay US site and for items in the Parts and Accessories category of the eBay Motors site. Only returned if set. If some transactions in an order have a surcharge, surcharge is added only for those transactions. Flat rate shipping only.
ShippingServiceOptions .ShippingSurcharge [ attribute currencyID ]	CurrencyCodeType	Optional	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
SKU	SKUType (string)	Conditional	The seller's unique identifier for an item that is being tracked by this SKU. If OrderID is not provided, both SKU (or ItemID) and TransactionID must be provided to uniquely identify a single transaction. This field can only be used when you listed the item by using AddFixedPriceItem or RelistFixedPriceItem, and you set Item.InventoryTrackingMethod to SKU at the time the item was listed. (These criteria are necessary to uniquely identify the listing by a SKU.) Note: AddFixedPriceItem and RelistFixedPriceItem are defined in the Merchant Data API (part of Large Merchant Services). Max length: 50.
TransactionID	string	Conditional	ID for the transaction with which the item was sold. If OrderID is not provided, both ItemID and TransactionID must be provided. For Chinese auctions, the value passed in the TransactionId argument must be 0 or the call will fail with an error. Call GetItemTransactions or GetSellerTransactions to determine the correct transaction ID. Max length: 19 (Note: The eBay database specifies 38. Currently, transaction IDs are usually 9 to 12 digits.).

SendInvoice Output

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<SendInvoiceResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType 
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType 
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</SendInvoiceResponse>

Return Value	Type	Occurrence	Meaning

Standard Output Fields

Ack	AckCodeType	Always	A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack. Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.)
Build	string	Always	This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID	string	Conditionally	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors	ErrorType	Conditionally, repeatable: [0..*]	A list of application-level errors (if any) that occurred when eBay processed the request. See Error Handling.
Errors.ErrorClassification	ErrorClassificationCodeType	Conditionally	API errors are divided between two classes: system errors and request errors. Applicable values: • CustomCode (out) Reserved for internal or future use. • RequestError (out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. • SystemError (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
Errors.ErrorCode	token	Conditionally	A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document.
Errors.ErrorParameters	ErrorParameterType	Conditionally, repeatable: [0..*]	This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters [ attribute ParamID ]	string	Conditionally	The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value	string	Conditionally	The value of the variable (e.g., the attribute set ID)
Errors.LongMessage	string	Conditionally	A more detailed description of the condition that raised the error.
Errors.SeverityCode	SeverityCodeType	Conditionally	Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. Applicable values: • CustomCode (out) Reserved for internal or future use • Error (out) Application-level error • Warning (out) Warning or informational error
Errors.ShortMessage	string	Conditionally	A brief description of the condition that raised the error.
HardExpirationWarning	string	Conditionally	Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp	dateTime	Always	This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version	string	Always	The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.

SendInvoice Detail Controls

Detail Control: DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.

SendInvoice Samples

An inline sample will be added in a future release. Please refer to the Samples section of the eBay Web Services Guide chapter for SendInvoice.

SendInvoice Change History

Version	Description
635 2009-09-16	InsuranceDetails, InsuranceFee, InsuranceOption, InternationalInsuranceDetails, InsuranceWanted, ShippingInsuranceCost (modified): Sellers can no longer give buyers the option to purchase shipping insurance for either domestic or international items. The buyer-paid shipping insurance option has been removed from the following sites: `BEFR, BENL, CA, CAFR, HK, IE, IN, MY, Motors, NL, PH, PL, SG, UK, US` Insurance tags are returned only when the associated item has buyer-paid shipping insurance values.
555 2008-03-05	CODCost (added): By April, on the Italy site (site ID 101), contains the cost of cash-on-delivery shipping.
537 2007-10-31	BuyerPaymentMethodCodeType.PaisaPayEscrow, BuyerPaymentMethodCodeType.PaisaPayEscrowEMI (added): Now supports a new payment method PaisaPayEscrow and PaisaPayEscrowEMI for India site.

This document was generated with a customized version of the apireferencedocs tool.

eBay Trading API Call Reference Version 643

eBay Trading API
Call Reference Version 643