object Tote

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.
`name`	`String`	Human-readable name for this tote.
`barcode`	`String`	Barcode value for the tote.
`barcode_pdf`	`String`	Barcode pdf for this tote.
`barcode_image`	`String`	Barcode image for this tote.
`color`	`String`	Color for this tote.
`color_name`	`String`	Color name for this tote.
`last_activity`	ISODateTime	Last activity as an ISO-8601 datetime, returned in UTC unless otherwise noted.
`picked_quantity`	`Int`	Picked quantity as a whole-unit count.
`warehouse`	Warehouse	Warehouse display value or nested warehouse object for this record. Use warehouse_id when passing a warehouse reference.
`orders`	[Order]	List of orders for this tote.
`picks`	[TotePick]	List of picks for this tote.
`status`	`String`	Can either be 'Empty', 'Stocked', or 'In Hospital'.

Referenced By

Example

{
  "id": "UmVjb3JkOjEyMzQ=",
  "legacy_id": 1234,
  "name": "TOTE-001",
  "barcode": "TOTE-001",
  "barcode_pdf": "TOTE-001",
  "barcode_image": "TOTE-001",
  "color": "blue",
  "color_name": "blue",
  "last_activity": "2026-07-09T15:30:00Z",
  "picked_quantity": 2,
  "warehouse": {id: "V2FyZWhvdXNlOjEyMzQ=", identifier: "Primary Warehouse"},
  "orders": [[{id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"}]],
  "picks": [[{id: "VG90ZVBpY2s6MTIzNA=="}]],
  "status": "pending"
}