Dashboard > ChannelAdvisor Developer Network > ... > Order Service > GetOrderList
Log In   View a printable version of the current page.
Added by Rick Watson, last edited by Rick Watson on Oct 20, 2008  (view change)
Labels: 
(None)


Overview

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

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.

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

<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>Medium</ord:DetailLevel>
      <ord:OrderCreationFilterBeginTimeGMT>2001-08-12T15:11:43</ord:OrderCreationFilterBeginTimeGMT>
      <ord:OrderCreationFilterEndTimeGMT>2007-08-12T15:11:43</ord:OrderCreationFilterEndTimeGMT>
      <ord:StatusUpdateFilterBeginTimeGMT>2001-08-12T15:11:43</ord:StatusUpdateFilterBeginTimeGMT>
      <ord:StatusUpdateFilterEndTimeGMT>2007-08-12T15:11:43</ord:StatusUpdateFilterEndTimeGMT>
      <ord:OrderIDList>
         <ord:int>4839705</ord:int>
         <ord:int>4839706</ord:int>
      </ord:OrderIDList>
      <ord:OrderStateFilter>Active</ord:OrderStateFilter>
      <ord:PaymentStatusFilter>NoChange</ord:PaymentStatusFilter>
      <ord:CheckoutStatusFilter>NoChange</ord:CheckoutStatusFilter>
      <ord:ShippingStatusFilter>NoChange</ord:ShippingStatusFilter>
      <ord:PageNumberFilter>1</ord:PageNumberFilter>
      <ord:PageSize>10</ord:PageSize>
      </web:orderCriteria>
   </web:GetOrderList>
</soapenv:Body>
</soapenv:Envelope>

References

Children   Hide Children | View in hierarchy
GetOrderList by ExportedState (ChannelAdvisor Developer Network)
OrderCriteria (ChannelAdvisor Developer Network)
OrderResponseItem (ChannelAdvisor Developer Network)

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