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

List of All Calls Field Index Enumeration Index Type Index Deprecated Objects Errors by Number Input Output Detail Controls Samples Change History Top Errors for AddOrder User Notes

Combines two or more transactions into a single order, enabling a buyer to pay for all of those transactions with a single payment (and, if so arranged, ship all of the items together).

Strong recommendation: avoid mixing digital and non-digital listings in the same order. (In the future, AddOrder may enforce this recommendation.)

See Working with Combined Payment.

Back to top

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 may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).

<?xml version="1.0" encoding="utf-8"?>
<AddOrderRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <InvocationID> UUIDType (string) </InvocationID>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
  <!-- Call-specific Input Fields -->
  <Order> OrderType 
    <CreatingUserRole> TradingRoleCodeType </CreatingUserRole>
    <PaymentMethods> BuyerPaymentMethodCodeType </PaymentMethods>
    <!-- ... more PaymentMethods nodes here ... -->
    <ShippingDetails> ShippingDetailsType 
      <CODCost> AmountType (double) </CODCost>
      <InsuranceFee> AmountType (double) </InsuranceFee>
      <InsuranceOption> InsuranceOptionCodeType </InsuranceOption>
      <InternationalShippingServiceOption> InternationalShippingServiceOptionsType 
        <ShippingInsuranceCost> AmountType (double) </ShippingInsuranceCost>
        <ShippingService> token </ShippingService>
        <ShippingServiceAdditionalCost> AmountType (double) </ShippingServiceAdditionalCost>
        <ShippingServiceCost> AmountType (double) </ShippingServiceCost>
        <ShippingServicePriority> int </ShippingServicePriority>
        <ShipToLocation> string </ShipToLocation>
        <!-- ... more ShipToLocation nodes here ... -->
      </InternationalShippingServiceOption>
      <!-- ... more InternationalShippingServiceOption nodes here ... -->
      <SalesTax> SalesTaxType 
        <SalesTaxPercent> float </SalesTaxPercent>
        <SalesTaxState> string </SalesTaxState>
        <ShippingIncludedInTax> boolean </ShippingIncludedInTax>
      </SalesTax>
      <ShippingServiceOptions> ShippingServiceOptionsType 
        <ShippingInsuranceCost> AmountType (double) </ShippingInsuranceCost>
        <ShippingService> token </ShippingService>
        <ShippingServiceAdditionalCost> AmountType (double) </ShippingServiceAdditionalCost>
        <ShippingServiceCost> AmountType (double) </ShippingServiceCost>
        <ShippingServicePriority> int </ShippingServicePriority>
        <ShippingSurcharge> AmountType (double) </ShippingSurcharge>
      </ShippingServiceOptions>
      <!-- ... more ShippingServiceOptions nodes here ... -->
      <ThirdPartyCheckout> boolean </ThirdPartyCheckout>
    </ShippingDetails>
    <Total currencyID="CurrencyCodeType"> AmountType (double) </Total>
    <TransactionArray> TransactionArrayType 
      <Transaction> TransactionType 
        <Item> ItemType 
          <ItemID> ItemIDType (string) </ItemID>
        </Item>
        <TransactionID> string </TransactionID>
      </Transaction>
      <!-- ... more Transaction nodes here ... -->
    </TransactionArray>
  </Order>
</AddOrderRequest>

Back to top

The box below lists all fields that might be returned in the call 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 may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).

<?xml version="1.0" encoding="utf-8"?>
<AddOrderResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <DuplicateInvocationDetails> DuplicateInvocationDetailsType 
    <DuplicateInvocationID> UUIDType (string) </DuplicateInvocationID>
    <InvocationTrackingID> string </InvocationTrackingID>
    <Status> InvocationStatusType </Status>
  </DuplicateInvocationDetails>
  <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>
  <!-- Call-specific Output Fields -->
  <CreatedTime> dateTime </CreatedTime>
  <OrderID> OrderIDType (string) </OrderID>
</AddOrderResponse>

Back to top

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

Back to top

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.

Creates an order from two ItemID/TransactionID pairs

Description

User braggybuyer purchased two separate items from magicalbookseller. magicalbookseller wants to make the process more convenient for herself and the buyer: magicalbookseller wants to combine the two transactions into one order so that braggybuyer can pay for both items together (and thus only going through the checkout process once for everything). magicalbookseller has the item ID for each listing and already used GetItemTransactions to obtain the transaction ID corresponding to each item.

Input

The key input for this call is Transaction (a container with the ItemID and corresponding TransactionID). For the seller to create the order, set CreatingUserRole to Seller. (By the way, a few more options are available when the person creating the order is the seller.)

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

<?xml version="1.0" encoding="utf-8"?>
<AddOrderRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
  <Order>
    <CreatingUserRole>Seller</CreatingUserRole>
    <PaymentMethods>PayPal</PaymentMethods>
    <Total currencyID="USD">36.00</Total>
    <TransactionArray>
      <Transaction>
        <Item>
          <ItemID>110025788765</ItemID>
        </Item>
        <TransactionID>0</TransactionID>
      </Transaction>
      <Transaction>
        <Item>
          <ItemID>110025788368</ItemID>
        </Item>
        <TransactionID>0</TransactionID>
      </Transaction>
    </TransactionArray>
  </Order>
</AddOrderRequest>

Output

AddOrder creates an order and returns an OrderID. The order is assigned the state of Active.

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

<?xml version="1.0" encoding="UTF-8" ?>
<AddOrderResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2007-12-10T16:09:47.540Z</Timestamp>
  <Ack>Success</Ack>
  <Version>539</Version>
  <Build>e539_core_Bundled_5642307_R1</Build>
  <OrderID>865826</OrderID>
  <CreatedTime>2007-12-10T16:09:47.000Z</CreatedTime>
</AddOrderResponse>

Back to top

Back to top

This document was generated with a customized version of the apireferencedocs tool [0.5M zip].

© 2005–2008 eBay, Inc. All rights reserved.