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

dataCodeContentData Pakollinen

Onnistuneen vastauksen sisältö.

Esimerkki: {"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 Pakollinen

Vastauksen metatiedot.

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

Lisäkentät: Ei

dataDigitalUploadData Pakollinen

Onnistuneen vastauksen sisältö.

Esimerkki: {"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 Pakollinen

Vastauksen metatiedot.

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

Lisäkentät: Ei

dataImportData Pakollinen

Onnistuneen vastauksen sisältö.

Esimerkki: {"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 Pakollinen

Vastauksen metatiedot.

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

Lisäkentät: Ei

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

dataPoolData Pakollinen

Onnistuneen vastauksen sisältö.

Esimerkki: {"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 Pakollinen

Vastauksen metatiedot.

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

Lisäkentät: Ei

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

dataUnitsData Pakollinen

Onnistuneen vastauksen sisältö.

Esimerkki: {"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 Pakollinen

Vastauksen metatiedot.

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

Lisäkentät: Ei

codeMerkkijonoPakollinen

Digitaalinen koodi täsmälleen. Säilytä kirjainkoko ja koodin sisäiset välilyönnit.

minLength: 1maxLength: 512

Esimerkki: "DEMO-ONE"

delivery_idMerkkijono | nullValinnainen

Toimituksen tai tilausluovutuksen tunniste.

Merkkijono:format: "uuid"

Esimerkki: null

kindMerkkijonoValinnainen

Tietorakenteen muoto, joka kuvataan sallituilla arvoilla.

const: "code"

Oletus: "code"Esimerkki: "code"

payload_idMerkkijonoPakollinen

Sisällön tunniste; ei julkinen latausosoite.

format: "uuid"

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

unit_idMerkkijonoPakollinen

Yhden yksilöllisen koodin tai tiedoston tunniste.

format: "uuid"

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

Lisäkentät: Ei

consumer_idMerkkijonoPakollinen

Liitetyn tuonnin tai yksikön tunniste.

format: "uuid"

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

consumer_kindMerkkijonoPakollinen

Latauksen kohde: digital_import / digital_unit.

Rajoitukset

enum

["digital_import", "digital_unit"]

Esimerkki: "digital_import"

filenameMerkkijonoPakollinen

Tiedosto

minLength: 1maxLength: 255

Esimerkki: "codes.txt"

purposeMerkkijonoPakollinen

digital_import: TXT/CSV; digital_unit: yksittäin myytävä tiedosto.

Rajoitukset

enum

["digital_unit", "digital_import"]

Esimerkki: "digital_import"

sha256MerkkijonoPakollinen

SHA-256 (hex, 64)

Rajoitukset

pattern

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

Esimerkki: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesKokonaislukuPakollinen

Koko tavuina

minimum: 1maximum: 262144000

Esimerkki: 18

Lisäkentät: Ei

consumer_idMerkkijonoPakollinen

Liitetyn tuonnin tai yksikön tunniste.

format: "uuid"

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

consumer_kindMerkkijonoPakollinen

Latauksen kohde: digital_import / digital_unit.

Rajoitukset

enum

["digital_import", "digital_unit"]

Esimerkki: "digital_import"

expires_atMerkkijonoPakollinen

Tämän latauksen tai tuonnin vanhenemisaika.

format: "date-time"

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

filenameMerkkijonoPakollinen

Tiedosto

Esimerkki: "codes.txt"

idMerkkijonoPakollinen

Resurssin tunniste; säilytä se palautetussa muodossa.

format: "uuid"

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

product_idMerkkijonoPakollinen

Tuotteen tunniste.

Esimerkki: "example"

purposeMerkkijonoPakollinen

digital_import: TXT/CSV; digital_unit: yksittäin myytävä tiedosto.

Rajoitukset

enum

["digital_unit", "digital_import"]

Esimerkki: "digital_import"

received_bytesKokonaislukuPakollinen

Lähetetään… · Koko tavuina

Esimerkki: 18

sha256MerkkijonoPakollinen

SHA-256 (hex, 64)

Esimerkki: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesKokonaislukuPakollinen

Koko tavuina

Esimerkki: 18

statusMerkkijonoPakollinen

Tämän nimenomaisen toiminnon hyväksymä tila.

Esimerkki: "ready"

Lisäkentät: Ei

delivered_atMerkkijonoPakollinen

Toimituspäivä ja -aika.

format: "date-time"

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

expected_delivery_versionKokonaislukuPakollinen

Toimitusversio; uudelle toimitukselle 0.

minimum: 0maximum: 0

Esimerkki: 0

expected_sales_limit_versionKokonaisluku | nullValinnainen

Myyntirajan versio; vaaditaan kun publish_for_sale=true.

Kokonaisluku:minimum: 0maximum: 9223372036854775807

Esimerkki: 0

expected_versionKokonaislukuPakollinen

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

minimum: 1maximum: 9223372036854775807

Esimerkki: 2

location_idMerkkijonoPakollinen

Varastosijainnin tunniste.

Rajoitukset

pattern

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

Esimerkki: "location-digital"

publish_for_saleTotuusarvoValinnainen

true kasvattaa myös rajattua myyntimäärää; false jättää sen ennalleen.

Oletus: falseEsimerkki: true

statusMerkkijonoPakollinen

Tämän nimenomaisen toiminnon hyväksymä tila.

Rajoitukset

enum

["planned", "received"]

Esimerkki: "received"

validation_digestMerkkijonoPakollinen

Tarkistuksen tarkistussumma; lähetä muuttamattomana vahvistukseen.

Rajoitukset

pattern

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

Esimerkki: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

warehouse_idMerkkijonoPakollinen

Varaston tunniste.

Rajoitukset

pattern

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

Esimerkki: "warehouse-main"

Lisäkentät: Ei

countKokonaislukuPakollinen

Erän tarkka yksikkömäärä.

minimum: 1maximum: 1000

Esimerkki: 2

kindMerkkijonoPakollinen

Tietorakenteen muoto, joka kuvataan sallituilla arvoilla.

Rajoitukset

enum

["code", "file"]

Esimerkki: "code"

Lisäkentät: Ei

delivery_idMerkkijono | nullPakollinen

Toimituksen tai tilausluovutuksen tunniste.

Esimerkki: null

delivery_statusMerkkijono | nullPakollinen

Toimituksen tila: planned / received; ennen vahvistusta null.

Esimerkki: null

delivery_versionKokonaisluku | nullPakollinen

Varastotoimituksen nykyinen versio.

Esimerkki: null

expected_countKokonaislukuPakollinen

Odotettu määrä; vain koko erä hyväksytään.

Esimerkki: 2

expires_atMerkkijonoPakollinen

Tämän latauksen tai tuonnin vanhenemisaika.

format: "date-time"

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

idMerkkijonoPakollinen

Resurssin tunniste; säilytä se palautetussa muodossa.

format: "uuid"

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

kindMerkkijonoPakollinen

Tietorakenteen muoto, joka kuvataan sallituilla arvoilla.

Rajoitukset

enum

["code", "file"]

Esimerkki: "code"

product_idMerkkijonoPakollinen

Tuotteen tunniste.

Esimerkki: "example"

statusMerkkijonoPakollinen

Tämän nimenomaisen toiminnon hyväksymä tila.

Esimerkki: "validated"

validated_countKokonaislukuPakollinen

Viimeisimmässä onnistuneessa tarkistuksessa hyväksytty määrä.

Esimerkki: 2

validation_digestMerkkijono | nullPakollinen

Tarkistuksen tarkistussumma; lähetä muuttamattomana vahvistukseen.

Esimerkki: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

versionKokonaislukuPakollinen

Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 2

Lisäkentät: Ei

expected_delivery_versionKokonaislukuPakollinen

Toimitusversio; uudelle toimitukselle 0.

minimum: 1maximum: 9223372036854775807

Esimerkki: 1

expected_sales_limit_versionKokonaisluku | nullValinnainen

Myyntirajan versio; vaaditaan kun publish_for_sale=true.

Kokonaisluku:minimum: 0maximum: 9223372036854775807

expected_versionKokonaislukuPakollinen

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

minimum: 1maximum: 9223372036854775807

Esimerkki: 3

publish_for_saleTotuusarvoValinnainen

true kasvattaa myös rajattua myyntimäärää; false jättää sen ennalleen.

Oletus: false

Lisäkentät: Ei

code_columnMerkkijono | nullValinnainen

Koodien CSV-sarake; käytä code.

Merkkijono:const: "code"

expected_versionKokonaislukuPakollinen

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

minimum: 1maximum: 9223372036854775807

Esimerkki: 1

formatMerkkijono | nullValinnainen

Koodiluettelo: txt / csv; tiedostoille upload_ids.

Rajoitukset · Merkkijono 1

enum

["txt", "csv"]

Esimerkki: "txt"

source_upload_idMerkkijono | nullValinnainen

Tämän tuonnin valmis yksityinen TXT/CSV-lataus.

Merkkijono:format: "uuid"

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

upload_idsTaulukko <Merkkijono> | nullValinnainen

1–100 tämän tuonnin valmista yksityistä tiedostolatausta.

Taulukko:minItems: 1maxItems: 100

Taulukko / Taulukko:format: "uuid"

Lisäkentät: Ei

expected_delivery_versionKokonaislukuPakollinen

Toimitusversio; uudelle toimitukselle 0.

minimum: 1maximum: 9223372036854775807

Esimerkki: 1

expected_order_versionKokonaislukuPakollinen

Luovutusjärjestyksen versio, ei asiakastilauksen versio.

minimum: 0maximum: 9223372036854775807

Esimerkki: 1

expected_versionKokonaislukuPakollinen

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

minimum: 1maximum: 9223372036854775807

Esimerkki: 3

reasonMerkkijonoPakollinen

Muutokselle kirjattu syy.

minLength: 1maxLength: 500

Esimerkki: "Withdraw a revoked license"

Lisäkentät: Ei

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

email_modeMerkkijonoValinnainen

disabled: ei sähköpostia; order_link: tilauslinkki; code_text: myös koodeja voidaan sisällyttää.

Rajoitukset

enum

["disabled", "order_link", "code_text"]

Oletus: "disabled"Esimerkki: "order_link"

enabledTotuusarvoPakollinen

Onko tämä asetus käytössä.

Esimerkki: true

expected_versionKokonaislukuPakollinen

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

minimum: 0maximum: 9223372036854775807

Esimerkki: 0

retention_daysKokonaisluku | nullValinnainen

null: rajaton säilytys; 1–3650 päivää ensimmäisestä käyttöoikeudesta. Koodeja ei poisteta automaattisesti.

Kokonaisluku:minimum: 1maximum: 3650

Esimerkki: null

Lisäkentät: Ei

availableKokonaislukuPakollinen

Vapaiden yksiköiden määrä; niitä ei ole varattu eikä luovutettu.

Esimerkki: 1

heldKokonaislukuPakollinen

Tilauksille varatut, vielä luovuttamattomat yksiköt.

Esimerkki: 0

issuedKokonaislukuPakollinen

Maksetuille ostoille jo luovutetut yksiköt.

Esimerkki: 1

plannedKokonaislukuPakollinen

Vahvistettujen, vielä vastaanottamattomien toimitusten yksiköt.

Esimerkki: 0

retiredKokonaislukuPakollinen

Poistetut yksiköt, jotka säilyvät historiassa.

Esimerkki: 0

stagedKokonaislukuPakollinen

Keskeneräisten tuontien yksiköt, eivät vielä varastoa.

Esimerkki: 0

Lisäkentät: Ei

configuredTotuusarvoPakollinen

Onko digitaalisen varaston asetukset tallennettu.

Esimerkki: true

countsPoolCounts Pakollinen

Yksiköiden määrä varastotilan mukaan.

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

email_modeMerkkijonoPakollinen

disabled: ei sähköpostia; order_link: tilauslinkki; code_text: myös koodeja voidaan sisällyttää.

Rajoitukset

enum

["disabled", "order_link", "code_text"]

Esimerkki: "order_link"

enabledTotuusarvoPakollinen

Onko tämä asetus käytössä.

Esimerkki: true

order_versionKokonaislukuPakollinen

Varaston luovutusjärjestyksen versio.

Esimerkki: 2

product_idMerkkijonoPakollinen

Tuotteen tunniste.

Esimerkki: "example"

retention_daysKokonaisluku | nullPakollinen

null: rajaton säilytys; 1–3650 päivää ensimmäisestä käyttöoikeudesta. Koodeja ei poisteta automaattisesti.

Esimerkki: null

versionKokonaislukuPakollinen

Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 1

Lisäkentät: Ei

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

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

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

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

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

content_stateMerkkijonoPakollinen

Sisällön tila: present / deleting / deleted.

Esimerkki: "present"

delivery_idMerkkijono | nullPakollinen

Toimituksen tai tilausluovutuksen tunniste.

Esimerkki: "delivery-example"

filenameMerkkijono | nullPakollinen

Tiedosto

Esimerkki: null

idMerkkijonoPakollinen

Resurssin tunniste; säilytä se palautetussa muodossa.

format: "uuid"

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

issued_atMerkkijono | nullPakollinen

Ensimmäinen luovutus; sitä ennen null.

Merkkijono:format: "date-time"

Esimerkki: null

kindMerkkijonoPakollinen

Tietorakenteen muoto, joka kuvataan sallituilla arvoilla.

Rajoitukset

enum

["file", "code"]

Esimerkki: "code"

location_idMerkkijono | nullPakollinen

Varastosijainnin tunniste.

Esimerkki: "location-digital"

mime_typeMerkkijono | nullPakollinen

Median sisältötyyppi.

Esimerkki: null

payload_idMerkkijonoPakollinen

Sisällön tunniste; ei julkinen latausosoite.

format: "uuid"

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

product_idMerkkijonoPakollinen

Tuotteen tunniste.

Esimerkki: "example"

size_bytesKokonaisluku | nullPakollinen

Koko tavuina

Esimerkki: null

sort_orderKokonaislukuPakollinen

Sijainti järjestetyssä kokoelmassa.

Esimerkki: 1

stateMerkkijonoPakollinen

Tila

Esimerkki: "available"

versionKokonaislukuPakollinen

Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 1

warehouse_idMerkkijono | nullPakollinen

Varaston tunniste.

Esimerkki: "warehouse-main"

Lisäkentät: Ei

expected_versionKokonaislukuPakollinen

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

minimum: 1

Esimerkki: 1

reasonMerkkijonoPakollinen

Muutokselle kirjattu syy.

minLength: 1maxLength: 500

Esimerkki: "Withdraw a revoked license"

Lisäkentät: Ei

expected_order_versionKokonaislukuPakollinen

Luovutusjärjestyksen versio, ei asiakastilauksen versio.

minimum: 1

Esimerkki: 1

unit_idsTaulukko <Merkkijono> Pakollinen

Kaikki suodattamattoman sivun yksiköt halutussa järjestyksessä.

minItems: 2maxItems: 100

Taulukko:format: "uuid"

Esimerkki: ["00000000-0000-4000-8000-000000000008","00000000-0000-4000-8000-000000000003"]

window_cursorMerkkijono | nullValinnainen

Suodattamattoman sivun osoitin; ensimmäiselle sivulle null.

Merkkijono:maxLength: 1024

Lisäkentät: Ei

codeMerkkijono | nullValinnainen

Digitaalinen koodi täsmälleen. Säilytä kirjainkoko ja koodin sisäiset välilyönnit.

Merkkijono:minLength: 1maxLength: 512

Esimerkki: "SYNTHETIC-REPLACEMENT"

expected_versionKokonaislukuPakollinen

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

minimum: 1

Esimerkki: 1

reasonMerkkijonoPakollinen

Muutokselle kirjattu syy.

minLength: 1maxLength: 500

Esimerkki: "Replace an invalid activation code"

upload_idMerkkijono | nullValinnainen

Resurssin tunniste; säilytä se palautetussa muodossa. · upload_id

Merkkijono:format: "uuid"

Lisäkentät: Ei

order_versionKokonaislukuPakollinen

Varaston luovutusjärjestyksen versio.

Esimerkki: 2

totalKokonaislukuPakollinen

Kokonaissumma.

Esimerkki: 1

unitsTaulukko <UnitData > Pakollinen

Yksiköiden metatiedot; sisältö vaatii erillisen valtuutetun pyynnön.

Esimerkki: [{"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"}]

Lisäkentät: Kyllä