POST api/v1/WH_Shipment_Route

Route a shipment

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required
ShipmentID	Caliq unique shipment identifier	integer	Required
RouteID		integer	Required

Request Formats

application/json, text/json

Sample:

{
  "apiKey": "sample string 1",
  "ShipmentID": 2,
  "RouteID": 3
}

application/xml, text/xml

Sample:

<WH_Shipment_Route_Params xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <apiKey>sample string 1</apiKey>
  <ShipmentID>2</ShipmentID>
  <RouteID>3</RouteID>
</WH_Shipment_Route_Params>

Response Information

Resource Description

Returns:
200 OK Deliverable ID is returned
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
503 Service Unavailable

WH_Shipment_Route_Results

Name	Description	Type	Additional information
OK		boolean	None.
WH_Shipment_Route_Results_Issues		Collection of WH_Shipment_Route_Results_Issue	None.

Response Formats

application/json, text/json

Sample:

{
  "OK": true,
  "WH_Shipment_Route_Results_Issues": [
    {
      "ID": 1,
      "Message": "sample string 2",
      "ExtraData": "sample string 3"
    },
    {
      "ID": 1,
      "Message": "sample string 2",
      "ExtraData": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

<WH_Shipment_Route_Results xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OK>true</OK>
  <WH_Shipment_Route_Results_Issues>
    <WH_Shipment_Route_Results_Issue>
      <ID>1</ID>
      <Message>sample string 2</Message>
      <ExtraData>sample string 3</ExtraData>
    </WH_Shipment_Route_Results_Issue>
    <WH_Shipment_Route_Results_Issue>
      <ID>1</ID>
      <Message>sample string 2</Message>
      <ExtraData>sample string 3</ExtraData>
    </WH_Shipment_Route_Results_Issue>
  </WH_Shipment_Route_Results_Issues>
</WH_Shipment_Route_Results>