POST api/v1/WH_Shipments

Retrieve details of all shipments awaiting picking

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
IncludeDespatched		boolean	None.
IncludeCancelled		boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "apiKey": "sample string 1",
  "WarehouseID": 2,
  "IncludeDespatched": true,
  "IncludeCancelled": true
}

application/xml, text/xml

Sample:

<WH_Shipments_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>
  <IncludeDespatched>true</IncludeDespatched>
  <IncludeCancelled>true</IncludeCancelled>
</WH_Shipments_Params>

Response Information

Resource Description

Returns:
200 OK Returns a collection of shipment id's
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
204 No Content
503 Service Unavailable

WH_Shipments

Name	Description	Type	Additional information
WH_Shipment		Collection of WH_Shipment	None.

Response Formats

application/json, text/json

Sample:

{
  "WH_Shipment": [
    {
      "ShipmentID": 1
    },
    {
      "ShipmentID": 1
    }
  ]
}

application/xml, text/xml

Sample:

<WH_Shipments xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <WH_Shipment>
    <ShipmentID>1</ShipmentID>
  </WH_Shipment>
  <WH_Shipment>
    <ShipmentID>1</ShipmentID>
  </WH_Shipment>
</WH_Shipments>