Skip to content

Boxes

GET /boxes
Authorization: Bearer {api_key}

The endpoint returns active boxes owned by your tenant. Archived boxes and boxes owned by other tenants are never visible.

{
"items": [
{
"id": "box_01k3example",
"name": "Prague 1 Box",
"location_name": "Main entrance",
"address": "Dlouha 1, Prague"
}
]
}

Persist id as the technical identifier used by POST /shipments. Names and location labels can be shown to operators, but may change in the administration.

The box list does not return a free-compartment count. Availability is checked atomically by POST /shipments:

  • an available customer compartment is reserved,
  • the system compartment is never allocated,
  • a full box returns 409 box_full,
  • an incompatible device version returns 409 device_upgrade_required.

This prevents two concurrent orders from both claiming the last compartment.