Datová schémata: Sklady a umístění

Datová schémata: Sklady a umístění. Pole, typy a omezení dat přijímaných nebo vracených API.

Datová schémata

Vypsat · Umístění — Sklady a umístění — Odpověď

ApiResponse_list_LocationData__ · Pole, typy a omezení dat přijímaných nebo vracených API.

dataPole <LocationData > Povinné: Příklad odpovědi · ApiResponse_list_LocationData__.

Příklad: [{"code":"example","created_at":"2026-01-01T12:00:00Z","id":"example","is_leaf":true,"location_type":"zone","name":"Example","parent_id":null,"updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Povinné: Metadata odpovědi.

Příklad: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Další pole: Ne

Vypsat — Sklady a umístění — Odpověď

ApiResponse_list_WarehouseData__ · Pole, typy a omezení dat přijímaných nebo vracených API.

dataPole <WarehouseData > Povinné: Příklad odpovědi · ApiResponse_list_WarehouseData__.

Příklad: [{"active":true,"address_line":"example","city":"example","code":"example","country_code":"PL","created_at":"2026-01-01T12:00:00Z","customer_visible":false,"id":"example","name":"Example","postal_code":"example","updated_at":"2026-01-01T12:00:00Z","version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Povinné: Metadata odpovědi.

Příklad: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Další pole: Ne

Načíst — Sklady a umístění — Odpověď

ApiResponse_WarehouseData_ · Pole, typy a omezení dat přijímaných nebo vracených API.

dataWarehouseData Povinné: Příklad odpovědi · WarehouseData.

Příklad: {"active":true,"address_line":"example","city":"example","code":"example","country_code":"PL","created_at":"2026-01-01T12:00:00Z","customer_visible":false,"id":"example","name":"Example","postal_code":"example","updated_at":"2026-01-01T12:00:00Z","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Povinné: Metadata odpovědi.

Příklad: {"request_id":"example"}

Další pole: Ne

Vypsat · Umístění — Sklady a umístění — Odpověď

LocationData · Pole, typy a omezení dat přijímaných nebo vracených API.

codeŘetězecPovinné

Stabilní strojově čitelný kód.

Příklad: "example"

created_atŘetězecPovinné

Čas vytvoření.

format: "date-time"

Příklad: "2026-01-01T12:00:00Z"

idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (LocationData).

Příklad: "example"

is_leafLogická hodnotaPovinné

Zda kategorie nemá podřízené kategorie.

Příklad: true

location_typeŘetězecPovinné

Typ skladového umístění.

Omezení

enum: ["zone", "rack", "shelf", "bin"]

Příklad: "zone"

nameŘetězecPovinné

Název zdroje v příslušném kontextu.

Příklad: "Example"

parent_idŘetězec nullPovinné

Identifikátor nadřazené kategorie.

Příklad: null

updated_atŘetězecPovinné

Čas poslední aktualizace.

format: "date-time"

Příklad: "2026-01-01T12:00:00Z"

versionCelé čísloPovinné

Verze zdroje používaná k řízení souběžných změn.

Příklad: 1

warehouse_idŘetězecPovinné

Identifikátor skladu.

Příklad: "example"

Další pole: Ne

Skladová umístění

LocationQuantity · Schéma · Datová schémata: Sklady a umístění

location_idŘetězecPovinné

Identifikátor skladového umístění.

Omezení

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

Příklad: "example"

on_handCelé čísloPovinné

Fyzické skladové množství.

minimum: 0maximum: 2147483647

Příklad: 1

Další pole: Ne

Načíst — Sklady a umístění — Odpověď

WarehouseData · Pole, typy a omezení dat přijímaných nebo vracených API.

activeLogická hodnotaPovinné: Zda je zdroj aktivní.

Příklad: true
address_lineŘetězec nullPovinné: Řádek adresy.

Příklad: "example"
cityŘetězec nullPovinné: Město nebo obec.

Příklad: "example"
codeŘetězecPovinné: Stabilní strojově čitelný kód.

Příklad: "example"
country_codeŘetězecPovinné: Kód země.

Příklad: "PL"
created_atŘetězecPovinné: Čas vytvoření.

format: "date-time"

Příklad: "2026-01-01T12:00:00Z"
customer_visibleLogická hodnotaPovinné: Zda je stav viditelný pro zákazníka.

Příklad: false
idŘetězecPovinné: Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (WarehouseData).

Příklad: "example"
nameŘetězecPovinné: Název zdroje v příslušném kontextu.

Příklad: "Example"
postal_codeŘetězec nullPovinné: Poštovní směrovací číslo.

Příklad: "example"
updated_atŘetězecPovinné: Čas poslední aktualizace.

format: "date-time"

Příklad: "2026-01-01T12:00:00Z"
versionCelé čísloPovinné: Verze zdroje používaná k řízení souběžných změn.

Příklad: 1

Další pole: Ne