Ugrás a tartalomhoz
ShopentlyLearn

Adatsémák: Raktárak és raktárhelyek

Adatsémák: Raktárak és raktárhelyek. Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.

Adatsémák

Listázás · Helyek — Raktárak és raktárhelyek — Válasz

ApiResponse_list_LocationData__ · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
dataTömb <LocationData > Kötelező

Példaválasz · ApiResponse_list_LocationData__.

Példa: [{"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 Kötelező

A válasz metaadatai.

Példa: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

További mezők: Nem

Listázás — Raktárak és raktárhelyek — Válasz

ApiResponse_list_WarehouseData__ · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
dataTömb <WarehouseData > Kötelező

Példaválasz · ApiResponse_list_WarehouseData__.

Példa: [{"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 Kötelező

A válasz metaadatai.

Példa: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

További mezők: Nem

Lekérés — Raktárak és raktárhelyek — Válasz

ApiResponse_WarehouseData_ · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
dataWarehouseData Kötelező

Példaválasz · WarehouseData.

Példa: {"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 Kötelező

A válasz metaadatai.

Példa: {"request_id":"example"}

További mezők: Nem

Listázás · Helyek — Raktárak és raktárhelyek — Válasz

LocationData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
codeKarakterláncKötelező

Stabil, géppel feldolgozható kód.

Példa: "example"
created_atKarakterláncKötelező

A létrehozás időpontja.

format: "date-time"
Példa: "2026-01-01T12:00:00Z"
idKarakterláncKötelező

Erőforrás-azonosító; a visszaadott alakban őrizze meg. (LocationData).

Példa: "example"
is_leafLogikai értékKötelező

Jelzi, hogy a kategóriának nincsenek-e alkategóriái.

Példa: true
location_typeKarakterláncKötelező

A raktárhely típusa.

Korlátozások
enum
["zone", "rack", "shelf", "bin"]
Példa: "zone"
nameKarakterláncKötelező

Az erőforrás neve az adott környezetben.

Példa: "Example"
parent_idKarakterlánc nullKötelező

A szülőkategória azonosítója.

Példa: null
updated_atKarakterláncKötelező

A legutóbbi módosítás időpontja.

format: "date-time"
Példa: "2026-01-01T12:00:00Z"
versionEgész számKötelező

Az erőforrás verziója az egyidejű módosítások ellenőrzéséhez.

Példa: 1
warehouse_idKarakterláncKötelező

Raktárazonosító.

Példa: "example"

További mezők: Nem

Raktárhelyek

LocationQuantity · Séma · Adatsémák: Raktárak és raktárhelyek
location_idKarakterláncKötelező

Raktárhely-azonosító.

Korlátozások
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Példa: "example"
on_handEgész számKötelező

Fizikai készletmennyiség.

minimum: 0maximum: 2147483647
Példa: 1

További mezők: Nem

Lekérés — Raktárak és raktárhelyek — Válasz

WarehouseData · Az API által fogadott vagy visszaadott adatok mezői, típusai és korlátozásai.
activeLogikai értékKötelező

Jelzi, hogy az erőforrás aktív-e.

Példa: true
address_lineKarakterlánc nullKötelező

Címsor.

Példa: "example"
cityKarakterlánc nullKötelező

Város vagy település.

Példa: "example"
codeKarakterláncKötelező

Stabil, géppel feldolgozható kód.

Példa: "example"
country_codeKarakterláncKötelező

Országkód.

Példa: "PL"
created_atKarakterláncKötelező

A létrehozás időpontja.

format: "date-time"
Példa: "2026-01-01T12:00:00Z"
customer_visibleLogikai értékKötelező

Jelzi, hogy az állapot látható-e az ügyfélnek.

Példa: false
idKarakterláncKötelező

Erőforrás-azonosító; a visszaadott alakban őrizze meg. (WarehouseData).

Példa: "example"
nameKarakterláncKötelező

Az erőforrás neve az adott környezetben.

Példa: "Example"
postal_codeKarakterlánc nullKötelező

Irányítószám.

Példa: "example"
updated_atKarakterláncKötelező

A legutóbbi módosítás időpontja.

format: "date-time"
Példa: "2026-01-01T12:00:00Z"
versionEgész számKötelező

Az erőforrás verziója az egyidejű módosítások ellenőrzéséhez.

Példa: 1

További mezők: Nem