Tietoskeemat: Varastosaldot

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

Tietoskeemat

Varastosijainneille kohdistetut määrät

AllocationData · Skeema · Tietoskeemat: Varastosaldot

location_codeMerkkijonoPakollinen: Varastosijainnin koodi.

Esimerkki: "example"
location_idMerkkijonoPakollinen: Varastosijainnin tunniste.

Esimerkki: "example"
location_nameMerkkijonoPakollinen: Varastosijainnin nimi.

Esimerkki: "example"
on_handKokonaislukuPakollinen: Fyysinen varastomäärä.

Esimerkki: 10

Lisäkentät: Ei

Listaa · Varastosaldot — Varastosaldot — Vastaus

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

dataTaulukko <StockData > Pakollinen: Vastausesimerkki · ApiResponse_list_StockData__.

Esimerkki: [{"active":true,"available":5,"id":"stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ","manual_reserved":2,"on_hand":10,"reserved":3,"sellable_limit":10,"target_id":"example","target_type":"product","total_reserved":5,"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

Hae · Varastosaldot — Varastosaldot — Vastaus

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

dataStockDetailData Pakollinen: Vastausesimerkki · StockDetailData.

Esimerkki: {"active":true,"allocations":[{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}],"available":5,"id":"stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ","manual_reserved":2,"on_hand":10,"reserved":3,"sellable_limit":10,"target_id":"example","target_type":"product","total_reserved":5,"updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Pakollinen: Vastauksen metatiedot.

Esimerkki: {"request_id":"example"}

Lisäkentät: Ei

Päivitä · Manuaalinen varaus — Varastosaldot — Pyynnön sisältö

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

expected_versionKokonaislukuPakollinen: Ennen kirjoitusta luettu versio; ristiriita hylkää päivityksen.

minimum: 1maximum: 9223372036854775807

Esimerkki: 1
manual_reservedKokonaislukuPakollinen: Manuaalisesti varattu määrä.

minimum: 0maximum: 2147483647

Esimerkki: 1
reasonMerkkijonoValinnainen: Muutokselle kirjattu syy.

maxLength: 500

Oletus: ""

Lisäkentät: Ei

Päivitä · Myyntiraja — Varastosaldot — Pyynnön sisältö

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

expected_versionKokonaislukuPakollinen: Ennen kirjoitusta luettu versio; ristiriita hylkää päivityksen.

minimum: 1maximum: 9223372036854775807

Esimerkki: 1
reasonMerkkijonoValinnainen: Muutokselle kirjattu syy.

maxLength: 500

Oletus: ""
sellable_limitKokonaislukuPakollinen: Myyntiraja: -1 tarkoittaa rajatonta määrää ja 0 estää saatavilla olevan myynnin.

minimum: -1maximum: 2147483647

Esimerkki: 1

Lisäkentät: Ei

Luo · Varastokorjaus — Varastosaldot — Pyynnön sisältö

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

expected_versionKokonaislukuPakollinen

Ennen kirjoitusta luettu versio; ristiriita hylkää päivityksen.

minimum: 0maximum: 9223372036854775807

Esimerkki: 0

locationsTaulukko <LocationQuantity > Pakollinen

Varastosijainnit.

minItems: 1maxItems: 100

Esimerkki: [{"location_id":"example","on_hand":1}]

reasonMerkkijonoPakollinen

Muutokselle kirjattu syy.

minLength: 1maxLength: 500

Esimerkki: "Example"

target_idMerkkijonoPakollinen

Toiminnon kohteena olevan tuotteen tai variantin tunniste.

Rajoitukset

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

Esimerkki: "example"

target_typeMerkkijonoPakollinen

Koskeeko toiminto tuotetta vai varianttia.

Rajoitukset

enum: ["product", "variant"]

Esimerkki: "product"

warehouse_idMerkkijonoPakollinen

Varaston tunniste.

Rajoitukset

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

Esimerkki: "example"

Lisäkentät: Ei

Päivitä · Varastosaldot — Varastosaldot — Pyynnön sisältö

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

expected_versionKokonaislukuPakollinen: Ennen kirjoitusta luettu versio; ristiriita hylkää päivityksen.

minimum: 1maximum: 9223372036854775807

Esimerkki: 1
locationsTaulukko <LocationQuantity > Pakollinen: Varastosijainnit.

minItems: 1maxItems: 100

Esimerkki: [{"location_id":"example","on_hand":1}]
reasonMerkkijonoPakollinen: Muutokselle kirjattu syy.

minLength: 1maxLength: 500

Esimerkki: "Example"

Lisäkentät: Ei

Listaa · Varastosaldot — Varastosaldot — Vastaus

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

activeTotuusarvoPakollinen

Onko resurssi aktiivinen.

Esimerkki: true

availableKokonaisluku nullPakollinen

Myyntiin käytettävissä oleva määrä; null tarkoittaa rajatonta määrää.

Esimerkki: 5

idMerkkijonoPakollinen

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

Esimerkki: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedKokonaislukuPakollinen

Manuaalisesti varattu määrä.

Esimerkki: 2

on_handKokonaislukuPakollinen

Fyysinen varastomäärä.

Esimerkki: 10

reservedKokonaislukuPakollinen

Tilausten varaama määrä.

Esimerkki: 3

sellable_limitKokonaislukuPakollinen

Myyntiraja: -1 tarkoittaa rajatonta määrää ja 0 estää saatavilla olevan myynnin.

Esimerkki: 10

target_idMerkkijonoPakollinen

Toiminnon kohteena olevan tuotteen tai variantin tunniste.

Esimerkki: "example"

target_typeMerkkijonoPakollinen

Koskeeko toiminto tuotetta vai varianttia.

Rajoitukset

enum: ["product", "variant"]

Esimerkki: "product"

total_reservedKokonaislukuPakollinen

Varattu kokonaismäärä.

Esimerkki: 5

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

Hae · Varastosaldot — Varastosaldot — Vastaus

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

activeTotuusarvoPakollinen

Onko resurssi aktiivinen.

Esimerkki: true

allocationsTaulukko <AllocationData > Pakollinen

Varastosijainneille kohdistetut määrät.

Esimerkki: [{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}]

availableKokonaisluku nullPakollinen

Myyntiin käytettävissä oleva määrä; null tarkoittaa rajatonta määrää.

Esimerkki: 5

idMerkkijonoPakollinen

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

Esimerkki: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedKokonaislukuPakollinen

Manuaalisesti varattu määrä.

Esimerkki: 2

on_handKokonaislukuPakollinen

Fyysinen varastomäärä.

Esimerkki: 10

reservedKokonaislukuPakollinen

Tilausten varaama määrä.

Esimerkki: 3

sellable_limitKokonaislukuPakollinen

Myyntiraja: -1 tarkoittaa rajatonta määrää ja 0 estää saatavilla olevan myynnin.

Esimerkki: 10

target_idMerkkijonoPakollinen

Toiminnon kohteena olevan tuotteen tai variantin tunniste.

Esimerkki: "example"

target_typeMerkkijonoPakollinen

Koskeeko toiminto tuotetta vai varianttia.

Rajoitukset

enum: ["product", "variant"]

Esimerkki: "product"

total_reservedKokonaislukuPakollinen

Varattu kokonaismäärä.

Esimerkki: 5

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