Andmeskeemid: Laoseis

Andmeskeemid: Laoseis. API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

Andmeskeemid

Laoasukohtadele määratud kogused

AllocationData · Skeem · Andmeskeemid: Laoseis

location_codeStringKohustuslik: Laoasukoha kood.

Näide: "example"
location_idStringKohustuslik: Laoasukoha identifikaator.

Näide: "example"
location_nameStringKohustuslik: Laoasukoha nimi.

Näide: "example"
on_handTäisarvKohustuslik: Füüsiline laokogus.

Näide: 10

Lisaväljad: Ei

Loend · Laoseis — Laoseis — Vastus

ApiResponse_list_StockData__ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

dataMassiiv <StockData > Kohustuslik: Vastuse näide · ApiResponse_list_StockData__.

Näide: [{"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 Kohustuslik: Vastuse metaandmed.

Näide: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Lisaväljad: Ei

Hangi · Laoseis — Laoseis — Vastus

ApiResponse_StockDetailData_ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

dataStockDetailData Kohustuslik: Vastuse näide · StockDetailData.

Näide: {"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 Kohustuslik: Vastuse metaandmed.

Näide: {"request_id":"example"}

Lisaväljad: Ei

Muuda · Käsitsi broneering — Laoseis — Päringu sisu

ManualReservationUpdate · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

expected_versionTäisarvKohustuslik: Enne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.

minimum: 1maximum: 9223372036854775807

Näide: 1
manual_reservedTäisarvKohustuslik: Käsitsi reserveeritud kogus.

minimum: 0maximum: 2147483647

Näide: 1
reasonStringValikuline: Muudatuse juurde salvestatud põhjus.

maxLength: 500

Vaikeväärtus: ""

Lisaväljad: Ei

Muuda · Müügilimiit — Laoseis — Päringu sisu

SalesLimitUpdate · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

expected_versionTäisarvKohustuslik: Enne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.

minimum: 1maximum: 9223372036854775807

Näide: 1
reasonStringValikuline: Muudatuse juurde salvestatud põhjus.

maxLength: 500

Vaikeväärtus: ""
sellable_limitTäisarvKohustuslik: Müügipiirang: -1 tähendab piiramatut kogust ja 0 keelab müügi.

minimum: -1maximum: 2147483647

Näide: 1

Lisaväljad: Ei

Loo · Laoseisu korrigeerimine — Laoseis — Päringu sisu

StockAdjustmentCreate · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

expected_versionTäisarvKohustuslik

Enne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.

minimum: 0maximum: 9223372036854775807

Näide: 0

locationsMassiiv <LocationQuantity > Kohustuslik

Laoasukohtade loend.

minItems: 1maxItems: 100

Näide: [{"location_id":"example","on_hand":1}]

reasonStringKohustuslik

Muudatuse juurde salvestatud põhjus.

minLength: 1maxLength: 500

Näide: "Example"

target_idStringKohustuslik

Toimingust mõjutatud toote või variandi identifikaator.

Piirangud

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

Näide: "example"

target_typeStringKohustuslik

Kas toiming puudutab toodet või varianti.

Piirangud

enum: ["product", "variant"]

Näide: "product"

warehouse_idStringKohustuslik

Lao identifikaator.

Piirangud

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

Näide: "example"

Lisaväljad: Ei

Muuda · Laoseis — Laoseis — Päringu sisu

StockAdjustmentUpdate · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

expected_versionTäisarvKohustuslik: Enne muutmist loetud versioon; erinevuse korral lükatakse muudatus tagasi.

minimum: 1maximum: 9223372036854775807

Näide: 1
locationsMassiiv <LocationQuantity > Kohustuslik: Laoasukohtade loend.

minItems: 1maxItems: 100

Näide: [{"location_id":"example","on_hand":1}]
reasonStringKohustuslik: Muudatuse juurde salvestatud põhjus.

minLength: 1maxLength: 500

Näide: "Example"

Lisaväljad: Ei

Loend · Laoseis — Laoseis — Vastus

StockData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

activeTõeväärtusKohustuslik

Kas ressurss on aktiivne.

Näide: true

availableTäisarv nullKohustuslik

Müügiks saadaolev kogus; null tähistab piiramatut kogust.

Näide: 5

idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul. (StockData).

Näide: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedTäisarvKohustuslik

Käsitsi reserveeritud kogus.

Näide: 2

on_handTäisarvKohustuslik

Füüsiline laokogus.

Näide: 10

reservedTäisarvKohustuslik

Tellimustega reserveeritud kogus.

Näide: 3

sellable_limitTäisarvKohustuslik

Müügipiirang: -1 tähendab piiramatut kogust ja 0 keelab müügi.

Näide: 10

target_idStringKohustuslik

Toimingust mõjutatud toote või variandi identifikaator.

Näide: "example"

target_typeStringKohustuslik

Kas toiming puudutab toodet või varianti.

Piirangud

enum: ["product", "variant"]

Näide: "product"

total_reservedTäisarvKohustuslik

Reserveeritud kogus kokku.

Näide: 5

updated_atStringKohustuslik

Viimase uuendamise aeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"

versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

Näide: 1

warehouse_idStringKohustuslik

Lao identifikaator.

Näide: "example"

Lisaväljad: Ei

Hangi · Laoseis — Laoseis — Vastus

StockDetailData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

activeTõeväärtusKohustuslik

Kas ressurss on aktiivne.

Näide: true

allocationsMassiiv <AllocationData > Kohustuslik

Laoasukohtadele määratud kogused.

Näide: [{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}]

availableTäisarv nullKohustuslik

Müügiks saadaolev kogus; null tähistab piiramatut kogust.

Näide: 5

idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul. (StockDetailData).

Näide: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedTäisarvKohustuslik

Käsitsi reserveeritud kogus.

Näide: 2

on_handTäisarvKohustuslik

Füüsiline laokogus.

Näide: 10

reservedTäisarvKohustuslik

Tellimustega reserveeritud kogus.

Näide: 3

sellable_limitTäisarvKohustuslik

Müügipiirang: -1 tähendab piiramatut kogust ja 0 keelab müügi.

Näide: 10

target_idStringKohustuslik

Toimingust mõjutatud toote või variandi identifikaator.

Näide: "example"

target_typeStringKohustuslik

Kas toiming puudutab toodet või varianti.

Piirangud

enum: ["product", "variant"]

Näide: "product"

total_reservedTäisarvKohustuslik

Reserveeritud kogus kokku.

Näide: 5

updated_atStringKohustuslik

Viimase uuendamise aeg.

format: "date-time"

Näide: "2026-01-01T12:00:00Z"

versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

Näide: 1

warehouse_idStringKohustuslik

Lao identifikaator.

Näide: "example"

Lisaväljad: Ei