Přeskočit na obsah

Boxy

GET /boxes
Authorization: Bearer {api_key}

Endpoint vrací aktivní boxy vlastněné vaším tenantem. Archivované ani cizí boxy nejsou viditelné.

{
"items": [
{
"id": "box_01k3example",
"name": "Box Praha 1",
"location_name": "U hlavního vchodu",
"address": "Dlouhá 1, Praha"
}
]
}

id ukládejte jako technický identifikátor pro POST /shipments. Název a lokaci můžete zobrazit obsluze, ale mohou se v administraci změnit.

Seznam boxů nevrací počet volných schránek. Rezervace je atomická a skutečnou dostupnost ověří až POST /shipments:

  • při dostupné zákaznické schránce vznikne zásilka,
  • systémová schránka se nikdy nepoužije,
  • při plném boxu API vrátí 409 box_full,
  • při nekompatibilní verzi zařízení vrátí 409 device_upgrade_required.

Tím se předejde závodu mezi dvěma objednávkami, které se snaží obsadit poslední schránku.