Shipments

List packages

Retrieve all packages for a specific shipment, optionally filtered by container.

get/api/v1/external/shipments/{shipmentId}/packages

Request

Path parameters

shipmentIdstring required

Unique shipment identifier

Query parameters

containerIdstring nullable

Filter packages by container ID (use 'null' for loose packages)

Response

Packages retrieved successfully

successboolean

Example response

{
  "data": {
    "packages": [
      {
        "id": "1014810279825727493",
        "packageNumber": "PKG001",
        "packageType": "CARTON",
        "packageCount": 1,
        "items": [
          {
            "id": "1014810279825727491",
            "lineNumber": 1,
            "sku": "SKU-12345",
            "partNumber": "PN-67890",
            "description": "Electronic Component",
            "quantity": 100,
            "unitOfMeasure": "PCS",
            "unitPrice": 25.5,
            "amount": 2550,
            "currency": "USD",
            "countryOfOrigin": "CN",
            "hsCode": "8541.10.00",
            "weight": 150.5,
            "weightUnit": "KG",
            "volume": 2.5,
            "volumeUnit": "CBM",
            "packageNumber": "PKG-001",
            "dimensions": {
              "length": 100,
              "width": 50,
              "height": 50,
              "unit": "CM"
            }
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.