GetOrderList

Overview

Retrieve a set of orders based on the criteria sent by the caller.  See a C# sample (Application Example - GetOrderList by ExportState)

Please note: It is not possible to retrieve the full credit card number through the API.

Request

Field Name

Data Type

Description

accountID

string

A unique identifier representing the ChannelAdvisor account you wish to access.

orderCriteria

OrderCriteria

An object describing the orders to retrieve. This object is required to retrieve orders, but OrderCriteria fields can be omitted.

Response

Field Name

Data Type

Description

GetOrderListResult

APIResult<OrderResponseItem[]>

This method returns a type named APIResultOfArrayOfOrderResponseItem. See more information on APIResult. The array of order information returned by this method will be contained in the ResultData field.

Sample XML Request and Response

See more GetOrderList XML Samples by marketplace.

<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>
   <web:DeveloperKey>11111111-1111-1111-1111-999999999999</web:DeveloperKey>
   <web:Password>mypassword</web:Password>
   </web:APICredentials>
</soapenv:Header>
<soapenv:Body>
   <web:GetOrderList>
      <web:accountID>e83a0b1e-75f7-41e3-8aac-d8ff01f9d1ea</web:accountID>
      <web:orderCriteria>
      <ord:DetailLevel>Complete</ord:DetailLevel>
      <ord:StatusUpdateFilterBeginTimeGMT>2012-03-11T15:11:43</ord:StatusUpdateFilterBeginTimeGMT>
      <ord:StatusUpdateFilterEndTimeGMT>2012-03-12T15:11:43</ord:StatusUpdateFilterEndTimeGMT>
      <ord:OrderStateFilter>Active</ord:OrderStateFilter>
      <ord:PaymentStatusFilter>Cleared</ord:PaymentStatusFilter>
      <ord:CheckoutStatusFilter>Completed</ord:CheckoutStatusFilter>
      <ord:ShippingStatusFilter>Unshipped</ord:ShippingStatusFilter>
      <ord:PageNumberFilter>1</ord:PageNumberFilter>
      <ord:PageSize>1</ord:PageSize>
      </web:orderCriteria>
   </web:GetOrderList>
</soapenv:Body>
</soapenv:Envelope>


