POST api/v1/DespatchMethod

Retrieve the list of despatch methods.
A despatch method is an attribute of an order and tells Caliq how to goods should be sent to the customer
The despatch method is an optional field when creating an order

Request Information

URI Parameters

None.

Body Parameters

Params
NameDescriptionTypeAdditional information
apiKey

Please contact Caliq support to get your key

string

Required

Max length: 30

Request Formats

application/json, text/json

Sample: 
{
  "apiKey": "sample string 1"
}

application/xml, text/xml

Sample: 
<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 supported despatch methods 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

DespatchMethods
NameDescriptionTypeAdditional information
DespatchMethodList

Collection of DespatchMethod

None.

Response Formats

application/json, text/json

Sample: 
{
  "DespatchMethodList": [
    {
      "ID": 1,
      "Description": "sample string 2",
      "ServiceLevelID": 1,
      "CanTakePallets": true,
      "CustomerCollection": true
    },
    {
      "ID": 1,
      "Description": "sample string 2",
      "ServiceLevelID": 1,
      "CanTakePallets": true,
      "CustomerCollection": true
    }
  ]
}

application/xml, text/xml

Sample: 
<DespatchMethods xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Method>
    <ID>1</ID>
    <Description>sample string 2</Description>
    <ServiceLevelID>1</ServiceLevelID>
    <CanTakePallets>true</CanTakePallets>
    <CustomerCollection>true</CustomerCollection>
  </Method>
  <Method>
    <ID>1</ID>
    <Description>sample string 2</Description>
    <ServiceLevelID>1</ServiceLevelID>
    <CanTakePallets>true</CanTakePallets>
    <CustomerCollection>true</CustomerCollection>
  </Method>
</DespatchMethods>