Dashboard > ChannelAdvisor Developer Network > ... > Order Service > SubmitOrder
Log In   View a printable version of the current page.
Added by Rick Watson, last edited by James Johnson on Feb 21, 2007  (view change)
Labels: 
(None)


Overview

SubmitOrder is a method of the Order Service which creates a new order in the ChannelAdvisor system.
Any order submitted to ChannelAdvisor is subject to your normal ChannelAdvisor billing terms.

Request

Field Name
Data Type Description
accountID string
A unique identifier representing the ChannelAdvisor account you wish to access.
order OrderSubmit
An object containing the order data to be entered into ChannelAdvisor.

Request Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://api.channeladvisor.com/webservices/" xmlns:ord="http://api.channeladvisor.com/datacontracts/orders">
   <soapenv:Header>
      <web:APICredentials>
         <!-Optional:->
         <web:DeveloperKey> --- </web:DeveloperKey>
         <!-Optional:->
         <web:Password> --- </web:Password>
      </web:APICredentials>
   </soapenv:Header>
   <soapenv:Body>
      <web:SubmitOrder>
         <!-Optional:->
         <web:accountID> --- </web:accountID>
         <!-Optional:->
         <web:order>
            <ord:OrderTimeGMT>2006-09-06T03:23:00</ord:OrderTimeGMT>
            <!-Optional:->
            <ord:ClientOrderIdentifier/>
            <!-Optional:->
            <ord:OrderStatus>
               <ord:CheckoutStatus>NoChange</ord:CheckoutStatus>
               <ord:CheckoutDateGMT>2006-09-06T03:23:00</ord:CheckoutDateGMT>
               <ord:PaymentStatus>NoChange</ord:PaymentStatus>
               <ord:PaymentDateGMT>2006-09-06T03:23:00</ord:PaymentDateGMT>
               <ord:ShippingStatus>NoChange</ord:ShippingStatus>
               <ord:ShippingDateGMT>2006-09-06T03:23:00</ord:ShippingDateGMT>
            </ord:OrderStatus>
            <!-Optional:->
            <ord:BuyerEmailAddress>JamesJ@channeladvisor.com</ord:BuyerEmailAddress>
            <ord:EmailOptIn>false</ord:EmailOptIn>
            <!-Optional:->
            <ord:ResellerID/>
            <!-Optional:->
            <ord:BillingInfo>
               <!-Optional:->
               <ord:AddressLine1>186 Willow Pond Way</ord:AddressLine1>
               <!-Optional:->
               <ord:AddressLine2/>
               <!-Optional:->
               <ord:City/>
               <!-Optional:->
               <ord:Region>NC</ord:Region>
               <!-Optional:->
               <ord:PostalCode/>
               <!-Optional:->
               <ord:CountryCode>US</ord:CountryCode>
               <!-Optional:->
               <ord:CompanyName/>
               <!-Optional:->
               <ord:JobTitle/>
               <!-Optional:->
               <ord:Title/>
               <!-Optional:->
               <ord:FirstName>Ginette</ord:FirstName>
               <!-Optional:->
               <ord:LastName>Alpizar</ord:LastName>
               <!-Optional:->
               <ord:Suffix/>
               <!-Optional:->
               <ord:PhoneNumberDay/>
               <!-Optional:->
               <ord:PhoneNumberEvening/>
            </ord:BillingInfo>
            <!-Optional:->
            <ord:PaymentInfo>
               <!-Optional:->
               <ord:PaymentType/>
               <!-Optional:->
               <ord:CreditCardLast4/>
               <!-Optional:->
               <ord:PayPalID/>
               <!-Optional:->
               <ord:MerchantReferenceNumber/>
               <!-Optional:->
               <ord:PaymentTransactionID/>
               <!-Optional:->
               <ord:GoogleTransactionID/>
            </ord:PaymentInfo>
            <!-Optional:->
            <ord:ShoppingCart>
               <ord:CartID>0</ord:CartID>
               <ord:CheckoutSource>Demandware_Checkout</ord:CheckoutSource>
               <ord:VATTaxCalculationOption>Unspecified</ord:VATTaxCalculationOption>
               <ord:VATShippingOption>Unspecified</ord:VATShippingOption>
               <!-Optional:->
               <ord:LineItemSKUList>
                  <!-Zero or more repetitions:->
                  <ord:OrderLineItemItem>
                     <ord:LineItemType>SKU</ord:LineItemType>
                     <ord:UnitPrice>6.39</ord:UnitPrice>
                     <ord:LineItemID>0</ord:LineItemID>
                     <ord:AllowNegativeQuantity>false</ord:AllowNegativeQuantity>
                     <ord:Quantity>2</ord:Quantity>
                     <ord:ItemSaleSource>DIRECT_SALE</ord:ItemSaleSource>
                     <!-Optional:->
                     <ord:SKU>Disco Lights1</ord:SKU>
                     <!-Optional:->
                     <ord:Title>Ginette's test</ord:Title>
                     <!-Optional:->
                     <ord:BuyerUserID>ginetteb</ord:BuyerUserID>
                     <ord:BuyerFeedbackRating>0</ord:BuyerFeedbackRating>
                     <!-Optional:->
                     <ord:SalesSourceID/>
                     <ord:VATRate>0</ord:VATRate>
                  </ord:OrderLineItemItem>
               </ord:LineItemSKUList>
               <!-Optional:->
            </ord:ShoppingCart>
            <!-Optional:->
            <!-Optional:->
            <ord:ShippingInfo>
               <!-Optional:->
               <ord:AddressLine1>1078 Upchurch Farm Ln</ord:AddressLine1>
               <!-Optional:->
               <ord:AddressLine2/>
               <!-Optional:->
               <ord:City>Cary</ord:City>
               <!-Optional:->
               <ord:Region>NC</ord:Region>
               <!-Optional:->
               <ord:PostalCode>27519</ord:PostalCode>
               <!-Optional:->
               <ord:CountryCode>US</ord:CountryCode>
               <!-Optional:->
               <ord:CompanyName/>
               <!-Optional:->
               <ord:JobTitle/>
               <!-Optional:->
               <ord:Title/>
               <!-Optional:->
               <ord:FirstName>Ginette</ord:FirstName>
               <!-Optional:->
               <ord:LastName>Alpizar</ord:LastName>
               <!-Optional:->
               <ord:Suffix/>
               <!-Optional:->
               <ord:PhoneNumberDay/>
               <!-Optional:->
               <ord:PhoneNumberEvening/>
               <!-Optional:->
               <ord:ShipmentList>
                  <!-Zero or more repetitions:->
               </ord:ShipmentList>
               <!-Optional:->
               <ord:ShippingInstructions>Fragile.</ord:ShippingInstructions>
            </ord:ShippingInfo>
         </web:order>
      </web:SubmitOrder>
   </soapenv:Body>
