GET v1/Shipments/{shipmentId}/Packlist

Returns the packlist for this Shipment

Request Information

Requires Authorization!

URI Parameters

NameDescriptionTypeAdditional information
shipmentId

The Shipment Id

integer

Required.

Body Parameters

None.

Response Information

Resource Description

List of PickRowInfo entities


PackListInfo
NameDescriptionTypeAdditional information
OrderShipmentId

Id of the order shipment

integer

None.

IsPacked

Indication if ALL rows are marked as packed

boolean

None.

PdfPackListFileId

File ID to PDF version of this packlist (if generated). If the ID is negative, a PDF version is not available.

integer

None.

Rows

Rows of the packlist

Collection of PackListRow

None.

Response Formats

application/json, text/json

Sample:
{
  "OrderShipmentId": 1,
  "IsPacked": true,
  "PdfPackListFileId": 3,
  "Rows": [
    {
      "ItemQuantity": 1.0,
      "ProductCode": "sample string 2",
      "ProductName": "sample string 3",
      "OrderCode": "sample string 4",
      "OrderShipmentId": 5,
      "OrderId": 6,
      "OrderRowId": 7
    },
    {
      "ItemQuantity": 1.0,
      "ProductCode": "sample string 2",
      "ProductName": "sample string 3",
      "OrderCode": "sample string 4",
      "OrderShipmentId": 5,
      "OrderId": 6,
      "OrderRowId": 7
    }
  ]
}

application/xml, text/xml

Sample:
<PackListInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrderShipmentId>1</OrderShipmentId>
  <IsPacked>true</IsPacked>
  <PdfPackListFileId>3</PdfPackListFileId>
  <Rows>
    <Row>
      <ItemQuantity>1</ItemQuantity>
      <ProductCode>sample string 2</ProductCode>
      <ProductName>sample string 3</ProductName>
      <OrderCode>sample string 4</OrderCode>
      <OrderShipmentId>5</OrderShipmentId>
      <OrderId>6</OrderId>
      <OrderRowId>7</OrderRowId>
    </Row>
    <Row>
      <ItemQuantity>1</ItemQuantity>
      <ProductCode>sample string 2</ProductCode>
      <ProductName>sample string 3</ProductName>
      <OrderCode>sample string 4</OrderCode>
      <OrderShipmentId>5</OrderShipmentId>
      <OrderId>6</OrderId>
      <OrderRowId>7</OrderRowId>
    </Row>
  </Rows>
</PackListInfo>