POST api/v1/OrderChange

Returns a collection of orders which have been added or updated in Caliq since a supplied date
This list can then be used to request full order data

Request Information

URI Parameters

None.

Body Parameters

OrderChangeParams

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required
ChangesSince	List orders changed on and since YYYYMMDD. If supplied empty then only todays changes will be returned	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ChangesSince": "sample string 1",
  "apiKey": "sample string 1"
}

application/xml, text/xml

Sample:

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

Response Information

Resource Description

Returns:
200 OK Returns collection of order id's and order numbers
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
204 No Content if no customers were updated or added since the date supplied 503 Service Unavailable

OrderChanges

Name	Description	Type	Additional information
OrderChangeList		Collection of ChangedOrder	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderChangeList": [
    {
      "EventID": 1,
      "OrderNo": 2,
      "WebOrderRef": "sample string 3",
      "Status": "sample string 4"
    },
    {
      "EventID": 1,
      "OrderNo": 2,
      "WebOrderRef": "sample string 3",
      "Status": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<OrderChanges xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ChangedOrder>
    <EventID>1</EventID>
    <OrderNo>2</OrderNo>
    <WebOrderRef>sample string 3</WebOrderRef>
    <Status>sample string 4</Status>
  </ChangedOrder>
  <ChangedOrder>
    <EventID>1</EventID>
    <OrderNo>2</OrderNo>
    <WebOrderRef>sample string 3</WebOrderRef>
    <Status>sample string 4</Status>
  </ChangedOrder>
</OrderChanges>