Mine sisu juurde
ShopentlyLearn

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

ApiResponse[CodeContentData]

ApiResponse_CodeContentData_ · Kood tagastatakse JSON-ina, fail binaarselt. Iga päring vajab Bearerit ja õigust reveal.
dataCodeContentData Kohustuslik

Eduka vastuse andmed.

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

Vastuse metaandmed.

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

Lisaväljad: Ei

ApiResponse[DigitalUploadData]

ApiResponse_DigitalUploadData_ · Kontrolli suurust, kontrollsummat ja vormingut. Valmis üleslaadimine ei tähenda veel vastuvõetud tarnet.
dataDigitalUploadData Kohustuslik

Eduka vastuse andmed.

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

Vastuse metaandmed.

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

Lisaväljad: Ei

ApiResponse[ImportData]

ApiResponse_ImportData_ · Kontrolli olekut, versiooni ja valideerimist. Mustand kuulub selle loonud API-võtmele.
dataImportData Kohustuslik

Eduka vastuse andmed.

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

Vastuse metaandmed.

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

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

ApiResponse[PoolData]

ApiResponse_PoolData_ · Loe seadeid ja koguseid enne muutmist. Vastus ei sisalda koode ega failide sisu.
dataPoolData Kohustuslik

Eduka vastuse andmed.

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

Vastuse metaandmed.

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

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

ApiResponse[UnitsData]

ApiResponse_UnitsData_ · Loe kuni 100 ühikut lehel. Loend näitab metaandmeid koode avaldamata.
dataUnitsData Kohustuslik

Eduka vastuse andmed.

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

Vastuse metaandmed.

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

Lisaväljad: Ei

CodeContentData

CodeContentData · Kood tagastatakse JSON-ina, fail binaarselt. Iga päring vajab Bearerit ja õigust reveal.
codeStringKohustuslik

Digitaalse koodi täpne sisu. Säilita tõstutundlikkus ja koodis olevad tühikud.

minLength: 1maxLength: 512
Näide: "DEMO-ONE"
delivery_idString nullValikuline

Tarne või tellimuse väljastuse ID.

String:format: "uuid"
Näide: null
kindStringValikuline

Andmestruktuuri variant, mida kirjeldavad lubatud väärtused.

const: "code"
Vaikeväärtus: "code"Näide: "code"
payload_idStringKohustuslik

Sisu ID; ei ole avalik allalaadimis-URL.

format: "uuid"
Näide: "00000000-0000-4000-8000-000000000004"
unit_idStringKohustuslik

Ühe individuaalse koodi või faili ID.

format: "uuid"
Näide: "00000000-0000-4000-8000-000000000003"

Lisaväljad: Ei

DigitalUploadCreate

DigitalUploadCreate · Broneeri failile ruum ja seo see impordi või asendatava ühikuga.
consumer_idStringKohustuslik

Seotud impordi või ühiku ID.

format: "uuid"
Näide: "00000000-0000-4000-8000-000000000001"
consumer_kindStringKohustuslik

Üleslaadimise seos: digital_import / digital_unit.

Piirangud
enum
["digital_import", "digital_unit"]
Näide: "digital_import"
filenameStringKohustuslik

Fail

minLength: 1maxLength: 255
Näide: "codes.txt"
purposeStringKohustuslik

digital_import: TXT/CSV; digital_unit: eraldi müüdav fail.

Piirangud
enum
["digital_unit", "digital_import"]
Näide: "digital_import"
sha256StringKohustuslik

SHA-256 (hex, 64)

Piirangud
pattern
"^[0-9a-f]{64}$"
Näide: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"
size_bytesTäisarvKohustuslik

Suurus baitides

minimum: 1maximum: 262144000
Näide: 18

Lisaväljad: Ei

DigitalUploadData

DigitalUploadData · Kontrolli suurust, kontrollsummat ja vormingut. Valmis üleslaadimine ei tähenda veel vastuvõetud tarnet.
consumer_idStringKohustuslik

Seotud impordi või ühiku ID.

format: "uuid"
Näide: "00000000-0000-4000-8000-000000000001"
consumer_kindStringKohustuslik

Üleslaadimise seos: digital_import / digital_unit.

Piirangud
enum
["digital_import", "digital_unit"]
Näide: "digital_import"
expires_atStringKohustuslik

Selle üleslaadimise või impordi aegumisaeg.

format: "date-time"
Näide: "2026-11-03T13:00:00Z"
filenameStringKohustuslik

Fail

Näide: "codes.txt"
idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul.

format: "uuid"
Näide: "00000000-0000-4000-8000-000000000002"
product_idStringKohustuslik