</soapenv:Envelope>

Response

Field Name
Data Type Description
SubmitOrderResult APIResult<Int32>
This method returns a type named APIResultOfInt32. See more information on APIResult. This method will return an Order ID which is unique to this accountID in the ResultData field.

Response Example

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soap:Body>
      <SubmitOrderResponse xmlns="http://api.channeladvisor.com/webservices/">
         <SubmitOrderResult>
            <Status>Success</Status>
            <MessageCode>0</MessageCode>
            <ResultData>9179595</ResultData>
         </SubmitOrderResult>
      </SubmitOrderResponse>
   </soap:Body>
</soap:Envelope>

Response Failed Exmple

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soap:Body>
      <SubmitOrderResponse xmlns="http://api.channeladvisor.com/webservices/">
         <SubmitOrderResult>
            <Status>Failure</Status>
            <MessageCode>118</MessageCode>
            <Message>The Address should be less than 75 characters.</Message>
            <ResultData>0</ResultData>
         </SubmitOrderResult>
      </SubmitOrderResponse>
   </soap:Body>
</soap:Envelope>

References

Children   Hide Children | View in hierarchy
OrderSubmit (ChannelAdvisor Developer Network)

Powered by Atlassian Confluence, the Enterprise Wiki. (Version: 2.5.1 Build:#806 May 06, 2007) - Bug/feature request - Contact Administrators