shipmentPackedBoxes

Requires permission sales:shipment:read.

The boxes of one shipment with what is in each (frozen at booking, or re-packed when that reproduces the parcels sent), each item's size per unit as known today, and a suggested arrangement for staff to pack by. Empty when the contents of the parcels are not known. No prices or costs.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query ShipmentPackedBoxes($id: ID!) {
  shipmentPackedBoxes(id: $id) {
    name
    boxId
    fragile
    heightCm
    layoutSameAsIndex
    lengthCm
    items {
      name
      heightCm
      lengthCm
      quantity
      sizeSource
      sku
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query ShipmentPackedBoxes($id: ID!) {\n  shipmentPackedBoxes(id: $id) {\n    name\n    boxId\n    fragile\n    heightCm\n    layoutSameAsIndex\n    lengthCm\n    items {\n      name\n      heightCm\n      lengthCm\n      quantity\n      sizeSource\n      sku\n    }\n  }\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "shipmentPackedBoxes": [
      {
        "name": "string",
        "boxId": "string",
        "fragile": true,
        "heightCm": 0,
        "layoutSameAsIndex": 0,
        "lengthCm": 0,
        "items": [
          {
            "name": "string",
            "heightCm": 0,
            "lengthCm": 0,
            "quantity": 0,
            "sizeSource": "CATEGORY",
            "sku": "string"
          }
        ]
      }
    ]
  }
}

shipmentPackedBoxes(
  id: ID!
): [ShipmentPackedBox!]!

Arguments

shipmentPackedBoxes.id ● ID! non-null scalar

The ID of the shipment.

Type

ShipmentPackedBox object

One box of a booked shipment and what is in it (the contents frozen at booking, or re-packed when that reproduces the parcels sent), with a suggested arrangement drawn with today's box and product sizes. Staff only; no cost.