Skemi tad-data: Mħażen u postijiet

Skemi tad-data: Mħażen u postijiet. L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

Skemi tad-data

Elenka · Postijiet — Mħażen u postijiet — Risposta

ApiResponse_list_LocationData__ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

dataArray <LocationData > Obbligatorju: Eżempju ta’ tweġiba · ApiResponse_list_LocationData__.

Eżempju: [{"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 Obbligatorju: Metadata tat-tweġiba.

Eżempju: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Oqsma addizzjonali: Le

Elenka — Mħażen u postijiet — Risposta

ApiResponse_list_WarehouseData__ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

dataArray <WarehouseData > Obbligatorju: Eżempju ta’ tweġiba · ApiResponse_list_WarehouseData__.

Eżempju: [{"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 Obbligatorju: Metadata tat-tweġiba.

Eżempju: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Oqsma addizzjonali: Le

Ikseb — Mħażen u postijiet — Risposta

ApiResponse_WarehouseData_ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

dataWarehouseData Obbligatorju: Eżempju ta’ tweġiba · WarehouseData.

Eżempju: {"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 Obbligatorju: Metadata tat-tweġiba.

Eżempju: {"request_id":"example"}

Oqsma addizzjonali: Le

Elenka · Postijiet — Mħażen u postijiet — Risposta

LocationData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

codeStringObbligatorju

Kodiċi stabbli li jista’ jinqara minn magna.

Eżempju: "example"

created_atStringObbligatorju

Ħin tal-ħolqien.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"

idStringObbligatorju

Identifikatur tar-riżorsa; żommu kif mogħti. (LocationData).

Eżempju: "example"

is_leafBooleanObbligatorju

Jekk il-kategorija għandhiex l-ebda sottokategorija.

Eżempju: true

location_typeStringObbligatorju

Tip tal-post fil-maħżen.

Restrizzjonijiet

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

Eżempju: "zone"

nameStringObbligatorju

Isem tar-riżorsa fil-kuntest rilevanti.

Eżempju: "Example"

parent_idString nullObbligatorju

Identifikatur tal-kategorija ġenitur.

Eżempju: null

updated_atStringObbligatorju

Ħin tal-aktar aġġornament reċenti.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"

versionNumru sħiħObbligatorju

Verżjoni tar-riżorsa għall-kontroll tal-konkorrenza.

Eżempju: 1

warehouse_idStringObbligatorju

Identifikatur tal-maħżen.

Eżempju: "example"

Oqsma addizzjonali: Le

Postijiet fil-maħżen

LocationQuantity · Skema · Skemi tad-data: Mħażen u postijiet

location_idStringObbligatorju

Identifikatur tal-post fil-maħżen.

Restrizzjonijiet

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

Eżempju: "example"

on_handNumru sħiħObbligatorju

Kwantità fiżika tal-istokk.

minimum: 0maximum: 2147483647

Eżempju: 1

Oqsma addizzjonali: Le

Ikseb — Mħażen u postijiet — Risposta

WarehouseData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

activeBooleanObbligatorju: Jekk ir-riżorsa hijiex attiva.

Eżempju: true
address_lineString nullObbligatorju: Linja tal-indirizz.

Eżempju: "example"
cityString nullObbligatorju: Belt jew lokalità.

Eżempju: "example"
codeStringObbligatorju: Kodiċi stabbli li jista’ jinqara minn magna.

Eżempju: "example"
country_codeStringObbligatorju: Kodiċi tal-pajjiż.

Eżempju: "PL"
created_atStringObbligatorju: Ħin tal-ħolqien.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"
customer_visibleBooleanObbligatorju: Jekk l-istatus jidhirx lill-klijent.

Eżempju: false
idStringObbligatorju: Identifikatur tar-riżorsa; żommu kif mogħti. (WarehouseData).

Eżempju: "example"
nameStringObbligatorju: Isem tar-riżorsa fil-kuntest rilevanti.

Eżempju: "Example"
postal_codeString nullObbligatorju: Kodiċi postali.

Eżempju: "example"
updated_atStringObbligatorju: Ħin tal-aktar aġġornament reċenti.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"
versionNumru sħiħObbligatorju: Verżjoni tar-riżorsa għall-kontroll tal-konkorrenza.

Eżempju: 1

Oqsma addizzjonali: Le