Toote identifikaator.

Näide: "example"
purposeStringKohustuslik

digital_import: TXT/CSV; digital_unit: eraldi müüdav fail.

Piirangud
enum
["digital_unit", "digital_import"]
Näide: "digital_import"
received_bytesTäisarvKohustuslik

Üleslaadimine… · Suurus baitides

Näide: 18
sha256StringKohustuslik

SHA-256 (hex, 64)

Näide: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"
size_bytesTäisarvKohustuslik

Suurus baitides

Näide: 18
statusStringKohustuslik

Selle konkreetse toimingu lubatud olek.

Näide: "ready"

Lisaväljad: Ei

ImportCommit

ImportCommit · Loo kontrollitud partiist kavandatud või vastuvõetud tarne. Kavandatud ühikud pole veel müüdavad.
delivered_atStringKohustuslik

Tarne kuupäev ja kellaaeg.

format: "date-time"
Näide: "2026-11-03T12:00:00Z"
expected_delivery_versionTäisarvKohustuslik

Tarne versioon; uue tarne korral 0.

minimum: 0maximum: 0
Näide: 0
expected_sales_limit_versionTäisarv nullValikuline

Müügilimiidi versioon; nõutud publish_for_sale=true korral.

Täisarv:minimum: 0maximum: 9223372036854775807
Näide: 0
expected_versionTäisarvKohustuslik

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

minimum: 1maximum: 9223372036854775807
Näide: 2
location_idStringKohustuslik

Laoasukoha identifikaator.

Piirangud
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Näide: "location-digital"
publish_for_saleTõeväärtusValikuline

true suurendab ka lõplikku müügilimiiti; false ei muuda seda.

Vaikeväärtus: falseNäide: true
statusStringKohustuslik

Selle konkreetse toimingu lubatud olek.

Piirangud
enum
["planned", "received"]
Näide: "received"
validation_digestStringKohustuslik

Kontrolli kontrollsumma; saada kinnitamisel muutmata kujul.

Piirangud
pattern
"^[0-9a-f]{64}$"
Näide: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
warehouse_idStringKohustuslik

Lao identifikaator.

Piirangud
pattern
"^[a-z0-9][a-z0-9_-]{0,62}$"
Näide: "warehouse-main"

Lisaväljad: Ei

ImportCreate

ImportCreate · Loo mustand kuni 1000 koodi või 100 failiga. Müüdav varu veel ei suurene.
countTäisarvKohustuslik

Partii täpne ühikute arv.

minimum: 1maximum: 1000
Näide: 2
kindStringKohustuslik

Andmestruktuuri variant, mida kirjeldavad lubatud väärtused.

Piirangud
enum
["code", "file"]
Näide: "code"

Lisaväljad: Ei

ImportData

ImportData · Kontrolli olekut, versiooni ja valideerimist. Mustand kuulub selle loonud API-võtmele.
delivery_idString nullKohustuslik

Tarne või tellimuse väljastuse ID.

Näide: null
delivery_statusString nullKohustuslik

Tarne olek: planned / received; enne kinnitamist null.

Näide: null
delivery_versionTäisarv nullKohustuslik

Laotarne praegune versioon.

Näide: null
expected_countTäisarvKohustuslik

Oodatud arv; vastu võetakse ainult terve partii.

Näide: 2
expires_atStringKohustuslik

Selle üleslaadimise või impordi aegumisaeg.

format: "date-time"
Näide: "2026-11-03T13:00:00Z"
idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul.

format: "uuid"
Näide: "00000000-0000-4000-8000-000000000001"
kindStringKohustuslik

Andmestruktuuri variant, mida kirjeldavad lubatud väärtused.

Piirangud
enum
["code", "file"]
Näide: "code"
product_idStringKohustuslik

Toote identifikaator.

Näide: "example"
statusStringKohustuslik

Selle konkreetse toimingu lubatud olek.

Näide: "validated"
validated_countTäisarvKohustuslik

Viimases edukas kontrollis heaks kiidetud ühikute arv.

Näide: 2
validation_digestString nullKohustuslik

Kontrolli kontrollsumma; saada kinnitamisel muutmata kujul.

Näide: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

Näide: 2

Lisaväljad: Ei

ImportReceive

ImportReceive · Võta olemasolevad ühikud vastu koode või faile uuesti importimata.
expected_delivery_versionTäisarvKohustuslik

Tarne versioon; uue tarne korral 0.

minimum: 1maximum: 9223372036854775807
Näide: 1
expected_sales_limit_versionTäisarv nullValikuline

Müügilimiidi versioon; nõutud publish_for_sale=true korral.

