POST api/v1/WH_Load

Load a line from a picking note

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
ShipmentLineID	Caliq unique shipment line identifier	integer	Required
DeliverableID		integer	Required
BinNo		string	Required
Qty		decimal number	Required

Request Formats

application/json, text/json

Sample:

{
  "apiKey": "sample string 1",
  "WarehouseID": 2,
  "EmployeeID": "sample string 3",
  "ShipmentID": 4,
  "ShipmentLineID": 5,
  "DeliverableID": 6,
  "BinNo": "sample string 7",
  "Qty": 8.0
}

application/xml, text/xml

Sample:

<WH_Load_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>
  <ShipmentLineID>5</ShipmentLineID>
  <DeliverableID>6</DeliverableID>
  <BinNo>sample string 7</BinNo>
  <Qty>8</Qty>
</WH_Load_Params>

Response Information

Resource Description

Returns:
200 OK Load was applied correctly
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,77,78,85,86,87,88,91

WH_Load_Results

Name	Type	Additional information
OK	boolean	None.
Message	string	None.
WH_Load_Results_Issues	Collection of WH_Load_Results_Issue	None.

Response Formats

application/json, text/json

Sample:

{
  "OK": true,
  "Message": "sample string 2",
  "WH_Load_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_Load_Results xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OK>true</OK>
  <Message>sample string 2</Message>
  <WH_Load_Results_Issues>
    <WH_Load_Results_Issue>
      <ID>1</ID>
      <Message>sample string 2</Message>
      <ExtraData>sample string 3</ExtraData>
    </WH_Load_Results_Issue>
    <WH_Load_Results_Issue>
      <ID>1</ID>
      <Message>sample string 2</Message>
      <ExtraData>sample string 3</ExtraData>
    </WH_Load_Results_Issue>
  </WH_Load_Results_Issues>
</WH_Load_Results>