Provides a paginated list of box packages in a shipment.

{
  "boxes": [
    {
      "packageId": "string",
      "boxId": "string",
      "contentInformationSource": "BOX_CONTENT_PROVIDED",
      "destinationRegion": {
        "countryCode": "string",
        "state": "string",
        "warehouseId": "string"
      },
      "dimensions": {
        "height": 1.1,
        "length": 1.1,
        "width": 1.1,
        "unitOfMeasurement": "IN"
      },
      "externalContainerIdentifier": "string",
      "externalContainerIdentifierType": "string",
      "items": [
        {
          "msku": "string",
          "labelOwner": "string",
          "prepInstructions": [
            {
              "fee": {
                "amount": 1.1,
                "code": "string"
              },
              "prepOwner": "string",
              "prepType": "string"
            }
          ],
          "quantity": 1,
          "expiration": "string",
          "manufacturingLotCode": "string"
        }
      ],
      "quantity": 1,
      "templateName": "string",
      "weight": {
        "unit": "LB",
        "value": 1.1
      }
    }
  ],
  "pagination": {
    "nextToken": "string"
  }
}

Path parameters

inboundPlanIdstringRequired

Identifier of an inbound plan.

shipmentIdstringRequired

Identifier of a shipment. A shipment contains the boxes and units being inbounded.

Query parameters

pageSizeintegerOptional1-30

The number of boxes to return in the response matching the given query.

paginationTokenstringOptional

A token to fetch a certain page when there are multiple pages worth of results.

Response

Success

boxeslist of objects

A list of boxes in a shipment.

paginationobjectOptional

Contains tokens to fetch from a certain page.

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error