Täisarv:minimum: 0maximum: 9223372036854775807
expected_versionTäisarvKohustuslik

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

minimum: 1maximum: 9223372036854775807
Näide: 3
publish_for_saleTõeväärtusValikuline

true suurendab ka lõplikku müügilimiiti; false ei muuda seda.

Vaikeväärtus: false

Lisaväljad: Ei

ImportValidate

ImportValidate · Kontrolli kogu partiid. Duplikaat või vigane kirje lükkab partii tagasi; koode ei kärbita.
code_columnString nullValikuline

Koode sisaldav CSV-veerg; kasuta code.

String:const: "code"
expected_versionTäisarvKohustuslik

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

minimum: 1maximum: 9223372036854775807
Näide: 1
formatString nullValikuline

Koodiloend: txt / csv; failidel kasuta upload_ids.

Piirangud · String 1
enum
["txt", "csv"]
Näide: "txt"
source_upload_idString nullValikuline

Selle impordi valmis privaatne TXT/CSV-üleslaadimine.

String:format: "uuid"
Näide: "00000000-0000-4000-8000-000000000002"
upload_idsMassiiv <String> nullValikuline

1–100 selle impordi valmis privaatset failiüleslaadimist.

Massiiv:minItems: 1maxItems: 100
Massiiv / Massiiv:format: "uuid"

Lisaväljad: Ei

ImportWithdrawal

ImportWithdrawal · Eemalda ainult vabad ühikud. Broneeritud ja väljastatud ühikud jäävad tellimustega seotuks.
expected_delivery_versionTäisarvKohustuslik

Tarne versioon; uue tarne korral 0.

minimum: 1maximum: 9223372036854775807
Näide: 1
expected_order_versionTäisarvKohustuslik

Väljastamise järjekorra versioon, mitte klienditellimuse versioon.

minimum: 0maximum: 9223372036854775807
Näide: 1
expected_versionTäisarvKohustuslik

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

minimum: 1maximum: 9223372036854775807
Näide: 3
reasonStringKohustuslik

Muudatuse juurde salvestatud põhjus.

minLength: 1maxLength: 500
Näide: "Withdraw a revoked license"

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

PoolChange

PoolChange · Luba individuaalsed koodid või failid alates Professionalist. Väljalülitamine säilitab varasemate ostude ligipääsu.
email_modeStringValikuline

disabled: kirja ei saadeta; order_link: tellimuse link; code_text: lisaks võimalikud koodid.

Piirangud
enum
["disabled", "order_link", "code_text"]
Vaikeväärtus: "disabled"Näide: "order_link"
enabledTõeväärtusKohustuslik

Kas see säte on lubatud.

Näide: true
expected_versionTäisarvKohustuslik

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

minimum: 0maximum: 9223372036854775807
Näide: 0
retention_daysTäisarv nullValikuline

null: tähtajatu; 1–3650 päeva esimesest ligipääsust. Koode automaatselt ei kustutata.

Täisarv:minimum: 1maximum: 3650
Näide: null

Lisaväljad: Ei

PoolCounts

PoolCounts · Loe seadeid ja koguseid enne muutmist. Vastus ei sisalda koode ega failide sisu.
availableTäisarvKohustuslik

Vabade üksuste arv, mida pole reserveeritud ega väljastatud.

Näide: 1
heldTäisarvKohustuslik

Tellimustele broneeritud, veel väljastamata ühikud.

Näide: 0
issuedTäisarvKohustuslik

Tasutud ostudele juba väljastatud ühikud.

Näide: 1
plannedTäisarvKohustuslik

Kinnitatud, veel vastuvõtmata tarnete ühikud.

Näide: 0
retiredTäisarvKohustuslik

Tagasivõetud ühikud, mis säilivad ajaloos.

Näide: 0
stagedTäisarvKohustuslik

Pooleliolevate importide ühikud, veel mitte laovaru.

Näide: 0

Lisaväljad: Ei

PoolData

PoolData · Loe seadeid ja koguseid enne muutmist. Vastus ei sisalda koode ega failide sisu.
configuredTõeväärtusKohustuslik

Kas digivaru seaded on salvestatud.

Näide: true
countsPoolCounts Kohustuslik

Ühikute arv laooleku kaupa.

