POST api/v1/WH_LoadStart

Mark a shipment as started loading

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
apiKey	Please contact Caliq support to get your key	string	Required
WarehouseID		integer	Required
EmployeeID		string	Required Max length: 10
ShipmentID	Caliq unique shipment identifier	integer	Required

Request Formats

application/json, text/json

Sample:

{
  "apiKey": "sample string 1",
  "WarehouseID": 2,
  "EmployeeID": "sample string 3",
  "ShipmentID": 4
}

application/xml, text/xml

Sample:

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

Response Information

Resource Description

Returns:
200 OK
204 Shipments cannot be found
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
503 Service Unavailable
Messages returned for error: 73,78,85,86

WH_LoadStart_Results

Name	Description	Type	Additional information
OK		boolean	None.
WH_LoadStart_Results_Issues		Collection of WH_LoadStart_Results_Issue	None.

Response Formats

application/json, text/json

Sample:

{
  "OK": true,
  "WH_LoadStart_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_LoadStart_Results xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OK>true</OK>
  <WH_LoadStart_Results_Issues>
    <WH_LoadStart_Results_Issue>
      <ID>1</ID>
      <Message>sample string 2</Message>
      <ExtraData>sample string 3</ExtraData>
    </WH_LoadStart_Results_Issue>
    <WH_LoadStart_Results_Issue>
      <ID>1</ID>
      <Message>sample string 2</Message>
      <ExtraData>sample string 3</ExtraData>
    </WH_LoadStart_Results_Issue>
  </WH_LoadStart_Results_Issues>
</WH_LoadStart_Results>