object Package

Fields

Field	Type	Description
`id`	`String`	Public API ID for this identifiable.
`legacy_id`	BigInt	Numeric legacy ID for this identifiable; use only where legacy IDs are required.
`shipment_id`	`String`	Public API shipment ID that identifies the related record.
`warehouse_id`	`String`	Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects.
`order_id`	`String`	Public API order ID that identifies the related record.
`order_number`	`String`	Order number for this package.
`user_id`	`String`	Public API user ID that identifies the related record.
`user_first_name`	`String`	User first name for this package.
`user_last_name`	`String`	User last name for this package.
`total_items`	`Int`	The sum of every shipped item's quantity in the package.
`unique_items`	`Int`	The number of unique shipped items in the package.
`barcodes_scanned`	`Int`	Number of barcodes scanned while packing this package.
`created_at`	ISODateTime	Created at as an ISO-8601 datetime, returned in UTC unless otherwise noted.
`shipment`	Shipment	Shipment associated with this package.
`order`	Order	Order associated with this package.

Referenced By

PackageEdge Type

Example

{
  "id": "UmVjb3JkOjEyMzQ=",
  "legacy_id": 1234,
  "shipment_id": "U2hpcG1lbnQ6MTIzNA==",
  "warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
  "order_id": "T3JkZXI6MTIzNA==",
  "order_number": "SO-100045",
  "user_id": "VXNlcjoxMjM0",
  "user_first_name": "Ada",
  "user_last_name": "Lovelace",
  "total_items": 100,
  "unique_items": 2,
  "barcodes_scanned": 100,
  "created_at": "2026-07-09T15:30:00Z",
  "shipment": {id: "U2hpcG1lbnQ6MTIzNA=="},
  "order": {id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"}
}