GET v1/Shipments/{shipmentId}/Picklist

Returns the picklist for this Shipment

Request Information

URI Parameters

Name	Description	Type	Additional information
shipmentId	The Shipment Id	integer	Required.

Body Parameters

None.

Response Information

Resource Description

List of PickRowInfo entities

PickListInfo

Name	Description	Type	Additional information
OrderShipmentId	Id of the order shipment	integer	None.
IsPicked	Indication if ALL rows are marked as picked	boolean	None.
PdfPickListFileId	File ID to PDF version of this picklist (if generated). If the ID is negative, a PDF version is not available.	integer	None.
Rows	Rows of the picklist	Collection of PickRowInfo	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderShipmentId": 1,
  "IsPicked": true,
  "PdfPickListFileId": 3,
  "Rows": [
    {
      "QtyNeeded": 1.0,
      "QtyPicked": 2.0,
      "WarehouseLocationId": 3,
      "Location": "sample string 4",
      "LocationAisle": "sample string 5",
      "LocationBay": "sample string 6",
      "LocationShelf": "sample string 7",
      "LocationBin": "sample string 8",
      "ProductCode": "sample string 9",
      "ProductName": "sample string 10",
      "OrderCode": "sample string 11",
      "OrderShipmentId": 12,
      "OrderId": 13,
      "OrderRowId": 14,
      "RequiresLotNumber": true,
      "RequiresExpiryDate": true,
      "RequiresSerialNumber": true,
      "LotNumber": "sample string 18",
      "ExpiryDate": "2026-01-11T16:15:49.9039733+01:00",
      "SerialNumber": "sample string 19"
    },
    {
      "QtyNeeded": 1.0,
      "QtyPicked": 2.0,
      "WarehouseLocationId": 3,
      "Location": "sample string 4",
      "LocationAisle": "sample string 5",
      "LocationBay": "sample string 6",
      "LocationShelf": "sample string 7",
      "LocationBin": "sample string 8",
      "ProductCode": "sample string 9",
      "ProductName": "sample string 10",
      "OrderCode": "sample string 11",
      "OrderShipmentId": 12,
      "OrderId": 13,
      "OrderRowId": 14,
      "RequiresLotNumber": true,
      "RequiresExpiryDate": true,
      "RequiresSerialNumber": true,
      "LotNumber": "sample string 18",
      "ExpiryDate": "2026-01-11T16:15:49.9039733+01:00",
      "SerialNumber": "sample string 19"
    }
  ]
}

application/xml, text/xml

Sample:

<PickListInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrderShipmentId>1</OrderShipmentId>
  <IsPicked>true</IsPicked>
  <PdfPickListFileId>3</PdfPickListFileId>
  <Rows>
    <Row>
      <QtyNeeded>1</QtyNeeded>
      <QtyPicked>2</QtyPicked>
      <WarehouseLocationId>3</WarehouseLocationId>
      <Location>sample string 4</Location>
      <LocationAisle>sample string 5</LocationAisle>
      <LocationBay>sample string 6</LocationBay>
      <LocationShelf>sample string 7</LocationShelf>
      <LocationBin>sample string 8</LocationBin>
      <ProductCode>sample string 9</ProductCode>
      <ProductName>sample string 10</ProductName>
      <OrderCode>sample string 11</OrderCode>
      <OrderShipmentId>12</OrderShipmentId>
      <OrderId>13</OrderId>
      <OrderRowId>14</OrderRowId>
      <RequiresLotNumber>true</RequiresLotNumber>
      <RequiresExpiryDate>true</RequiresExpiryDate>
      <RequiresSerialNumber>true</RequiresSerialNumber>
      <LotNumber>sample string 18</LotNumber>
      <ExpiryDate>2026-01-11T16:15:49.9039733+01:00</ExpiryDate>
      <SerialNumber>sample string 19</SerialNumber>
    </Row>
    <Row>
      <QtyNeeded>1</QtyNeeded>
      <QtyPicked>2</QtyPicked>
      <WarehouseLocationId>3</WarehouseLocationId>
      <Location>sample string 4</Location>
      <LocationAisle>sample string 5</LocationAisle>
      <LocationBay>sample string 6</LocationBay>
      <LocationShelf>sample string 7</LocationShelf>
      <LocationBin>sample string 8</LocationBin>
      <ProductCode>sample string 9</ProductCode>
      <ProductName>sample string 10</ProductName>
      <OrderCode>sample string 11</OrderCode>
      <OrderShipmentId>12</OrderShipmentId>
      <OrderId>13</OrderId>
      <OrderRowId>14</OrderRowId>
      <RequiresLotNumber>true</RequiresLotNumber>
      <RequiresExpiryDate>true</RequiresExpiryDate>
      <RequiresSerialNumber>true</RequiresSerialNumber>
      <LotNumber>sample string 18</LotNumber>
      <ExpiryDate>2026-01-11T16:15:49.9039733+01:00</ExpiryDate>
      <SerialNumber>sample string 19</SerialNumber>
    </Row>
  </Rows>
</PickListInfo>