Näide: {"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0}
email_modeStringKohustuslik

disabled: kirja ei saadeta; order_link: tellimuse link; code_text: lisaks võimalikud koodid.

Piirangud
enum
["disabled", "order_link", "code_text"]
Näide: "order_link"
enabledTõeväärtusKohustuslik

Kas see säte on lubatud.

Näide: true
order_versionTäisarvKohustuslik

Digivaru väljastamise järjekorra versioon.

Näide: 2
product_idStringKohustuslik

Toote identifikaator.

Näide: "example"
retention_daysTäisarv nullKohustuslik

null: tähtajatu; 1–3650 päeva esimesest ligipääsust. Koode automaatselt ei kustutata.

Näide: null
versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

Näide: 1

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

UnitData

UnitData · Loe kuni 100 ühikut lehel. Loend näitab metaandmeid koode avaldamata.
content_stateStringKohustuslik

Sisu olek: present / deleting / deleted.

Näide: "present"
delivery_idString nullKohustuslik

Tarne või tellimuse väljastuse ID.

Näide: "delivery-example"
filenameString nullKohustuslik

Fail

Näide: null
idStringKohustuslik

Ressursi identifikaator; säilita see tagastatud kujul.

format: "uuid"
Näide: "00000000-0000-4000-8000-000000000003"
issued_atString nullKohustuslik

Esimene väljastus; enne seda null.

String:format: "date-time"
Näide: null
kindStringKohustuslik

Andmestruktuuri variant, mida kirjeldavad lubatud väärtused.

Piirangud
enum
["file", "code"]
Näide: "code"
location_idString nullKohustuslik

Laoasukoha identifikaator.

Näide: "location-digital"
mime_typeString nullKohustuslik

Meedia sisutüüp.

Näide: null
payload_idStringKohustuslik

Sisu ID; ei ole avalik allalaadimis-URL.

format: "uuid"
Näide: "00000000-0000-4000-8000-000000000004"
product_idStringKohustuslik

Toote identifikaator.

Näide: "example"
size_bytesTäisarv nullKohustuslik

Suurus baitides

Näide: null
sort_orderTäisarvKohustuslik

Asukoht järjestatud kogumis.

Näide: 1
stateStringKohustuslik

Olek

Näide: "available"
versionTäisarvKohustuslik

Ressursi versioon samaaegsuse kontrolliks.

Näide: 1
warehouse_idString nullKohustuslik

Lao identifikaator.

Näide: "warehouse-main"

Lisaväljad: Ei

UnitDeletion

UnitDeletion · Eemalda müümata kood või fail koos põhjusega. Broneeritud või väljastatud ühikuid ei lubata.
expected_versionTäisarvKohustuslik

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

minimum: 1
Näide: 1
reasonStringKohustuslik

Muudatuse juurde salvestatud põhjus.

minLength: 1maxLength: 500
Näide: "Withdraw a revoked license"

Lisaväljad: Ei

UnitReorder

UnitReorder · Saada terve filtreerimata leht soovitud järjekorras. Aegunud versioon tagastab 409.
expected_order_versionTäisarvKohustuslik

Väljastamise järjekorra versioon, mitte klienditellimuse versioon.

minimum: 1
Näide: 1
unit_idsMassiiv <String> Kohustuslik

Kõik filtreerimata lehe ühikud soovitud järjekorras.

minItems: 2maxItems: 100
Massiiv:format: "uuid"
Näide: ["00000000-0000-4000-8000-000000000008","00000000-0000-4000-8000-000000000003"]
window_cursorString nullValikuline

Filtreerimata lehe kursor; esimesel lehel null.

String:maxLength: 1024

Lisaväljad: Ei

UnitReplacement

UnitReplacement · Asenda kood või fail järjekorda muutmata. Muudatus jääb lao ajalukku.
codeString nullValikuline

Digitaalse koodi täpne sisu. Säilita tõstutundlikkus ja koodis olevad tühikud.

String:minLength: 1maxLength: 512
Näide: "SYNTHETIC-REPLACEMENT"
expected_versionTäisarvKohustuslik

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

minimum: 1
Näide: 1
reasonStringKohustuslik

Muudatuse juurde salvestatud põhjus.

minLength: 1maxLength: 500
Näide: "Replace an invalid activation code"
upload_idString nullValikuline

Ressursi identifikaator; säilita see tagastatud kujul. · upload_id

String:format: "uuid"

Lisaväljad: Ei

UnitsData

UnitsData · Loe kuni 100 ühikut lehel. Loend näitab metaandmeid koode avaldamata.
order_versionTäisarvKohustuslik

Digivaru väljastamise järjekorra versioon.

Näide: 2
totalTäisarvKohustuslik

Kogusumma.

Näide: 1
unitsMassiiv <UnitData > Kohustuslik

Ühikute metaandmed; sisu vajab eraldi volitatud päringut.

Näide: [{"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"}]

Lisaväljad: Jah