Duomenų schemos: Atsargos

Duomenų schemos: Atsargos. API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

Duomenų schemos

Sandėlio vietoms priskirti kiekiai

AllocationData · Schema · Duomenų schemos: Atsargos

location_codeEilutėPrivalomas: Sandėlio vietos kodas.

Pavyzdys: "example"
location_idEilutėPrivalomas: Sandėlio vietos identifikatorius.

Pavyzdys: "example"
location_nameEilutėPrivalomas: Sandėlio vietos pavadinimas.

Pavyzdys: "example"
on_handSveikasis skaičiusPrivalomas: Fizinis atsargų kiekis.

Pavyzdys: 10

Papildomi laukai: Ne

Sąrašas · Atsargos — Atsargos — Atsakymas

ApiResponse_list_StockData__ · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

dataMasyvas <StockData > Privalomas: Atsakymo pavyzdys · ApiResponse_list_StockData__.

Pavyzdys: [{"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 Privalomas: Atsakymo metaduomenys.

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

Papildomi laukai: Ne

Gauti · Atsargos — Atsargos — Atsakymas

ApiResponse_StockDetailData_ · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

dataStockDetailData Privalomas: Atsakymo pavyzdys · StockDetailData.

Pavyzdys: {"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 Privalomas: Atsakymo metaduomenys.

Pavyzdys: {"request_id":"example"}

Papildomi laukai: Ne

Atnaujinti · Rankinis rezervavimas — Atsargos — Užklausos turinys

ManualReservationUpdate · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

expected_versionSveikasis skaičiusPrivalomas: Prieš įrašant perskaityta versija; neatitikimas atmeta pakeitimą.

minimum: 1maximum: 9223372036854775807

Pavyzdys: 1
manual_reservedSveikasis skaičiusPrivalomas: Rankiniu būdu rezervuotas kiekis.

minimum: 0maximum: 2147483647

Pavyzdys: 1
reasonEilutėNeprivalomas: Užregistruota pakeitimo priežastis.

maxLength: 500

Numatytoji reikšmė: ""

Papildomi laukai: Ne

Atnaujinti · Pardavimo limitas — Atsargos — Užklausos turinys

SalesLimitUpdate · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

expected_versionSveikasis skaičiusPrivalomas: Prieš įrašant perskaityta versija; neatitikimas atmeta pakeitimą.

minimum: 1maximum: 9223372036854775807

Pavyzdys: 1
reasonEilutėNeprivalomas: Užregistruota pakeitimo priežastis.

maxLength: 500

Numatytoji reikšmė: ""
sellable_limitSveikasis skaičiusPrivalomas: Pardavimo riba: -1 reiškia neribotą kiekį, 0 išjungia galimą pardavimą.

minimum: -1maximum: 2147483647

Pavyzdys: 1

Papildomi laukai: Ne

Sukurti · Atsargų koregavimas — Atsargos — Užklausos turinys

StockAdjustmentCreate · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

expected_versionSveikasis skaičiusPrivalomas

Prieš įrašant perskaityta versija; neatitikimas atmeta pakeitimą.

minimum: 0maximum: 9223372036854775807

Pavyzdys: 0

locationsMasyvas <LocationQuantity > Privalomas

Sandėlio vietos.

minItems: 1maxItems: 100

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

reasonEilutėPrivalomas

Užregistruota pakeitimo priežastis.

minLength: 1maxLength: 500

Pavyzdys: "Example"

target_idEilutėPrivalomas

Operacijos paveikto produkto arba varianto identifikatorius.

Apribojimai

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

Pavyzdys: "example"

target_typeEilutėPrivalomas

Ar operacija skirta produktui, ar variantui.

Apribojimai

enum: ["product", "variant"]

Pavyzdys: "product"

warehouse_idEilutėPrivalomas

Sandėlio identifikatorius.

Apribojimai

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

Pavyzdys: "example"

Papildomi laukai: Ne

Atnaujinti · Atsargos — Atsargos — Užklausos turinys

StockAdjustmentUpdate · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

expected_versionSveikasis skaičiusPrivalomas: Prieš įrašant perskaityta versija; neatitikimas atmeta pakeitimą.

minimum: 1maximum: 9223372036854775807

Pavyzdys: 1
locationsMasyvas <LocationQuantity > Privalomas: Sandėlio vietos.

minItems: 1maxItems: 100

Pavyzdys: [{"location_id":"example","on_hand":1}]
reasonEilutėPrivalomas: Užregistruota pakeitimo priežastis.

minLength: 1maxLength: 500

Pavyzdys: "Example"

Papildomi laukai: Ne

Sąrašas · Atsargos — Atsargos — Atsakymas

StockData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

activeLoginė reikšmėPrivalomas

Ar išteklius aktyvus.

Pavyzdys: true

availableSveikasis skaičius nullPrivalomas

Parduodamas kiekis; null reiškia neribotą kiekį.

Pavyzdys: 5

idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. (StockData).

Pavyzdys: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedSveikasis skaičiusPrivalomas

Rankiniu būdu rezervuotas kiekis.

Pavyzdys: 2

on_handSveikasis skaičiusPrivalomas

Fizinis atsargų kiekis.

Pavyzdys: 10

reservedSveikasis skaičiusPrivalomas

Užsakymų rezervuotas kiekis.

Pavyzdys: 3

sellable_limitSveikasis skaičiusPrivalomas

Pardavimo riba: -1 reiškia neribotą kiekį, 0 išjungia galimą pardavimą.

Pavyzdys: 10

target_idEilutėPrivalomas

Operacijos paveikto produkto arba varianto identifikatorius.

Pavyzdys: "example"

target_typeEilutėPrivalomas

Ar operacija skirta produktui, ar variantui.

Apribojimai

enum: ["product", "variant"]

Pavyzdys: "product"

total_reservedSveikasis skaičiusPrivalomas

Bendras rezervuotas kiekis.

Pavyzdys: 5

updated_atEilutėPrivalomas

Paskutinio atnaujinimo laikas.

format: "date-time"

Pavyzdys: "2026-01-01T12:00:00Z"

versionSveikasis skaičiusPrivalomas

Ištekliaus versija lygiagrečių pakeitimų kontrolei.

Pavyzdys: 1

warehouse_idEilutėPrivalomas

Sandėlio identifikatorius.

Pavyzdys: "example"

Papildomi laukai: Ne

Gauti · Atsargos — Atsargos — Atsakymas

StockDetailData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

activeLoginė reikšmėPrivalomas

Ar išteklius aktyvus.

Pavyzdys: true

allocationsMasyvas <AllocationData > Privalomas

Sandėlio vietoms priskirti kiekiai.

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

availableSveikasis skaičius nullPrivalomas

Parduodamas kiekis; null reiškia neribotą kiekį.

Pavyzdys: 5

idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. (StockDetailData).

Pavyzdys: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedSveikasis skaičiusPrivalomas

Rankiniu būdu rezervuotas kiekis.

Pavyzdys: 2

on_handSveikasis skaičiusPrivalomas

Fizinis atsargų kiekis.

Pavyzdys: 10

reservedSveikasis skaičiusPrivalomas

Užsakymų rezervuotas kiekis.

Pavyzdys: 3

sellable_limitSveikasis skaičiusPrivalomas

Pardavimo riba: -1 reiškia neribotą kiekį, 0 išjungia galimą pardavimą.

Pavyzdys: 10

target_idEilutėPrivalomas

Operacijos paveikto produkto arba varianto identifikatorius.

Pavyzdys: "example"

target_typeEilutėPrivalomas

Ar operacija skirta produktui, ar variantui.

Apribojimai

enum: ["product", "variant"]

Pavyzdys: "product"

total_reservedSveikasis skaičiusPrivalomas

Bendras rezervuotas kiekis.

Pavyzdys: 5

updated_atEilutėPrivalomas

Paskutinio atnaujinimo laikas.

format: "date-time"

Pavyzdys: "2026-01-01T12:00:00Z"

versionSveikasis skaičiusPrivalomas

Ištekliaus versija lygiagrečių pakeitimų kontrolei.

Pavyzdys: 1

warehouse_idEilutėPrivalomas

Sandėlio identifikatorius.

Pavyzdys: "example"

Papildomi laukai: Ne