POST api/v1/WH_Shipments_Detail

Retrieve full details of selected shipments

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
WH_ShipmentsToGet		Collection of WH_ShipmentToGet	None.

Request Formats

application/json, text/json

Sample:

{
  "apiKey": "sample string 1",
  "WarehouseID": 2,
  "WH_ShipmentsToGet": [
    {
      "ShipmentID": 1
    },
    {
      "ShipmentID": 1
    }
  ]
}

application/xml, text/xml

Sample:

<WH_Shipments_Detail_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>
  <WH_ShipmentsToGet>
    <WH_ShipmentToGet>
      <ShipmentID>1</ShipmentID>
    </WH_ShipmentToGet>
    <WH_ShipmentToGet>
      <ShipmentID>1</ShipmentID>
    </WH_ShipmentToGet>
  </WH_ShipmentsToGet>
</WH_Shipments_Detail_Params>

Response Information

Resource Description

Returns:
200 OK Returns a collection of shipment dataa
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_Detail

Name	Description	Type	Additional information
WH_Shipment_Detail		Collection of WH_Shipment_Detail	None.

Response Formats

application/json, text/json

Sample:

{
  "WH_Shipment_Detail": [
    {
      "ShipmentID": 1,
      "OrderNo": 2,
      "OrderDate": "2025-01-15T05:39:02.1276081+00:00",
      "Priority": "sample string 4",
      "Notes": "sample string 5",
      "IsCancelled": true,
      "Release": {
        "ReleasedBy": "sample string 1",
        "ReleasedByName": "sample string 2",
        "ReleasedDate": "2025-01-15T05:39:02.1276081+00:00"
      },
      "Routing": {
        "IsRouted": true,
        "RouteID": 1
      },
      "Picking": {
        "NeedsPicking": true,
        "PickingBay": "sample string 2",
        "AssignedTo": "sample string 3",
        "AssignedToName": "sample string 4",
        "Started": "2025-01-15T05:39:02.1276081+00:00",
        "Ended": "2025-01-15T05:39:02.1276081+00:00",
        "PickingComplete": true
      },
      "Loading": {
        "NeedsLoading": true,
        "LoadingBay": "sample string 2",
        "AssignedTo": "sample string 3",
        "AssignedToName": "sample string 4",
        "Started": "2025-01-15T05:39:02.1276081+00:00",
        "Ended": "2025-01-15T05:39:02.1276081+00:00",
        "LoadingComplete": true
      },
      "WHShipmentAwaitingPicking_Deliverables": [
        {
          "DeliverableID": 1,
          "HandlingArea": "sample string 2"
        },
        {
          "DeliverableID": 1,
          "HandlingArea": "sample string 2"
        }
      ],
      "Recipient": {
        "DeliveryAreaCode": "sample string 1",
        "DeliveryArea": "sample string 2",
        "Company": "sample string 3",
        "Firstname": "sample string 4",
        "Lastname": "sample string 5",
        "Address_line_1": "sample string 6",
        "Address_line_2": "sample string 7",
        "Address_line_3": "sample string 8",
        "City": "sample string 9",
        "County": "sample string 10",
        "Postcode": "sample string 11",
        "Country": "sample string 12",
        "Email": "sample string 13",
        "Telephone": "sample string 14",
        "Mobile": "sample string 15",
        "Latitude": "sample string 16",
        "Longitude": "sample string 17"
      },
      "WH_Shipment_Lines": [
        {
          "PartNo": "sample string 1",
          "Description": "sample string 2",
          "HandlingType": "sample string 3",
          "Qty": 4.0,
          "QtyPicked": 5.0,
          "ShipmentLineID": 6
        },
        {
          "PartNo": "sample string 1",
          "Description": "sample string 2",
          "HandlingType": "sample string 3",
          "Qty": 4.0,
          "QtyPicked": 5.0,
          "ShipmentLineID": 6
        }
      ]
    },
    {
      "ShipmentID": 1,
      "OrderNo": 2,
      "OrderDate": "2025-01-15T05:39:02.1276081+00:00",
      "Priority": "sample string 4",
      "Notes": "sample string 5",
      "IsCancelled": true,
      "Release": {
        "ReleasedBy": "sample string 1",
        "ReleasedByName": "sample string 2",
        "ReleasedDate": "2025-01-15T05:39:02.1276081+00:00"
      },
      "Routing": {
        "IsRouted": true,
        "RouteID": 1
      },
      "Picking": {
        "NeedsPicking": true,
        "PickingBay": "sample string 2",
        "AssignedTo": "sample string 3",
        "AssignedToName": "sample string 4",
        "Started": "2025-01-15T05:39:02.1276081+00:00",
        "Ended": "2025-01-15T05:39:02.1276081+00:00",
        "PickingComplete": true
      },
      "Loading": {
        "NeedsLoading": true,
        "LoadingBay": "sample string 2",
        "AssignedTo": "sample string 3",
        "AssignedToName": "sample string 4",
        "Started": "2025-01-15T05:39:02.1276081+00:00",
        "Ended": "2025-01-15T05:39:02.1276081+00:00",
        "LoadingComplete": true
      },
      "WHShipmentAwaitingPicking_Deliverables": [
        {
          "DeliverableID": 1,
          "HandlingArea": "sample string 2"
        },
        {
          "DeliverableID": 1,
          "HandlingArea": "sample string 2"
        }
      ],
      "Recipient": {
        "DeliveryAreaCode": "sample string 1",
        "DeliveryArea": "sample string 2",
        "Company": "sample string 3",
        "Firstname": "sample string 4",
        "Lastname": "sample string 5",
        "Address_line_1": "sample string 6",
        "Address_line_2": "sample string 7",
        "Address_line_3": "sample string 8",
        "City": "sample string 9",
        "County": "sample string 10",
        "Postcode": "sample string 11",
        "Country": "sample string 12",
        "Email": "sample string 13",
        "Telephone": "sample string 14",
        "Mobile": "sample string 15",
        "Latitude": "sample string 16",
        "Longitude": "sample string 17"
      },
      "WH_Shipment_Lines": [
        {
          "PartNo": "sample string 1",
          "Description": "sample string 2",
          "HandlingType": "sample string 3",
          "Qty": 4.0,
          "QtyPicked": 5.0,
          "ShipmentLineID": 6
        },
        {
          "PartNo": "sample string 1",
          "Description": "sample string 2",
          "HandlingType": "sample string 3",
          "Qty": 4.0,
          "QtyPicked": 5.0,
          "ShipmentLineID": 6
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<WH_Shipments_Detail xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <WH_Shipment_Detail>
    <ShipmentID>1</ShipmentID>
    <OrderNo>2</OrderNo>
    <OrderDate>2025-01-15T05:39:02.1276081+00:00</OrderDate>
    <Priority>sample string 4</Priority>
    <Notes>sample string 5</Notes>
    <IsCancelled>true</IsCancelled>
    <WHShipmentAwaitingPicking_Release>
      <ReleasedBy>sample string 1</ReleasedBy>
      <ReleasedByName>sample string 2</ReleasedByName>
      <ReleasedDate>2025-01-15T05:39:02.1276081+00:00</ReleasedDate>
    </WHShipmentAwaitingPicking_Release>
    <WHShipmentAwaitingPicking_Routing>
      <IsRouted>true</IsRouted>
      <RouteID>1</RouteID>
    </WHShipmentAwaitingPicking_Routing>
    <WHShipmentAwaitingPicking_Picking>
      <NeedsPicking>true</NeedsPicking>
      <PickingBay>sample string 2</PickingBay>
      <AssignedTo>sample string 3</AssignedTo>
      <AssignedToName>sample string 4</AssignedToName>
      <Started>2025-01-15T05:39:02.1276081+00:00</Started>
      <Ended>2025-01-15T05:39:02.1276081+00:00</Ended>
      <PickingComplete>true</PickingComplete>
    </WHShipmentAwaitingPicking_Picking>
    <WHShipmentAwaitingPicking_Loading>
      <NeedsLoading>true</NeedsLoading>
      <LoadingBay>sample string 2</LoadingBay>
      <AssignedTo>sample string 3</AssignedTo>
      <AssignedToName>sample string 4</AssignedToName>
      <Started>2025-01-15T05:39:02.1276081+00:00</Started>
      <Ended>2025-01-15T05:39:02.1276081+00:00</Ended>
      <LoadingComplete>true</LoadingComplete>
    </WHShipmentAwaitingPicking_Loading>
    <WHShipmentAwaitingPicking_Deliverables>
      <WHShipmentAwaitingPicking_Deliverable>
        <DeliverableID>1</DeliverableID>
        <HandlingArea>sample string 2</HandlingArea>
      </WHShipmentAwaitingPicking_Deliverable>
      <WHShipmentAwaitingPicking_Deliverable>
        <DeliverableID>1</DeliverableID>
        <HandlingArea>sample string 2</HandlingArea>
      </WHShipmentAwaitingPicking_Deliverable>
    </WHShipmentAwaitingPicking_Deliverables>
    <WHShipmentAwaitingPickingRecipient>
      <DeliveryAreaCode>sample string 1</DeliveryAreaCode>
      <DeliveryArea>sample string 2</DeliveryArea>
      <Company>sample string 3</Company>
      <Firstname>sample string 4</Firstname>
      <Lastname>sample string 5</Lastname>
      <Address_line_1>sample string 6</Address_line_1>
      <Address_line_2>sample string 7</Address_line_2>
      <Address_line_3>sample string 8</Address_line_3>
      <City>sample string 9</City>
      <County>sample string 10</County>
      <Postcode>sample string 11</Postcode>
      <Country>sample string 12</Country>
      <Email>sample string 13</Email>
      <Telephone>sample string 14</Telephone>
      <Mobile>sample string 15</Mobile>
      <Latitude>sample string 16</Latitude>
      <Longitude>sample string 17</Longitude>
    </WHShipmentAwaitingPickingRecipient>
    <WH_Shipment_Lines>
      <WH_Shipment_Line>
        <PartNo>sample string 1</PartNo>
        <Description>sample string 2</Description>
        <HandlingType>sample string 3</HandlingType>
        <Qty>4</Qty>
        <QtyPicked>5</QtyPicked>
        <ShipmentLineID>6</ShipmentLineID>
      </WH_Shipment_Line>
      <WH_Shipment_Line>
        <PartNo>sample string 1</PartNo>
        <Description>sample string 2</Description>
        <HandlingType>sample string 3</HandlingType>
        <Qty>4</Qty>
        <QtyPicked>5</QtyPicked>
        <ShipmentLineID>6</ShipmentLineID>
      </WH_Shipment_Line>
    </WH_Shipment_Lines>
  </WH_Shipment_Detail>
  <WH_Shipment_Detail>
    <ShipmentID>1</ShipmentID>
    <OrderNo>2</OrderNo>
    <OrderDate>2025-01-15T05:39:02.1276081+00:00</OrderDate>
    <Priority>sample string 4</Priority>
    <Notes>sample string 5</Notes>
    <IsCancelled>true</IsCancelled>
    <WHShipmentAwaitingPicking_Release>
      <ReleasedBy>sample string 1</ReleasedBy>
      <ReleasedByName>sample string 2</ReleasedByName>
      <ReleasedDate>2025-01-15T05:39:02.1276081+00:00</ReleasedDate>
    </WHShipmentAwaitingPicking_Release>
    <WHShipmentAwaitingPicking_Routing>
      <IsRouted>true</IsRouted>
      <RouteID>1</RouteID>
    </WHShipmentAwaitingPicking_Routing>
    <WHShipmentAwaitingPicking_Picking>
      <NeedsPicking>true</NeedsPicking>
      <PickingBay>sample string 2</PickingBay>
      <AssignedTo>sample string 3</AssignedTo>
      <AssignedToName>sample string 4</AssignedToName>
      <Started>2025-01-15T05:39:02.1276081+00:00</Started>
      <Ended>2025-01-15T05:39:02.1276081+00:00</Ended>
      <PickingComplete>true</PickingComplete>
    </WHShipmentAwaitingPicking_Picking>
    <WHShipmentAwaitingPicking_Loading>
      <NeedsLoading>true</NeedsLoading>
      <LoadingBay>sample string 2</LoadingBay>
      <AssignedTo>sample string 3</AssignedTo>
      <AssignedToName>sample string 4</AssignedToName>
      <Started>2025-01-15T05:39:02.1276081+00:00</Started>
      <Ended>2025-01-15T05:39:02.1276081+00:00</Ended>
      <LoadingComplete>true</LoadingComplete>
    </WHShipmentAwaitingPicking_Loading>
    <WHShipmentAwaitingPicking_Deliverables>
      <WHShipmentAwaitingPicking_Deliverable>
        <DeliverableID>1</DeliverableID>
        <HandlingArea>sample string 2</HandlingArea>
      </WHShipmentAwaitingPicking_Deliverable>
      <WHShipmentAwaitingPicking_Deliverable>
        <DeliverableID>1</DeliverableID>
        <HandlingArea>sample string 2</HandlingArea>
      </WHShipmentAwaitingPicking_Deliverable>
    </WHShipmentAwaitingPicking_Deliverables>
    <WHShipmentAwaitingPickingRecipient>
      <DeliveryAreaCode>sample string 1</DeliveryAreaCode>
      <DeliveryArea>sample string 2</DeliveryArea>
      <Company>sample string 3</Company>
      <Firstname>sample string 4</Firstname>
      <Lastname>sample string 5</Lastname>
      <Address_line_1>sample string 6</Address_line_1>
      <Address_line_2>sample string 7</Address_line_2>
      <Address_line_3>sample string 8</Address_line_3>
      <City>sample string 9</City>
      <County>sample string 10</County>
      <Postcode>sample string 11</Postcode>
      <Country>sample string 12</Country>
      <Email>sample string 13</Email>
      <Telephone>sample string 14</Telephone>
      <Mobile>sample string 15</Mobile>
      <Latitude>sample string 16</Latitude>
      <Longitude>sample string 17</Longitude>
    </WHShipmentAwaitingPickingRecipient>
    <WH_Shipment_Lines>
      <WH_Shipment_Line>
        <PartNo>sample string 1</PartNo>
        <Description>sample string 2</Description>
        <HandlingType>sample string 3</HandlingType>
        <Qty>4</Qty>
        <QtyPicked>5</QtyPicked>
        <ShipmentLineID>6</ShipmentLineID>
      </WH_Shipment_Line>
      <WH_Shipment_Line>
        <PartNo>sample string 1</PartNo>
        <Description>sample string 2</Description>
        <HandlingType>sample string 3</HandlingType>
        <Qty>4</Qty>
        <QtyPicked>5</QtyPicked>
        <ShipmentLineID>6</ShipmentLineID>
      </WH_Shipment_Line>
    </WH_Shipment_Lines>
  </WH_Shipment_Detail>
</WH_Shipments_Detail>