POST api/v1/CustomersWithOrders

Retrieve a list of customers who have a back order of some sort

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required
ChannelID	List of channels can be retrieved via API	integer	Required

Request Formats

application/json, text/json

Sample:

{
  "apiKey": "sample string 1",
  "ChannelID": 2
}

application/xml, text/xml

Sample:

<CustomersWithOrdersParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <apiKey>sample string 1</apiKey>
  <ChannelID>2</ChannelID>
</CustomersWithOrdersParams>

Response Information

Resource Description

Returns:
200 OK Returns a collection of customers and order count
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
204 No Content if the requested filters dont match any data 503 Service Unavailable

CustomersWithOrders

Name	Description	Type	Additional information
CustomerWithOrderList		Collection of CustomerWithOrder	None.

Response Formats

application/json, text/json

Sample:

{
  "CustomerWithOrderList": [
    {
      "ID": 1,
      "AccountNo": "sample string 2",
      "Name": "sample string 3",
      "OrderCount": 4,
      "OSValue": 5.0
    },
    {
      "ID": 1,
      "AccountNo": "sample string 2",
      "Name": "sample string 3",
      "OrderCount": 4,
      "OSValue": 5.0
    }
  ]
}

application/xml, text/xml

Sample:

<CustomersWithOrders xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CustomerWithOrder>
    <ID>1</ID>
    <AccountNo>sample string 2</AccountNo>
    <Name>sample string 3</Name>
    <OrderCount>4</OrderCount>
    <OSValue>5</OSValue>
  </CustomerWithOrder>
  <CustomerWithOrder>
    <ID>1</ID>
    <AccountNo>sample string 2</AccountNo>
    <Name>sample string 3</Name>
    <OrderCount>4</OrderCount>
    <OSValue>5</OSValue>
  </CustomerWithOrder>
</CustomersWithOrders>