POST api/v1/OrderLinesForCustomer

Retrieve the list of outstanding order lines for a specific customer
You can send either account number or customer ID dending on what you have stored

Request Information

URI Parameters

None.

Body Parameters

OrderLinesForCustomerParams

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required
AccountNo	Customer account number to returns orders for	string	None.
CustomerID	Customer ID to returns orders for	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "AccountNo": "sample string 1",
  "CustomerID": 2,
  "apiKey": "sample string 1"
}

application/xml, text/xml

Sample:

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

Response Information

Resource Description

Returns:
200 OK Returns a collection of outstanding order lines
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

OSOrderLines

Name	Description	Type	Additional information
OSOrderLineList		Collection of OSOrderLine	None.

Response Formats

application/json, text/json

Sample:

{
  "OSOrderLineList": [
    {
      "OrderID": 1,
      "OrderNo": 2,
      "WebOrderRef": "sample string 3",
      "ID": 4,
      "Code": "sample string 5",
      "Description": "sample string 6",
      "Qty": 7,
      "QtyAllocated": 8,
      "QtyDespatched": 9,
      "QtyInWarehouse": 10,
      "QtyInvoiced": 11,
      "QtyProcessed": 12,
      "Status": "sample string 13",
      "Value": 14.0,
      "RequiredDate": "sample string 15",
      "EstimatedDate": "sample string 16",
      "EstimatedText": "sample string 17"
    },
    {
      "OrderID": 1,
      "OrderNo": 2,
      "WebOrderRef": "sample string 3",
      "ID": 4,
      "Code": "sample string 5",
      "Description": "sample string 6",
      "Qty": 7,
      "QtyAllocated": 8,
      "QtyDespatched": 9,
      "QtyInWarehouse": 10,
      "QtyInvoiced": 11,
      "QtyProcessed": 12,
      "Status": "sample string 13",
      "Value": 14.0,
      "RequiredDate": "sample string 15",
      "EstimatedDate": "sample string 16",
      "EstimatedText": "sample string 17"
    }
  ]
}

application/xml, text/xml

Sample:

<OSOrderLines xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OSOrderLine>
    <OrderID>1</OrderID>
    <OrderNo>2</OrderNo>
    <WebOrderRef>sample string 3</WebOrderRef>
    <ID>4</ID>
    <Code>sample string 5</Code>
    <Description>sample string 6</Description>
    <Qty>7</Qty>
    <QtyAllocated>8</QtyAllocated>
    <QtyDespatched>9</QtyDespatched>
    <QtyInWarehouse>10</QtyInWarehouse>
    <QtyInvoiced>11</QtyInvoiced>
    <QtyProcessed>12</QtyProcessed>
    <Status>sample string 13</Status>
    <Value>14</Value>
    <RequiredDate>sample string 15</RequiredDate>
    <EstimatedDate>sample string 16</EstimatedDate>
    <EstimatedText>sample string 17</EstimatedText>
  </OSOrderLine>
  <OSOrderLine>
    <OrderID>1</OrderID>
    <OrderNo>2</OrderNo>
    <WebOrderRef>sample string 3</WebOrderRef>
    <ID>4</ID>
    <Code>sample string 5</Code>
    <Description>sample string 6</Description>
    <Qty>7</Qty>
    <QtyAllocated>8</QtyAllocated>
    <QtyDespatched>9</QtyDespatched>
    <QtyInWarehouse>10</QtyInWarehouse>
    <QtyInvoiced>11</QtyInvoiced>
    <QtyProcessed>12</QtyProcessed>
    <Status>sample string 13</Status>
    <Value>14</Value>
    <RequiredDate>sample string 15</RequiredDate>
    <EstimatedDate>sample string 16</EstimatedDate>
    <EstimatedText>sample string 17</EstimatedText>
  </OSOrderLine>
</OSOrderLines>