POST api/v1/ProductChange

Returns a collection of products which have been added or updated in Caliq since a supplied date
This list can then be used to request full product data
NOTE: Changes to prices or stock levels do NOT count as a product change
and should be refreshed fully each time

Request Information

URI Parameters

None.

Body Parameters

ProductChangeParams
NameDescriptionTypeAdditional information
apiKey

Please contact Caliq support to get your key

string

Required

ChangesSince

List products changed on and since YYYYMMDD. If supplied empty then all products 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:
<ProductChangeParams 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>
</ProductChangeParams>

Response Information

Resource Description

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

ProductChanges
NameDescriptionTypeAdditional information
ProductChangeList

Collection of ProductsChangeProduct

None.

Response Formats

application/json, text/json

Sample:
{
  "ProductChangeList": [
    {
      "ID": 1,
      "Code": "sample string 2"
    },
    {
      "ID": 1,
      "Code": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<ProductChanges xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Product>
    <ID>1</ID>
    <Code>sample string 2</Code>
  </Product>
  <Product>
    <ID>1</ID>
    <Code>sample string 2</Code>
  </Product>
</ProductChanges>