Treci la conținut
ShopentlyLearn

Scheme de date: Depozite și locații

Scheme de date: Depozite și locații. Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

Scheme de date

Listează · Locații — Depozite și locații — Răspuns

ApiResponse_list_LocationData__ · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
dataTablou <LocationData > Obligatoriu

Exemplu de răspuns · ApiResponse_list_LocationData__.

Exemplu: [{"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 Obligatoriu

Metadatele răspunsului.

Exemplu: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Câmpuri suplimentare: Nu

Listează — Depozite și locații — Răspuns

ApiResponse_list_WarehouseData__ · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
dataTablou <WarehouseData > Obligatoriu

Exemplu de răspuns · ApiResponse_list_WarehouseData__.

Exemplu: [{"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 Obligatoriu

Metadatele răspunsului.

Exemplu: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Câmpuri suplimentare: Nu

Obține — Depozite și locații — Răspuns

ApiResponse_WarehouseData_ · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
dataWarehouseData Obligatoriu

Exemplu de răspuns · WarehouseData.

Exemplu: {"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 Obligatoriu

Metadatele răspunsului.

Exemplu: {"request_id":"example"}

Câmpuri suplimentare: Nu

Listează · Locații — Depozite și locații — Răspuns

LocationData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
codeȘir de caractereObligatoriu

Cod stabil, destinat prelucrării automate.

Exemplu: "example"
created_atȘir de caractereObligatoriu

Momentul creării.

format: "date-time"
Exemplu: "2026-01-01T12:00:00Z"
idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată. (LocationData).

Exemplu: "example"
is_leafValoare booleanăObligatoriu

Indică dacă categoria nu are subcategorii.

Exemplu: true
location_typeȘir de caractereObligatoriu

Tipul locației din depozit.

Restricții
enum
["zone", "rack", "shelf", "bin"]
Exemplu: "zone"
nameȘir de caractereObligatoriu

Numele resursei în contextul relevant.

Exemplu: "Example"
parent_idȘir de caractere nullObligatoriu

Identificatorul categoriei părinte.

Exemplu: null
updated_atȘir de caractereObligatoriu

Momentul celei mai recente actualizări.

format: "date-time"
Exemplu: "2026-01-01T12:00:00Z"
versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

Exemplu: 1
warehouse_idȘir de caractereObligatoriu

Identificatorul depozitului.

Exemplu: "example"

Câmpuri suplimentare: Nu

Locațiile din depozit

LocationQuantity · Schemă · Scheme de date: Depozite și locații
location_idȘir de caractereObligatoriu

Identificatorul locației din depozit.

Restricții
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Exemplu: "example"
on_handNumăr întregObligatoriu

Cantitatea fizică din stoc.

minimum: 0maximum: 2147483647
Exemplu: 1

Câmpuri suplimentare: Nu

Obține — Depozite și locații — Răspuns

WarehouseData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.
activeValoare booleanăObligatoriu

Indică dacă resursa este activă.

Exemplu: true
address_lineȘir de caractere nullObligatoriu

Linie de adresă.

Exemplu: "example"
cityȘir de caractere nullObligatoriu

Orașul sau localitatea.

Exemplu: "example"
codeȘir de caractereObligatoriu

Cod stabil, destinat prelucrării automate.

Exemplu: "example"
country_codeȘir de caractereObligatoriu

Codul țării.

Exemplu: "PL"
created_atȘir de caractereObligatoriu

Momentul creării.

format: "date-time"
Exemplu: "2026-01-01T12:00:00Z"
customer_visibleValoare booleanăObligatoriu

Indică dacă starea este vizibilă pentru client.

Exemplu: false
idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată. (WarehouseData).

Exemplu: "example"
nameȘir de caractereObligatoriu

Numele resursei în contextul relevant.

Exemplu: "Example"
postal_codeȘir de caractere nullObligatoriu

Codul poștal.

Exemplu: "example"
updated_atȘir de caractereObligatoriu

Momentul celei mai recente actualizări.

format: "date-time"
Exemplu: "2026-01-01T12:00:00Z"
versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

Exemplu: 1

Câmpuri suplimentare: Nu