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

ApiResponse[CodeContentData]

ApiResponse_CodeContentData_ · Kodas grąžinamas kaip JSON, failas — dvejetainiais duomenimis. Kiekvienai užklausai reikia Bearer ir reveal teisės.

dataCodeContentData Privalomas: Sėkmingo atsakymo duomenys.

Pavyzdys: {"code":"DEMO-ONE","delivery_id":null,"kind":"code","payload_id":"00000000-0000-4000-8000-000000000004","unit_id":"00000000-0000-4000-8000-000000000003"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Privalomas: Atsakymo metaduomenys.

Pavyzdys: {"request_id":"example-request"}

Papildomi laukai: Ne

ApiResponse[DigitalUploadData]

ApiResponse_DigitalUploadData_ · Patikrinkite dydį, kontrolinę sumą ir formatą. Baigtas įkėlimas dar nereiškia priimto pristatymo.

dataDigitalUploadData Privalomas: Sėkmingo atsakymo duomenys.

Pavyzdys: {"consumer_id":"00000000-0000-4000-8000-000000000001","consumer_kind":"digital_import","expires_at":"2026-11-03T13:00:00Z","filename":"codes.txt","id":"00000000-0000-4000-8000-000000000002","product_id":"example","purpose":"digital_import","received_bytes":18,"sha256":"636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a","size_bytes":18,"status":"ready"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Privalomas: Atsakymo metaduomenys.

Pavyzdys: {"request_id":"example-request"}

Papildomi laukai: Ne

ApiResponse[ImportData]

ApiResponse_ImportData_ · Patikrinkite būseną, versiją ir patikros rezultatą. Juodraštis priklauso jį sukūrusiam API raktui.

dataImportData Privalomas: Sėkmingo atsakymo duomenys.

Pavyzdys: {"delivery_id":null,"delivery_status":null,"delivery_version":null,"expected_count":2,"expires_at":"2026-11-03T13:00:00Z","id":"00000000-0000-4000-8000-000000000001","kind":"code","product_id":"example","status":"validated","validated_count":2,"validation_digest":"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb","version":2}
metaContextPageMeta ContextMeta PageMeta RequestMeta Privalomas: Atsakymo metaduomenys.

Pavyzdys: {"request_id":"example-request"}

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

ApiResponse[PoolData]

ApiResponse_PoolData_ · Prieš keitimą perskaitykite nustatymus ir kiekius. Atsakyme nėra kodų ar failų turinio.

dataPoolData Privalomas: Sėkmingo atsakymo duomenys.

Pavyzdys: {"configured":true,"counts":{"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0},"email_mode":"order_link","enabled":true,"order_version":2,"product_id":"example","retention_days":null,"version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Privalomas: Atsakymo metaduomenys.

Pavyzdys: {"request_id":"example-request"}

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

ApiResponse[UnitsData]

ApiResponse_UnitsData_ · Gaukite iki 100 vienetų puslapyje. Sąraše pateikiami metaduomenys neatskleidžiant kodų.

dataUnitsData Privalomas: Sėkmingo atsakymo duomenys.

Pavyzdys: {"order_version":2,"total":1,"units":[{"content_state":"present","delivery_id":"delivery-example","filename":null,"id":"00000000-0000-4000-8000-000000000003","issued_at":null,"kind":"code","location_id":"location-digital","mime_type":null,"payload_id":"00000000-0000-4000-8000-000000000004","product_id":"example","size_bytes":null,"sort_order":1,"state":"available","version":1,"warehouse_id":"warehouse-main"}]}
metaContextPageMeta ContextMeta PageMeta RequestMeta Privalomas: Atsakymo metaduomenys.

Pavyzdys: {"pagination":{"has_more":false,"limit":50,"next_cursor":null},"request_id":"example-request"}

Papildomi laukai: Ne

CodeContentData

CodeContentData · Kodas grąžinamas kaip JSON, failas — dvejetainiais duomenimis. Kiekvienai užklausai reikia Bearer ir reveal teisės.

codeEilutėPrivalomas: Tikslus skaitmeninio kodo tekstas. Išlaikykite raidžių registrą ir vidinius tarpus.

minLength: 1maxLength: 512

Pavyzdys: "DEMO-ONE"
delivery_idEilutė nullNeprivalomas: Pristatymo arba užsakymo priskyrimo ID.

Eilutė:format: "uuid"

Pavyzdys: null
kindEilutėNeprivalomas: Duomenų struktūros atmaina, apibrėžta leidžiamomis reikšmėmis.

const: "code"

Numatytoji reikšmė: "code"Pavyzdys: "code"
payload_idEilutėPrivalomas: Turinio ID; ne viešas atsisiuntimo URL.

format: "uuid"

Pavyzdys: "00000000-0000-4000-8000-000000000004"
unit_idEilutėPrivalomas: Vieno individualaus kodo arba failo ID.

format: "uuid"

Pavyzdys: "00000000-0000-4000-8000-000000000003"

Papildomi laukai: Ne

DigitalUploadCreate

DigitalUploadCreate · Rezervuokite vietą failui ir susiekite jį su importu ar keičiamu vienetu.

consumer_idEilutėPrivalomas

Susieto importo arba vieneto ID.

format: "uuid"

Pavyzdys: "00000000-0000-4000-8000-000000000001"

consumer_kindEilutėPrivalomas

Įkėlimo sąsaja: digital_import / digital_unit.

Apribojimai

enum: ["digital_import", "digital_unit"]

Pavyzdys: "digital_import"

filenameEilutėPrivalomas

Failas

minLength: 1maxLength: 255

Pavyzdys: "codes.txt"

purposeEilutėPrivalomas

digital_import: TXT/CSV; digital_unit: atskirai parduodamas failas.

Apribojimai

enum: ["digital_unit", "digital_import"]

Pavyzdys: "digital_import"

sha256EilutėPrivalomas

SHA-256 (hex, 64)

Apribojimai

pattern: "^[0-9a-f]{64}$"

Pavyzdys: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesSveikasis skaičiusPrivalomas

Dydis baitais

minimum: 1maximum: 262144000

Pavyzdys: 18

Papildomi laukai: Ne

DigitalUploadData

DigitalUploadData · Patikrinkite dydį, kontrolinę sumą ir formatą. Baigtas įkėlimas dar nereiškia priimto pristatymo.

consumer_idEilutėPrivalomas

Susieto importo arba vieneto ID.

format: "uuid"

Pavyzdys: "00000000-0000-4000-8000-000000000001"

consumer_kindEilutėPrivalomas

Įkėlimo sąsaja: digital_import / digital_unit.

Apribojimai

enum: ["digital_import", "digital_unit"]

Pavyzdys: "digital_import"

expires_atEilutėPrivalomas

Šio įkėlimo arba importo galiojimo laikas.

format: "date-time"

Pavyzdys: "2026-11-03T13:00:00Z"

filenameEilutėPrivalomas

Failas

Pavyzdys: "codes.txt"

idEilutėPrivalomas

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

format: "uuid"

Pavyzdys: "00000000-0000-4000-8000-000000000002"

product_idEilutėPrivalomas

Produkto identifikatorius.

Pavyzdys: "example"

purposeEilutėPrivalomas

digital_import: TXT/CSV; digital_unit: atskirai parduodamas failas.

Apribojimai

enum: ["digital_unit", "digital_import"]

Pavyzdys: "digital_import"

received_bytesSveikasis skaičiusPrivalomas

Įkeliama… · Dydis baitais

Pavyzdys: 18

sha256EilutėPrivalomas

SHA-256 (hex, 64)

Pavyzdys: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesSveikasis skaičiusPrivalomas

Dydis baitais

Pavyzdys: 18

statusEilutėPrivalomas

Šios konkrečios operacijos priimama būsena.

Pavyzdys: "ready"

Papildomi laukai: Ne

ImportCommit

ImportCommit · Sukurkite planuojamą arba gautą pristatymą iš patikrintos partijos. Planuojamų vienetų dar negalima parduoti.

delivered_atEilutėPrivalomas

Pristatymo data ir laikas.

format: "date-time"

Pavyzdys: "2026-11-03T12:00:00Z"

expected_delivery_versionSveikasis skaičiusPrivalomas

Pristatymo versija; naujam pristatymui 0.

minimum: 0maximum: 0

Pavyzdys: 0

expected_sales_limit_versionSveikasis skaičius nullNeprivalomas

Pardavimo limito versija; būtina su publish_for_sale=true.

Sveikasis skaičius:minimum: 0maximum: 9223372036854775807

Pavyzdys: 0

expected_versionSveikasis skaičiusPrivalomas

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

minimum: 1maximum: 9223372036854775807

Pavyzdys: 2

location_idEilutėPrivalomas

Sandėlio vietos identifikatorius.

Apribojimai

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

Pavyzdys: "location-digital"

publish_for_saleLoginė reikšmėNeprivalomas

true taip pat padidina baigtinį pardavimo limitą; false jo nekeičia.

Numatytoji reikšmė: falsePavyzdys: true

statusEilutėPrivalomas

Šios konkrečios operacijos priimama būsena.

Apribojimai

enum: ["planned", "received"]

Pavyzdys: "received"

validation_digestEilutėPrivalomas

Patikros kontrolinė suma; patvirtinimui perduokite nepakeistą.

Apribojimai

pattern: "^[0-9a-f]{64}$"

Pavyzdys: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

warehouse_idEilutėPrivalomas

Sandėlio identifikatorius.

Apribojimai

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

Pavyzdys: "warehouse-main"

Papildomi laukai: Ne

ImportCreate

ImportCreate · Paruoškite juodraštį su iki 1000 kodų arba 100 failų. Parduodamos atsargos dar nepadidėja.

countSveikasis skaičiusPrivalomas

Tikslus vienetų skaičius partijoje.

minimum: 1maximum: 1000

Pavyzdys: 2

kindEilutėPrivalomas

Duomenų struktūros atmaina, apibrėžta leidžiamomis reikšmėmis.

Apribojimai

enum: ["code", "file"]

Pavyzdys: "code"

Papildomi laukai: Ne

ImportData

ImportData · Patikrinkite būseną, versiją ir patikros rezultatą. Juodraštis priklauso jį sukūrusiam API raktui.

delivery_idEilutė nullPrivalomas

Pristatymo arba užsakymo priskyrimo ID.

Pavyzdys: null

delivery_statusEilutė nullPrivalomas

Pristatymo būsena: planned / received; prieš patvirtinimą null.

Pavyzdys: null

delivery_versionSveikasis skaičius nullPrivalomas

Dabartinė sandėlio pristatymo versija.

Pavyzdys: null

expected_countSveikasis skaičiusPrivalomas

Numatomas skaičius; priimama tik visa partija.

Pavyzdys: 2

expires_atEilutėPrivalomas

Šio įkėlimo arba importo galiojimo laikas.

format: "date-time"

Pavyzdys: "2026-11-03T13:00:00Z"

idEilutėPrivalomas

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

format: "uuid"

Pavyzdys: "00000000-0000-4000-8000-000000000001"

kindEilutėPrivalomas

Duomenų struktūros atmaina, apibrėžta leidžiamomis reikšmėmis.

Apribojimai

enum: ["code", "file"]

Pavyzdys: "code"

product_idEilutėPrivalomas

Produkto identifikatorius.

Pavyzdys: "example"

statusEilutėPrivalomas

Šios konkrečios operacijos priimama būsena.

Pavyzdys: "validated"

validated_countSveikasis skaičiusPrivalomas

Per paskutinę sėkmingą patikrą priimtų vienetų skaičius.

Pavyzdys: 2

validation_digestEilutė nullPrivalomas

Patikros kontrolinė suma; patvirtinimui perduokite nepakeistą.

Pavyzdys: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

versionSveikasis skaičiusPrivalomas

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

Pavyzdys: 2

Papildomi laukai: Ne

ImportReceive

ImportReceive · Priimkite esamus vienetus iš naujo neimportuodami kodų ar failų.

expected_delivery_versionSveikasis skaičiusPrivalomas: Pristatymo versija; naujam pristatymui 0.

minimum: 1maximum: 9223372036854775807

Pavyzdys: 1
expected_sales_limit_versionSveikasis skaičius nullNeprivalomas: Pardavimo limito versija; būtina su publish_for_sale=true.

Sveikasis skaičius:minimum: 0maximum: 9223372036854775807
expected_versionSveikasis skaičiusPrivalomas: Prieš įrašant perskaityta versija; neatitikimas atmeta pakeitimą.

minimum: 1maximum: 9223372036854775807

Pavyzdys: 3
publish_for_saleLoginė reikšmėNeprivalomas: true taip pat padidina baigtinį pardavimo limitą; false jo nekeičia.

Numatytoji reikšmė: false

Papildomi laukai: Ne

ImportValidate

ImportValidate · Patikrinkite visą partiją. Dublikatas ar netinkamas įrašas atmeta partiją; kodai netrumpinami.

code_columnEilutė nullNeprivalomas

CSV stulpelis su kodais; naudokite code.

Eilutė:const: "code"

expected_versionSveikasis skaičiusPrivalomas

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

minimum: 1maximum: 9223372036854775807

Pavyzdys: 1

formatEilutė nullNeprivalomas

Kodų sąrašas: txt / csv; failams naudokite upload_ids.

Apribojimai · Eilutė 1

enum: ["txt", "csv"]

Pavyzdys: "txt"

source_upload_idEilutė nullNeprivalomas

Šio importo paruoštas privatus TXT/CSV įkėlimas.

Eilutė:format: "uuid"

Pavyzdys: "00000000-0000-4000-8000-000000000002"

upload_idsMasyvas <Eilutė> nullNeprivalomas

1–100 šio importo paruoštų privačių failų įkėlimų.

Masyvas:minItems: 1maxItems: 100

Masyvas / Masyvas:format: "uuid"

Papildomi laukai: Ne

ImportWithdrawal

ImportWithdrawal · Pašalinkite tik laisvus vienetus. Rezervuoti ir priskirti vienetai lieka susieti su užsakymais.

expected_delivery_versionSveikasis skaičiusPrivalomas: Pristatymo versija; naujam pristatymui 0.

minimum: 1maximum: 9223372036854775807

Pavyzdys: 1
expected_order_versionSveikasis skaičiusPrivalomas: Priskyrimo eilės versija, ne kliento užsakymo versija.

minimum: 0maximum: 9223372036854775807

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

minimum: 1maximum: 9223372036854775807

Pavyzdys: 3
reasonEilutėPrivalomas: Užregistruota pakeitimo priežastis.

minLength: 1maxLength: 500

Pavyzdys: "Withdraw a revoked license"

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

PoolChange

PoolChange · Įjunkite individualius kodus ar failus nuo Professional plano. Išjungimas išsaugo ankstesnių pirkimų prieigą.

email_modeEilutėNeprivalomas

disabled: be laiško; order_link: užsakymo nuoroda; code_text: galimi ir kodai.

Apribojimai

enum: ["disabled", "order_link", "code_text"]

Numatytoji reikšmė: "disabled"Pavyzdys: "order_link"

enabledLoginė reikšmėPrivalomas

Ar šis nustatymas įjungtas.

Pavyzdys: true

expected_versionSveikasis skaičiusPrivalomas

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

minimum: 0maximum: 9223372036854775807

Pavyzdys: 0

retention_daysSveikasis skaičius nullNeprivalomas

null: neribotai; 1–3650 dienų nuo pirmosios prieigos. Kodai automatiškai netrinami.

Sveikasis skaičius:minimum: 1maximum: 3650

Pavyzdys: null

Papildomi laukai: Ne

PoolCounts

PoolCounts · Prieš keitimą perskaitykite nustatymus ir kiekius. Atsakyme nėra kodų ar failų turinio.

availableSveikasis skaičiusPrivalomas: Laisvų vienetų, kurie nerezervuoti ir neišduoti, skaičius.

Pavyzdys: 1
heldSveikasis skaičiusPrivalomas: Užsakymams rezervuoti, dar neišduoti vienetai.

Pavyzdys: 0
issuedSveikasis skaičiusPrivalomas: Apmokėtiems pirkimams jau išduoti vienetai.

Pavyzdys: 1
plannedSveikasis skaičiusPrivalomas: Patvirtintų, dar nepriimtų pristatymų vienetai.

Pavyzdys: 0
retiredSveikasis skaičiusPrivalomas: Atšaukti vienetai, išsaugoti istorijoje.

Pavyzdys: 0
stagedSveikasis skaičiusPrivalomas: Nebaigtų importų vienetai, dar ne sandėlio atsargos.

Pavyzdys: 0

Papildomi laukai: Ne

PoolData

PoolData · Prieš keitimą perskaitykite nustatymus ir kiekius. Atsakyme nėra kodų ar failų turinio.

configuredLoginė reikšmėPrivalomas

Ar skaitmeninių atsargų nustatymai išsaugoti.

Pavyzdys: true

countsPoolCounts Privalomas

Vienetų skaičius pagal atsargų būseną.

Pavyzdys: {"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0}

email_modeEilutėPrivalomas

disabled: be laiško; order_link: užsakymo nuoroda; code_text: galimi ir kodai.

Apribojimai

enum: ["disabled", "order_link", "code_text"]

Pavyzdys: "order_link"

enabledLoginė reikšmėPrivalomas

Ar šis nustatymas įjungtas.

Pavyzdys: true

order_versionSveikasis skaičiusPrivalomas

Atsargų priskyrimo eilės versija.

Pavyzdys: 2

product_idEilutėPrivalomas

Produkto identifikatorius.

Pavyzdys: "example"

retention_daysSveikasis skaičius nullPrivalomas

null: neribotai; 1–3650 dienų nuo pirmosios prieigos. Kodai automatiškai netrinami.

Pavyzdys: null

versionSveikasis skaičiusPrivalomas

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

Pavyzdys: 1

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

UnitData

UnitData · Gaukite iki 100 vienetų puslapyje. Sąraše pateikiami metaduomenys neatskleidžiant kodų.

content_stateEilutėPrivalomas

Turinio būsena: present / deleting / deleted.

Pavyzdys: "present"

delivery_idEilutė nullPrivalomas

Pristatymo arba užsakymo priskyrimo ID.

Pavyzdys: "delivery-example"

filenameEilutė nullPrivalomas

Failas

Pavyzdys: null

idEilutėPrivalomas

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

format: "uuid"

Pavyzdys: "00000000-0000-4000-8000-000000000003"

issued_atEilutė nullPrivalomas

Pirmasis išdavimas; prieš jį null.

Eilutė:format: "date-time"

Pavyzdys: null

kindEilutėPrivalomas

Duomenų struktūros atmaina, apibrėžta leidžiamomis reikšmėmis.

Apribojimai

enum: ["file", "code"]

Pavyzdys: "code"

location_idEilutė nullPrivalomas

Sandėlio vietos identifikatorius.

Pavyzdys: "location-digital"

mime_typeEilutė nullPrivalomas

Medijos turinio tipas.

Pavyzdys: null

payload_idEilutėPrivalomas

Turinio ID; ne viešas atsisiuntimo URL.

format: "uuid"

Pavyzdys: "00000000-0000-4000-8000-000000000004"

product_idEilutėPrivalomas

Produkto identifikatorius.

Pavyzdys: "example"

size_bytesSveikasis skaičius nullPrivalomas

Dydis baitais

Pavyzdys: null

sort_orderSveikasis skaičiusPrivalomas

Pozicija surikiuotame rinkinyje.

Pavyzdys: 1

stateEilutėPrivalomas

Būsena

Pavyzdys: "available"

versionSveikasis skaičiusPrivalomas

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

Pavyzdys: 1

warehouse_idEilutė nullPrivalomas

Sandėlio identifikatorius.

Pavyzdys: "warehouse-main"

Papildomi laukai: Ne

UnitDeletion

UnitDeletion · Pašalinkite neparduotą kodą ar failą nurodydami priežastį. Rezervuoti ar priskirti vienetai atmetami.

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

minimum: 1

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

minLength: 1maxLength: 500

Pavyzdys: "Withdraw a revoked license"

Papildomi laukai: Ne

UnitReorder

UnitReorder · Siųskite visą nefiltruotą puslapį norima tvarka. Pasenusi versija grąžina 409.

expected_order_versionSveikasis skaičiusPrivalomas: Priskyrimo eilės versija, ne kliento užsakymo versija.

minimum: 1

Pavyzdys: 1
unit_idsMasyvas <Eilutė> Privalomas: Visi nefiltruoto puslapio vienetai pageidaujama tvarka.

minItems: 2maxItems: 100
Masyvas:format: "uuid"

Pavyzdys: ["00000000-0000-4000-8000-000000000008","00000000-0000-4000-8000-000000000003"]
window_cursorEilutė nullNeprivalomas: Nefiltruoto puslapio žymeklis; pirmam puslapiui null.

Eilutė:maxLength: 1024

Papildomi laukai: Ne

UnitReplacement

UnitReplacement · Pakeiskite kodą ar failą nekeisdami eilės. Pakeitimas išlieka sandėlio istorijoje.

codeEilutė nullNeprivalomas: Tikslus skaitmeninio kodo tekstas. Išlaikykite raidžių registrą ir vidinius tarpus.

Eilutė:minLength: 1maxLength: 512

Pavyzdys: "SYNTHETIC-REPLACEMENT"
expected_versionSveikasis skaičiusPrivalomas: Prieš įrašant perskaityta versija; neatitikimas atmeta pakeitimą.

minimum: 1

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

minLength: 1maxLength: 500

Pavyzdys: "Replace an invalid activation code"
upload_idEilutė nullNeprivalomas: Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. · upload_id

Eilutė:format: "uuid"

Papildomi laukai: Ne

UnitsData

UnitsData · Gaukite iki 100 vienetų puslapyje. Sąraše pateikiami metaduomenys neatskleidžiant kodų.

order_versionSveikasis skaičiusPrivalomas: Atsargų priskyrimo eilės versija.

Pavyzdys: 2
totalSveikasis skaičiusPrivalomas: Bendra suma.

Pavyzdys: 1
unitsMasyvas <UnitData > Privalomas: Vienetų metaduomenys; turiniui reikia atskiros įgaliotos užklausos.

Pavyzdys: [{"content_state":"present","delivery_id":"delivery-example","filename":null,"id":"00000000-0000-4000-8000-000000000003","issued_at":null,"kind":"code","location_id":"location-digital","mime_type":null,"payload_id":"00000000-0000-4000-8000-000000000004","product_id":"example","size_bytes":null,"sort_order":1,"state":"available","version":1,"warehouse_id":"warehouse-main"}]

Papildomi laukai: Taip