POST api/v1/ServiceLevel

Retrieve the list of despatch service levels.
It may be desirable to tell Caliq than an order needs to be despatched to the customer via a certain service rather than a specifc despatch method
Typcically service levels might be 'Next Day', 'Saturday AM', 'Named Day' and specify the service required rather than an actual carrier
The service level is an optional field when creating an order

Request Information

URI Parameters

None.

Body Parameters

Request Formats

{
  "apiKey": "sample string 1"
}

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

Response Information

Resource Description

Returns:
200 OK Returns a list of active service levels as XML or JSON
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
204 No Content if there are no matching records in Caliq
503 Service Unavailable

Response Formats

{
  "ServiceLevelList": [
    {
      "ID": 64,
      "Description": "sample string 2"
    },
    {
      "ID": 64,
      "Description": "sample string 2"
    }
  ]
}

<ServiceLevels xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Level>
    <ID>64</ID>
    <Description>sample string 2</Description>
  </Level>
  <Level>
    <ID>64</ID>
    <Description>sample string 2</Description>
  </Level>
</ServiceLevels>