eBay Trading API Call Reference Version 821 Support     Knowledge Base     Forums     All Tutorials     All Code Samples Users Guide Call Reference Making an API Call Tutorials Release Notes

Call Index Field Index Enumeration Index Type Index Deprecated Objects Errors by Number Input Output Detail Controls Samples Change History Top Errors for SendInvoice User Notes

SendInvoice

Use this call to send an email invoice or order to a buyer. If you specify a valid ItemID and TransactionID pair or an OrderLineItemID, SendInvoice sends a new or reminder invoice to the buyer. If you instead specify an OrderID, SendInvoice sends the order information to the buyer. In either case, the seller can request that a copy of the invoice or order be sent by email.

You can use SendInvoice to send an invoice once, or periodically if the buyer needs reminders.

When using SendInvoice, be sure that you meet the following conditions:

• The shipping service and shipping options you specify are supported by the site and match those selected when the item was purchased.
• The shipping costs are positive numbers.
• The sales tax percentage is between 0 and 100.
• Any payment method you specify is supported for the site and offered with the item.
• If you supply an item ID to the call, it must be valid on the eBay site and belong to the requester.
• If you supply a transaction ID, it must be valid on the eBay site, belong to the requester, belong to the item ID, and be not more than 30 days old.
• If you supply an OrderLineItemID, it must be valid on the eBay site and not be more than 30 days old.
• If you pass in an order ID, it must be valid on the eBay site, generated by the requester, and be an active order.

SendInvoice needs an ItemID and TransactionID combination, an OrderLineItemID, or an OrderID.

The response for SendInvoice, as defined in the schema, does not have any return values other than those defined in AbstractResponseType. If the call to SendInvoice is successful, it returns a call status of Success. If unsuccessful, it returns an error construct (see Error Handling). If a warning occurs, the result will contain both a call status and an error.

Testing SendInvoice

You can test this call in the Sandbox, as follows:

1. Set up a sample seller and at least two buyers in the Sandbox environment.
2. Sign in as the sample seller and create several listings, creating item IDs for each listing.
3. Sign in as one of the sample buyers and purchase more than one item, creating an order ID.
4. Sign in as another sample buyer and purchase one item, creating a transaction ID.
5. Call SendInvoice as the sample seller to send order information to the first buyer. Make sure that the email is sent to the correct address with the correct order information but is not an invoice. Request an email copy and make sure you receive it and it is correct.
6. Call SendInvoice as the sample seller to send an invoice to the second buyer, specifying an item ID and transaction ID. Make sure that the email is sent to the correct address with the correct invoice information. Request an email copy and make sure you receive it and it is correct.
7. Try the same call again, using a valid item ID but an incorrect transaction ID.
8. If time allows, let the order line item age at least 30 days, then attempt to send the invoice again. The call should return an error.

Ensure the profiles of your test users are properly completed to ensure the shipping services can be verified.

Related Information

See also the reference documentation for these calls:

• AddItem - Defines a single new item and lists it on a specified eBay site. Also for Half.com.
• GetItemTransactions - Retrieves order line item (transaction) information for a specified ItemID.
• GetSellerTransactions - Retrieves order line item (transaction) information for the user for which the call is made, and not for any other user. Also for Half.com. (To retrieve order line items for another seller's listings, use GetItemTransactions.)

Back to top

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">
  <!-- Call-specific Input Fields -->
  <AdjustmentAmount currencyID="CurrencyCodeType"> AmountType (double) </AdjustmentAmount>
  <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 values allowed here ... -->
  </InternationalShippingServiceOptions>
  <!-- ... more InternationalShippingServiceOptions nodes allowed here ... -->
  <ItemID> ItemIDType (string) </ItemID>
  <OrderID> OrderIDType (string) </OrderID>
  <OrderLineItemID> string </OrderLineItemID>
  <PaymentMethods> BuyerPaymentMethodCodeType </PaymentMethods>
  <!-- ... more PaymentMethods values allowed 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 allowed here ... -->
  <SKU> SKUType (string) </SKU>
  <TransactionID> string </TransactionID>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</SendInvoiceRequest>

Back to top

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).

<?xml version="1.0" encoding="utf-8"?>
<SendInvoiceResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- (No call-specific Output fields) -->

  <!-- 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 allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</SendInvoiceResponse>

Back to top

SendInvoice Detail Controls

Detail Control: DetailLevel

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

Back to top

SendInvoice Samples

New to making API calls? Please see Routing the Request.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sends an invoice to the buyer of a recently sold item.

Description

Magical Bookseller sold a book to Bountiful Buyer, and she uses SendInvoice to send an invoice to the buyer for the item.

Input

The ShippingService type must match the shipping service selected at the time of purchase, and the payment methods should match those listed with the item.

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<SendInvoiceRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <ErrorLanguage>en_US</ErrorLanguage>
  <WarningLevel>High</WarningLevel>

  <ItemID>110043277865</ItemID>
  <TransactionID>0</TransactionID>
  <PaymentMethods>PayPal</PaymentMethods>
  <PayPalEmailAddress>magicalbookseller@yahoo.com</PayPalEmailAddress>
  <ShippingServiceOptions>
    <ShippingService>USPSMedia</ShippingService>
    <ShippingServiceCost currencyID="USD">2.5</ShippingServiceCost>
    <ShippingServicePriority>1</ShippingServicePriority>
    <ExpeditedService>false</ExpeditedService>
    <ShippingTimeMin>2</ShippingTimeMin>
    <ShippingTimeMax>9</ShippingTimeMax>
  </ShippingServiceOptions>
  <SalesTax> 
    <SalesTaxPercent>8.25</SalesTaxPercent> 
    <SalesTaxState>CA</SalesTaxState> 
    <ShippingIncludedInTax>1</ShippingIncludedInTax>
    <SalesTaxAmount currencyID="USD">1.65</SalesTaxAmount> 
  </SalesTax> 
</SendInvoiceRequest>

Output

XML format. Also available is the .txt version of this XML.

<SendInvoiceResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2010-01-27T20:38:52.225Z</Timestamp>
  <Ack>Success</Ack>
  <Version>653</Version>
  <Build>E653_CORE_BUNDLED_10549562_R1</Build>
</SendInvoiceResponse>

Back to top

SendInvoice Change History

Back to top

User-Contributed Notes

Copyright © 2005–2013 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.