POST api/v1/Intake

Retrieves the sales intake data for a range of dates
Can be optionally filtered for a collection of products
'NEW' new order line added, 'CANC' line cancelled, 'QCH' quantity of line changed, 'PCH' price of line only changed without qty change, 'QPCH' price and qty both changed

Request Information

URI Parameters

None.

Body Parameters

IntakeParams

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required
DateFrom	List intake on and since YYYYMMDD	string	None.
DateTo	List intake on and before YYYYMMDD	string	None.
ProductIDs	The list of product IDs you want returned, can be empty if using codes	Collection of integer	None.
ProductCodes	The list of product Codes you want returned, can be empty if using ID's	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "DateFrom": "sample string 1",
  "DateTo": "sample string 2",
  "ProductIDs": [
    1,
    2
  ],
  "ProductCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "apiKey": "sample string 1"
}

application/xml, text/xml

Sample:

<IntakeParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DateFrom>sample string 1</DateFrom>
  <DateTo>sample string 2</DateTo>
  <ProductIDs>
    <int>1</int>
    <int>2</int>
  </ProductIDs>
  <ProductCodes>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </ProductCodes>
  <apiKey>sample string 1</apiKey>
</IntakeParams>

Response Information

Resource Description

Returns:
200 OK Returns intake data as XML or JSON
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
503 Service Unavailable

IntakeData

Name	Description	Type	Additional information
IntakeList		Collection of Intake	None.

Response Formats

application/json, text/json

Sample:

{
  "IntakeList": [
    {
      "Type": "sample string 1",
      "ID": 2,
      "Code": "sample string 3",
      "TransDate": "sample string 4",
      "QtyChange": 5,
      "PriceChange": 6.0,
      "CostChange": 7.0,
      "Employee": "sample string 8"
    },
    {
      "Type": "sample string 1",
      "ID": 2,
      "Code": "sample string 3",
      "TransDate": "sample string 4",
      "QtyChange": 5,
      "PriceChange": 6.0,
      "CostChange": 7.0,
      "Employee": "sample string 8"
    }
  ]
}

application/xml, text/xml

Sample:

<IntakeData xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Intake>
    <Type>sample string 1</Type>
    <ID>2</ID>
    <Code>sample string 3</Code>
    <TransDate>sample string 4</TransDate>
    <QtyChange>5</QtyChange>
    <PriceChange>6</PriceChange>
    <CostChange>7</CostChange>
    <Employee>sample string 8</Employee>
  </Intake>
  <Intake>
    <Type>sample string 1</Type>
    <ID>2</ID>
    <Code>sample string 3</Code>
    <TransDate>sample string 4</TransDate>
    <QtyChange>5</QtyChange>
    <PriceChange>6</PriceChange>
    <CostChange>7</CostChange>
    <Employee>sample string 8</Employee>
  </Intake>
</IntakeData>