Siirry sisältöön
ShopentlyLearn

Tietoskeemat: Varastot ja sijainnit

Tietoskeemat: Varastot ja sijainnit. API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

Tietoskeemat

Listaa · Sijainnit — Varastot ja sijainnit — Vastaus

ApiResponse_list_LocationData__ · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.
dataTaulukko <LocationData > Pakollinen

Vastausesimerkki · ApiResponse_list_LocationData__.

Esimerkki: [{"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 Pakollinen

Vastauksen metatiedot.

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

Lisäkentät: Ei

Listaa — Varastot ja sijainnit — Vastaus

ApiResponse_list_WarehouseData__ · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.
dataTaulukko <WarehouseData > Pakollinen

Vastausesimerkki · ApiResponse_list_WarehouseData__.

Esimerkki: [{"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 Pakollinen

Vastauksen metatiedot.

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

Lisäkentät: Ei

Hae — Varastot ja sijainnit — Vastaus

ApiResponse_WarehouseData_ · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.
dataWarehouseData Pakollinen

Vastausesimerkki · WarehouseData.

Esimerkki: {"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 Pakollinen

Vastauksen metatiedot.

Esimerkki: {"request_id":"example"}

Lisäkentät: Ei

Listaa · Sijainnit — Varastot ja sijainnit — Vastaus

LocationData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.
codeMerkkijonoPakollinen

Vakaa koneellisesti luettava koodi.

Esimerkki: "example"
created_atMerkkijonoPakollinen

Luontiajankohta.

format: "date-time"
Esimerkki: "2026-01-01T12:00:00Z"
idMerkkijonoPakollinen

Resurssin tunniste; säilytä se palautetussa muodossa. (LocationData).

Esimerkki: "example"
is_leafTotuusarvoPakollinen

Onko kategoria ilman alikategorioita.

Esimerkki: true
location_typeMerkkijonoPakollinen

Varastosijainnin tyyppi.

Rajoitukset
enum
["zone", "rack", "shelf", "bin"]
Esimerkki: "zone"
nameMerkkijonoPakollinen

Resurssin nimi kyseisessä kontekstissa.

Esimerkki: "Example"
parent_idMerkkijono nullPakollinen

Yläkategorian tunniste.

Esimerkki: null
updated_atMerkkijonoPakollinen

Viimeisimmän päivityksen ajankohta.

format: "date-time"
Esimerkki: "2026-01-01T12:00:00Z"
versionKokonaislukuPakollinen

Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 1
warehouse_idMerkkijonoPakollinen

Varaston tunniste.

Esimerkki: "example"

Lisäkentät: Ei

Varastosijainnit

LocationQuantity · Skeema · Tietoskeemat: Varastot ja sijainnit
location_idMerkkijonoPakollinen

Varastosijainnin tunniste.

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

Fyysinen varastomäärä.

minimum: 0maximum: 2147483647
Esimerkki: 1

Lisäkentät: Ei

Hae — Varastot ja sijainnit — Vastaus

WarehouseData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.
activeTotuusarvoPakollinen

Onko resurssi aktiivinen.

Esimerkki: true
address_lineMerkkijono nullPakollinen

Osoiterivi.

Esimerkki: "example"
cityMerkkijono nullPakollinen

Kaupunki tai paikkakunta.

Esimerkki: "example"
codeMerkkijonoPakollinen

Vakaa koneellisesti luettava koodi.

Esimerkki: "example"
country_codeMerkkijonoPakollinen

Maakoodi.

Esimerkki: "PL"
created_atMerkkijonoPakollinen

Luontiajankohta.

format: "date-time"
Esimerkki: "2026-01-01T12:00:00Z"
customer_visibleTotuusarvoPakollinen

Näkyykö tila asiakkaalle.

Esimerkki: false
idMerkkijonoPakollinen

Resurssin tunniste; säilytä se palautetussa muodossa. (WarehouseData).

Esimerkki: "example"
nameMerkkijonoPakollinen

Resurssin nimi kyseisessä kontekstissa.

Esimerkki: "Example"
postal_codeMerkkijono nullPakollinen

Postinumero.

Esimerkki: "example"
updated_atMerkkijonoPakollinen

Viimeisimmän päivityksen ajankohta.

format: "date-time"
Esimerkki: "2026-01-01T12:00:00Z"
versionKokonaislukuPakollinen

Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 1

Lisäkentät: Ei