<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <GetOrderListResponse xmlns="http://api.channeladvisor.com/webservices/">
         <GetOrderListResult>
            <Status>Success</Status>
            <MessageCode>0</MessageCode>
            <ResultData>
               <OrderResponseItem xsi:type="q1:OrderResponseDetailComplete" xmlns:q1="http://api.channeladvisor.com/datacontracts/orders">
                  <q1:NumberOfMatches>12</q1:NumberOfMatches>
                  <q1:OrderTimeGMT>2012-03-11T10:11:43</q1:OrderTimeGMT>
                  <q1:LastUpdateDate>2012-03-11T19:53:20</q1:LastUpdateDate>
                  <q1:TotalOrderAmount>23.6600</q1:TotalOrderAmount>
                  <q1:OrderState>Active</q1:OrderState>
                  <q1:DateCancelledGMT xsi:nil="true"/>
                  <q1:OrderID>4839705</q1:OrderID>
                  <q1:ClientOrderIdentifier>S-5378053</q1:ClientOrderIdentifier>
                  <q1:SellerOrderID/>
                  <q1:OrderStatus>
                     <q1:CheckoutStatus>Completed</q1:CheckoutStatus>
                     <q1:CheckoutDateGMT>2012-03-11T18:53:20</q1:CheckoutDateGMT>
                     <q1:PaymentStatus></q1:PaymentStatus>
                     <q1:PaymentDateGMT>2012-03-11T19:53:20</q1:PaymentDateGMT>
                     <q1:ShippingStatus>Unshipped</q1:ShippingStatus>
                     <q1:ShippingDateGMT>1900-01-01T00:00:00</q1:ShippingDateGMT>
                     <q1:OrderRefundStatus>NoRefunds</q1:OrderRefundStatus>
                  </q1:OrderStatus>
                  <q1:ResellerID/>
                  <q1:BuyerEmailAddress>email@domain.com</q1:BuyerEmailAddress>
                  <q1:EmailOptIn>false</q1:EmailOptIn>
                  <q1:PaymentInfo>
                     <q1:PaymentType>PayPal</q1:PaymentType>
                     <q1:CreditCardLast4>0000</q1:CreditCardLast4>
                     <q1:PayPalID>email@domain.com</q1:PayPalID>
                     <q1:MerchantReferenceNumber>0000000000000000000</q1:MerchantReferenceNumber>
                     <q1:PaymentTransactionID>0000000000000000000</q1:PaymentTransactionID>
                  </q1:PaymentInfo>
                  <q1:ShippingInfo>
                     <q1:AddressLine1>123 Street Name</q1:AddressLine1>
                     <q1:AddressLine2/>
                     <q1:City>St. Paul</q1:City>
                     <q1:Region>MN</q1:Region>
                     <q1:RegionDescription>Minnesota</q1:RegionDescription>
                     <q1:PostalCode>55119</q1:PostalCode>
                     <q1:CountryCode>US</q1:CountryCode>
                     <q1:CompanyName/>
                     <q1:JobTitle/>
                     <q1:Title/>
                     <q1:FirstName>John</q1:FirstName>
                     <q1:LastName>Doe</q1:LastName>
                     <q1:Suffix/>
                     <q1:PhoneNumberDay/>
                     <q1:PhoneNumberEvening/>
                     <q1:ShipmentList>
                        <q1:Shipment>
                           <q1:ShippingCarrier>UPS</q1:ShippingCarrier>
                           <q1:ShippingClass>GROUND</q1:ShippingClass>
                           <q1:TrackingNumber/>
                        </q1:Shipment>
                     </q1:ShipmentList>
                     <q1:ShippingInstructions/>
                     <q1:EstimatedShipDate xsi:nil="true">
                     <q1:DeliveryDate xsi:nill="true">
                  </q1:ShippingInfo>
                  <q1:BillingInfo>
                     <q1:AddressLine1>123 Street Name</q1:AddressLine1>
                     <q1:AddressLine2/>
                     <q1:City>St. Paul</q1:City>
                     <q1:Region>MN</q1:Region>
                     <q1:RegionDescription>Minnesota</q1:RegionDescription>
                     <q1:PostalCode>55106</q1:PostalCode>
                     <q1:CountryCode>US</q1:CountryCode>
                     <q1:CompanyName/>
                     <q1:JobTitle/>
                     <q1:Title/>
                     <q1:FirstName>John</q1:FirstName>
                     <q1:LastName>Doe</q1:LastName>
                     <q1:Suffix/>
                     <q1:PhoneNumberDay/>
                     <q1:PhoneNumberEvening/>
                  </q1:BillingInfo>
                  <q1:FlagDescription/>
                  <q1:ShoppingCart>
                     <q1:CartID>4839705</q1:CartID>
                     <q1:CheckoutSource>PayPal</q1:CheckoutSource>
                     <q1:VATTaxCalculationOption>Unspecified</q1:VATTaxCalculationOption>
                     <q1:VATShippingOption>Unspecified</q1:VATShippingOption>
                     <q1:VATGiftWrapOption>Unspecified</q1:VATGiftWrapOption>
                     <q1:LineItemSKUList>
                        <q1:OrderLineItemItem xsi:type="q1:OrderLineItemItemResponse">
                           <q1:LineItemType>SKU</q1:LineItemType>
                           <q1:UnitPrice>7.9900</q1:UnitPrice>
                           <q1:LineItemID>17204403</q1:LineItemID>
                           <q1:AllowNegativeQuantity>false</q1:AllowNegativeQuantity>
                           <q1:Quantity>1</q1:Quantity>
                           <q1:ItemSaleSource>DIRECT_SALE</q1:ItemSaleSource>
                           <q1:SKU>Sku1</q1:SKU>
                           <q1:Title>SKU 1</q1:Title>
                           <q1:BuyerUserID>john.doe</q1:BuyerUserID>
                           <q1:BuyerFeedbackRating>0</q1:BuyerFeedbackRating>
                           <q1:SalesSourceID>12345</q1:SalesSourceID>
                           <q1:VATRate>0</q1:VATRate>
                           <q1:TaxCost>1.0000</q1:TaxCost>
                           <q1:ShippingCost>3.8400</q1:ShippingCost>
                           <q1:ShippingTaxCost>1.0000</q1:ShippingTaxCost>
                           <q1:GiftWrapCost>0.0000</q1:GiftWrapCost>
                           <q1:GiftWrapTaxCost>0.0000</q1:GiftWrapTaxCost>
                           <q1:GiftMessage/>
                           <q1:GiftWrapLevel/>
                           <q1:RecyclingFee>0.0000</q1:RecyclingFee>
                           <q1:ItemPromoList>
                              <q1:OrderLineItemItemPromo>
                                 <q1:LineItemType>Promotion</q1:LineItemType>
                                 <q1:UnitPrice>-2</q1:UnitPrice>
                                 <q1:PromoCode>promo</q1:PromoCode>
                                 <q1:ShippingPrice>-2</q1:ShippingPrice>
                              </q1:OrderLineItemItemPromo>
                           </q1:ItemPromoList>
                           <q1:UnitWeight UnitOfMeasure="LB">5</q1:UnitWeight>
                           <q1:WarehouseLocation>1234</q1:WarehouseLocation>
                           <q1:UserName/>
                           <q1:DistributionCenterCode>Chicago</q1:DistributionCenterCode>
                           <q1:IsExternallyFulfilled>false</q1:IsExternallyFulfilled>
                        </q1:OrderLineItemItem>
                        <q1:OrderLineItemItem xsi:type="q1:OrderLineItemItemResponse">
                           <q1:LineItemType>SKU</q1:LineItemType>
                           <q1:UnitPrice>7.9900</q1:UnitPrice>
                           <q1:LineItemID>17204404</q1:LineItemID>
                           <q1:AllowNegativeQuantity>false</q1:AllowNegativeQuantity>
                           <q1:Quantity>1</q1:Quantity>
                           <q1:ItemSaleSource>DIRECT_SALE</q1:ItemSaleSource>
                           <q1:SKU>Sku2</q1:SKU>
                           <q1:Title>SKU 2</q1:Title>
                           <q1:BuyerUserID>john.doe</q1:BuyerUserID>
                           <q1:BuyerFeedbackRating>0</q1:BuyerFeedbackRating>
                           <q1:SalesSourceID>12346</q1:SalesSourceID>
                           <q1:VATRate>0</q1:VATRate>
                           <q1:TaxCost>1.0000</q1:TaxCost>
                           <q1:ShippingCost>3.8400</q1:ShippingCost>
                           <q1:ShippingTaxCost>1.0000</q1:ShippingTaxCost>
                           <q1:GiftWrapCost>0.0000</q1:GiftWrapCost>
                           <q1:GiftWrapTaxCost>0.0000</q1:GiftWrapTaxCost>
                           <q1:GiftMessage/>
                           <q1:GiftWrapLevel/>
                           <q1:RecyclingFee>0.0000</q1:RecyclingFee>
                           <q1:UnitWeight UnitOfMeasure="LB">1</q1:UnitWeight>
                           <q1:WarehouseLocation>Morrisville</q1:WarehouseLocation>
                           <q1:UserName/>
                           <q1:DistributionCenterCode>Chicago</q1:DistributionCenterCode>
                           <q1:IsExternallyFulfilled>false</q1:IsExternallyFulfilled>
                        </q1:OrderLineItemItem>
                     </q1:LineItemSKUList>
                     <q1:LineItemInvoiceList>
                        <q1:OrderLineItemInvoice>
                           <q1:LineItemType>SalesTax</q1:LineItemType>
                           <q1:UnitPrice>4.0000</q1:UnitPrice>
                        </q1:OrderLineItemInvoice>
                        <q1:OrderLineItemInvoice>
                           <q1:LineItemType>Shipping</q1:LineItemType>
                           <q1:UnitPrice>7.6800</q1:UnitPrice>
                        </q1:OrderLineItemInvoice>
                        <q1:OrderLineItemInvoice>
                           <q1:LineItemType>ShippingInsurance</q1:LineItemType>
                           <q1:UnitPrice>0.0000</q1:UnitPrice>
                        </q1:OrderLineItemInvoice>
                        <q1:OrderLineItemInvoice>
                           <q1:LineItemType>VATShipping</q1:LineItemType>
                           <q1:UnitPrice>0.0000</q1:UnitPrice>
                        </q1:OrderLineItemInvoice>
                        <q1:OrderLineItemInvoice>
                           <q1:LineItemType>GiftWrap</q1:LineItemType>
                           <q1:UnitPrice>0.0000</q1:UnitPrice>
                        </q1:OrderLineItemInvoice>
                        <q1:OrderLineItemInvoice>
                           <q1:LineItemType>VATGiftWrap</q1:LineItemType>
                           <q1:UnitPrice>0.0000</q1:UnitPrice>
                        </q1:OrderLineItemInvoice>
                        <q1:OrderLineItemInvoice>
                           <q1:LineItemType>RecyclingFee</q1:LineItemType>
                           <q1:UnitPrice>0.0000</q1:UnitPrice>
                        </q1:OrderLineItemInvoice>
                     </q1:LineItemInvoiceList>
                     <q1:LineItemPromoList>
                        <q1:OrderLineItemPromo>
                           <q1:LineItemType>Promotion</q1:LineItemType>
                           <q1:UnitPrice>0.0000</q1:UnitPrice>
                           <q1:PromoCode/>
                        </q1:OrderLineItemPromo>
                     </q1:LineItemPromoList>
                  </q1:ShoppingCart>
                  <q1:CustomValueList/>
                  <q1:BuyerIpAddress/>
                  <q1:TransactionNotes/>
               </OrderResponseItem>
            </ResultData>
         </GetOrderListResult>
      </GetOrderListResponse>
   </soap:Body>
</soap:Envelope>

References