Preskočiť na obsah
ShopentlyLearn

Dátové schémy: Sklady a umiestnenia

Dátové schémy: Sklady a umiestnenia. Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

Dátové schémy

Zobraziť zoznam · Umiestnenia — Sklady a umiestnenia — Odpoveď

ApiResponse_list_LocationData__ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
dataPole <LocationData > Povinné

Príklad odpovede · ApiResponse_list_LocationData__.

Prí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é

Metaúdaje odpovede.

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

Ďalšie polia: Nie

Zobraziť zoznam — Sklady a umiestnenia — Odpoveď

ApiResponse_list_WarehouseData__ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
dataPole <WarehouseData > Povinné

Príklad odpovede · ApiResponse_list_WarehouseData__.

Prí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é

Metaúdaje odpovede.

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

Ďalšie polia: Nie

Načítať — Sklady a umiestnenia — Odpoveď

ApiResponse_WarehouseData_ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
dataWarehouseData Povinné

Príklad odpovede · WarehouseData.

Prí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é

Metaúdaje odpovede.

Príklad: {"request_id":"example"}

Ďalšie polia: Nie

Zobraziť zoznam · Umiestnenia — Sklady a umiestnenia — Odpoveď

LocationData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
codeReťazecPovinné

Stabilný strojovo čitateľný kód.

Príklad: "example"
created_atReťazecPovinné

Čas vytvorenia.

format: "date-time"
Príklad: "2026-01-01T12:00:00Z"
idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (LocationData).

Príklad: "example"
is_leafLogická hodnotaPovinné

Či kategória nemá podradené kategórie.

Príklad: true
location_typeReťazecPovinné

Typ skladového umiestnenia.

Obmedzenia
enum
["zone", "rack", "shelf", "bin"]
Príklad: "zone"
nameReťazecPovinné

Názov zdroja v príslušnom kontexte.

Príklad: "Example"
parent_idReťazec nullPovinné

Identifikátor nadradenej kategórie.

Príklad: null
updated_atReťazecPovinné

Čas poslednej aktualizácie.

format: "date-time"
Príklad: "2026-01-01T12:00:00Z"
versionCelé čísloPovinné

Verzia zdroja používaná na riadenie súbežných zmien.

Príklad: 1
warehouse_idReťazecPovinné

Identifikátor skladu.

Príklad: "example"

Ďalšie polia: Nie

Skladové umiestnenia

LocationQuantity · Schéma · Dátové schémy: Sklady a umiestnenia
location_idReťazecPovinné

Identifikátor skladového umiestnenia.

Obmedzenia
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Príklad: "example"
on_handCelé čísloPovinné

Fyzické skladové množstvo.

minimum: 0maximum: 2147483647
Príklad: 1

Ďalšie polia: Nie

Načítať — Sklady a umiestnenia — Odpoveď

WarehouseData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
activeLogická hodnotaPovinné

Či je zdroj aktívny.

Príklad: true
address_lineReťazec nullPovinné

Riadok adresy.

Príklad: "example"
cityReťazec nullPovinné

Mesto alebo obec.

Príklad: "example"
codeReťazecPovinné

Stabilný strojovo čitateľný kód.

Príklad: "example"
country_codeReťazecPovinné

Kód krajiny.

Príklad: "PL"
created_atReťazecPovinné

Čas vytvorenia.

format: "date-time"
Príklad: "2026-01-01T12:00:00Z"
customer_visibleLogická hodnotaPovinné

Či je stav viditeľný pre zákazníka.

Príklad: false
idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (WarehouseData).

Príklad: "example"
nameReťazecPovinné

Názov zdroja v príslušnom kontexte.

Príklad: "Example"
postal_codeReťazec nullPovinné

Poštové smerovacie číslo.

Príklad: "example"
updated_atReťazecPovinné

Čas poslednej aktualizácie.

format: "date-time"
Príklad: "2026-01-01T12:00:00Z"
versionCelé čísloPovinné

Verzia zdroja používaná na riadenie súbežných zmien.

Príklad: 1

Ďalšie polia: Nie