POST api/v1/WH_Deliverable_Get

Query details for a deliverable

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
DeliverableID		integer	Required

Request Formats

application/json, text/json

Sample:

{
  "apiKey": "sample string 1",
  "WarehouseID": 2,
  "DeliverableID": 3
}

application/xml, text/xml

Sample:

<WH_Deliverable_Get_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>
  <DeliverableID>3</DeliverableID>
</WH_Deliverable_Get_Params>

Response Information

Resource Description

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

WH_Deliverable_Get_Results

Name	Type	Additional information
CreatedOn	date	None.
LastUpdated	date	None.
HandlingArea	integer	None.
HandlingAreaDescription	string	None.
WH_Deliverable_Get_Shipments	Collection of WH_Deliverable_Get_Shipment	None.

Response Formats

application/json, text/json

Sample:

{
  "CreatedOn": "2025-01-15T05:55:10.4401439+00:00",
  "LastUpdated": "2025-01-15T05:55:10.4401439+00:00",
  "HandlingArea": 1,
  "HandlingAreaDescription": "sample string 3",
  "WH_Deliverable_Get_Shipments": [
    {
      "ShipmentID": 1
    },
    {
      "ShipmentID": 1
    }
  ]
}

application/xml, text/xml

Sample:

<WH_Deliverable xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CreatedOn>2025-01-15T05:55:10.4401439+00:00</CreatedOn>
  <LastUpdated>2025-01-15T05:55:10.4401439+00:00</LastUpdated>
  <HandlingArea>1</HandlingArea>
  <HandlingAreaDescription>sample string 3</HandlingAreaDescription>
  <WH_Deliverable_Get_Shipments>
    <WH_Deliverable_Get_Shipment>
      <ShipmentID>1</ShipmentID>
    </WH_Deliverable_Get_Shipment>
    <WH_Deliverable_Get_Shipment>
      <ShipmentID>1</ShipmentID>
    </WH_Deliverable_Get_Shipment>
  </WH_Deliverable_Get_Shipments>
</WH_Deliverable>