Vai al contenuto
ShopentlyLearn

Schemi dei dati: Magazzini e ubicazioni

Schemi dei dati: Magazzini e ubicazioni. Campi, tipi e vincoli dei dati accettati o restituiti dall’API.

Schemi dei dati

Elenca · Ubicazioni — Magazzini e ubicazioni — Risposta

ApiResponse_list_LocationData__ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
dataArray <LocationData > Obbligatorio

Esempio di risposta · ApiResponse_list_LocationData__.

Esempio: [{"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 Obbligatorio

Metadati della risposta.

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

Campi aggiuntivi: No

Elenca — Magazzini e ubicazioni — Risposta

ApiResponse_list_WarehouseData__ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
dataArray <WarehouseData > Obbligatorio

Esempio di risposta · ApiResponse_list_WarehouseData__.

Esempio: [{"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 Obbligatorio

Metadati della risposta.

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

Campi aggiuntivi: No

Recupera — Magazzini e ubicazioni — Risposta

ApiResponse_WarehouseData_ · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
dataWarehouseData Obbligatorio

Esempio di risposta · WarehouseData.

Esempio: {"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 Obbligatorio

Metadati della risposta.

Esempio: {"request_id":"example"}

Campi aggiuntivi: No

Elenca · Ubicazioni — Magazzini e ubicazioni — Risposta

LocationData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
codeStringaObbligatorio

Codice stabile interpretabile dal software.

Esempio: "example"
created_atStringaObbligatorio

Data e ora di creazione.

format: "date-time"
Esempio: "2026-01-01T12:00:00Z"
idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito. (LocationData).

Esempio: "example"
is_leafBooleanoObbligatorio

Indica se la categoria non ha sottocategorie.

Esempio: true
location_typeStringaObbligatorio

Tipo di ubicazione nel magazzino.

Vincoli
enum
["zone", "rack", "shelf", "bin"]
Esempio: "zone"
nameStringaObbligatorio

Nome della risorsa nel contesto pertinente.

Esempio: "Example"
parent_idStringa nullObbligatorio

Identificativo della categoria genitore.

Esempio: null
updated_atStringaObbligatorio

Data e ora dell’aggiornamento più recente.

format: "date-time"
Esempio: "2026-01-01T12:00:00Z"
versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

Esempio: 1
warehouse_idStringaObbligatorio

Identificativo del magazzino.

Esempio: "example"

Campi aggiuntivi: No

Ubicazioni del magazzino

LocationQuantity · Schema · Schemi dei dati: Magazzini e ubicazioni
location_idStringaObbligatorio

Identificativo dell’ubicazione nel magazzino.

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

Quantità fisicamente presente.

minimum: 0maximum: 2147483647
Esempio: 1

Campi aggiuntivi: No

Recupera — Magazzini e ubicazioni — Risposta

WarehouseData · Campi, tipi e vincoli dei dati accettati o restituiti dall’API.
activeBooleanoObbligatorio

Indica se la risorsa è attiva.

Esempio: true
address_lineStringa nullObbligatorio

Riga dell’indirizzo.

Esempio: "example"
cityStringa nullObbligatorio

Città o località.

Esempio: "example"
codeStringaObbligatorio

Codice stabile interpretabile dal software.

Esempio: "example"
country_codeStringaObbligatorio

Codice del paese.

Esempio: "PL"
created_atStringaObbligatorio

Data e ora di creazione.

format: "date-time"
Esempio: "2026-01-01T12:00:00Z"
customer_visibleBooleanoObbligatorio

Indica se lo stato è visibile al cliente.

Esempio: false
idStringaObbligatorio

Identificativo della risorsa; conservalo come restituito. (WarehouseData).

Esempio: "example"
nameStringaObbligatorio

Nome della risorsa nel contesto pertinente.

Esempio: "Example"
postal_codeStringa nullObbligatorio

Codice postale.

Esempio: "example"
updated_atStringaObbligatorio

Data e ora dell’aggiornamento più recente.

format: "date-time"
Esempio: "2026-01-01T12:00:00Z"
versionInteroObbligatorio

Versione della risorsa per il controllo della concorrenza.

Esempio: 1

Campi aggiuntivi: No