Tietoskeemat: Tuotteet

Tietoskeemat: Tuotteet. API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

Tietoskeemat

ApiResponse_ProductFileListData_

ApiResponse_ProductFileListData_ · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset. Lähetä tiedostot multipart/form-data-muodossa upload_id-tunnuksen luonnin jälkeen ja liitä ne tuotteeseen. Lataaminen vaatii Bearer-tunnuksen ja category-oikeuden; vastaus sisältää tiedoston tavut ilman julkista osoitetta tai salasanaa. Kun mode=period, valitse days (1–3650) tai aiempi months, älä molempia. Ehdot tallennetaan ostohetkellä; hyvitys poistaa käyttöoikeuden vain hyvitetyltä tilausriviltä.

dataProductFileListData Pakollinen: Onnistuneen vastauksen sisältö.

Esimerkki: {"files":[{"category":"digital","created_at":"2026-01-01T12:00:00Z","current_version_id":"00000000-0000-4000-8000-000000000001","file_id":"00000000-0000-4000-8000-000000000001","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","label":"Manual","mime_type":"application/pdf","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"state":"active","version_number":1}],"product_version":2}
metaContextPageMeta ContextMeta PageMeta RequestMeta Pakollinen: Vastauksen metatiedot.

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

Lisäkentät: Ei

ApiResponse_ReleaseListData_

ApiResponse_ReleaseListData_ · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset. Lähetä tiedostot multipart/form-data-muodossa upload_id-tunnuksen luonnin jälkeen ja liitä ne tuotteeseen. Lataaminen vaatii Bearer-tunnuksen ja category-oikeuden; vastaus sisältää tiedoston tavut ilman julkista osoitetta tai salasanaa. Kun mode=period, valitse days (1–3650) tai aiempi months, älä molempia. Ehdot tallennetaan ostohetkellä; hyvitys poistaa käyttöoikeuden vain hyvitetyltä tilausriviltä.

dataReleaseListData Pakollinen: Onnistuneen vastauksen sisältö.

Esimerkki: {"current_release_id":"00000000-0000-4000-8000-000000000001","product_version":2,"releases":[{"changelog":"Manual update","files":[{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}],"id":"00000000-0000-4000-8000-000000000001","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","published_at":null,"release_sequence":null,"state":"active","version_label":"1.0","withdrawn_at":null}],"update_days":365,"update_mode":"period","update_months":null}
metaContextPageMeta ContextMeta PageMeta RequestMeta Pakollinen: Vastauksen metatiedot.

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

Lisäkentät: Ei

ApiResponse_UploadData_

ApiResponse_UploadData_ · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset. Lähetä tiedostot multipart/form-data-muodossa upload_id-tunnuksen luonnin jälkeen ja liitä ne tuotteeseen. Lataaminen vaatii Bearer-tunnuksen ja category-oikeuden; vastaus sisältää tiedoston tavut ilman julkista osoitetta tai salasanaa. Kun mode=period, valitse days (1–3650) tai aiempi months, älä molempia. Ehdot tallennetaan ostohetkellä; hyvitys poistaa käyttöoikeuden vain hyvitetyltä tilausriviltä.

dataUploadData Pakollinen: Onnistuneen vastauksen sisältö.

Esimerkki: {"category":"digital","expires_at":"2026-01-01T12:00:00Z","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","product_id":"example","received_bytes":46,"sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"status":"ready"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Pakollinen: Vastauksen metatiedot.

Esimerkki: {"request_id":"example"}

Lisäkentät: Ei

ApiResponse[AudienceData]

ApiResponse_AudienceData_ · Lue käyttöoikeussääntö ja tuoteversio. Ensimmäinen julkaisu säilyy ajan vertailukohtana.

dataAudienceData Pakollinen: Onnistuneen vastauksen sisältö.

Esimerkki: {"anchor_at":"2026-11-03T12:00:00Z","effective_at":"2026-11-03T12:00:00Z","file_id":"00000000-0000-4000-8000-000000000007","file_version_id":"00000000-0000-4000-8000-000000000010","historical_access_preserved":true,"id":"00000000-0000-4000-8000-000000000009","lookback_days":null,"mode":"all_purchasers","next_cursor":null,"order_ids":[],"product_version":3,"revision":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Pakollinen: Vastauksen metatiedot.

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

Lisäkentät: Ei

Listaa — Tuotteet — Vastaus

ApiResponse_list_ProductSummaryData__ · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

dataTaulukko <ProductSummaryData > Pakollinen: Vastausesimerkki · ApiResponse_list_ProductSummaryData__.

Esimerkki: [{"availability":{"available_from":null,"available_until":null,"is_available":true},"brand_id":null,"condition":"new","created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"price_version":1,"primary_category_id":"example","primary_media_id":"example","published":false,"sku":"example","slug":"example","tax_category_id":"example","updated_at":"2026-01-01T12:00:00Z","variants_enabled":false,"version":1}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Pakollinen: Vastauksen metatiedot.

Esimerkki: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Lisäkentät: Ei

Hae — Tuotteet — Vastaus

ApiResponse_ProductDetailData_ · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

dataProductDetailData Pakollinen: Vastausesimerkki · ProductDetailData.

Esimerkki: {"availability":{"available_from":null,"available_until":null,"is_available":true},"brand_id":null,"condition":"new","created_at":"2026-01-01T12:00:00Z","description":"example","features":[{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}],"id":"example","identifiers":{},"media":[{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}],"meta_description":"example","meta_keywords":["example"],"meta_title":"example","name":"Example","number":"example","price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"price_version":1,"primary_category_id":"example","primary_media_id":"example","published":false,"sku":"example","slug":"example","tax_category_id":"example","updated_at":"2026-01-01T12:00:00Z","variants_enabled":false,"version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Pakollinen: Vastauksen metatiedot.

Esimerkki: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Lisäkentät: Ei

AudienceChange

AudienceChange · Valitse oikeutetut ostot. Valittujen tilausten on sisällettävä tämä tuote maksettuna ja hyvittämättömänä.

audienceAudienceSelection Pakollinen: Jaetun tiedoston nimenomainen käyttöoikeussääntö.

Esimerkki: {"mode":"all_purchasers"}
expected_versionKokonaislukuPakollinen: Ennen kirjoitusta luettu versio; ristiriita hylkää päivityksen.

minimum: 1maximum: 9223372036854775807

Esimerkki: 1

Lisäkentät: Ei

AudienceData

AudienceData · Lue käyttöoikeussääntö ja tuoteversio. Ensimmäinen julkaisu säilyy ajan vertailukohtana.

anchor_atMerkkijonoPakollinen: Ensimmäinen julkaisu; ei muutu sääntöä muokattaessa.

format: "date-time"

Esimerkki: "2026-11-03T12:00:00Z"
effective_atMerkkijonoPakollinen: Tämän käyttöoikeussäännön julkaisuaika.

format: "date-time"

Esimerkki: "2026-11-03T12:00:00Z"
file_idMerkkijonoPakollinen: Resurssin tunniste; säilytä se palautetussa muodossa. · file_id

Esimerkki: "00000000-0000-4000-8000-000000000007"
file_version_idMerkkijonoPakollinen: Muuttumattoman tiedostoversion tunniste.

Esimerkki: "00000000-0000-4000-8000-000000000010"
historical_access_preservedTotuusarvoValinnainen: Aiemmin myönnetyt oikeudet säilyvät sääntöä rajattaessa.

Oletus: trueEsimerkki: true
idMerkkijonoPakollinen: Resurssin tunniste; säilytä se palautetussa muodossa.

Esimerkki: "00000000-0000-4000-8000-000000000009"
lookback_daysKokonaisluku nullPakollinen: 1–3650 päivää ennen ensimmäistä julkaisua; vain recent_and_new.

Esimerkki: null
modeMerkkijonoPakollinen: Jaetun tiedoston nimenomainen käyttöoikeussääntö. new_purchases / recent_and_new / selected / all_purchasers.

Esimerkki: "all_purchasers"
next_cursorMerkkijono nullPakollinen: Seuraavan sivun jatkoarvo tai null.

Esimerkki: null
order_idsTaulukko <Merkkijono> Pakollinen: Tilaukset, joissa tämä tuote on maksettu eikä hyvitetty.

Esimerkki: []
product_versionKokonaislukuPakollinen: Nykyinen tuoteversio samanaikaisuuden hallintaan.

Esimerkki: 3
revisionKokonaislukuPakollinen: Käyttöoikeussäännön juokseva versio.

Esimerkki: 1

Lisäkentät: Ei

AudienceSelection

AudienceSelection · Valitse oikeutetut ostot. Valittujen tilausten on sisällettävä tämä tuote maksettuna ja hyvittämättömänä.

lookback_daysKokonaisluku nullValinnainen

1–3650 päivää ennen ensimmäistä julkaisua; vain recent_and_new.

Kokonaisluku:minimum: 1maximum: 3650

modeMerkkijonoPakollinen

Jaetun tiedoston nimenomainen käyttöoikeussääntö. new_purchases / recent_and_new / selected / all_purchasers.

Rajoitukset

enum: ["new_purchases", "recent_and_new", "selected", "all_purchasers"]

Esimerkki: "new_purchases"

order_idsTaulukko <Merkkijono> Valinnainen

Tilaukset, joissa tämä tuote on maksettu eikä hyvitetty.

maxItems: 1000

Rajoitukset · Taulukko 1

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

Oletus: []

Lisäkentät: Ei

Valitun kontekstin saatavuustiedot

AvailabilityData · Skeema · Tietoskeemat: Tuotteet

available_fromMerkkijono nullPakollinen: Saatavuuden alku.

Merkkijono:format: "date-time"

Esimerkki: null
available_untilMerkkijono nullPakollinen: Saatavuuden loppu.

Merkkijono:format: "date-time"

Esimerkki: null
is_availableTotuusarvoPakollinen: Onko kohde saatavilla tässä kontekstissa.

Esimerkki: true

Lisäkentät: Ei

FileAssign

FileAssign · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset. Lähetä tiedostot multipart/form-data-muodossa upload_id-tunnuksen luonnin jälkeen ja liitä ne tuotteeseen. Lataaminen vaatii Bearer-tunnuksen ja category-oikeuden; vastaus sisältää tiedoston tavut ilman julkista osoitetta tai salasanaa. Kun mode=period, valitse days (1–3650) tai aiempi months, älä molempia. Ehdot tallennetaan ostohetkellä; hyvitys poistaa käyttöoikeuden vain hyvitetyltä tilausriviltä.

audienceAudienceSelection nullValinnainen: Jaetun tiedoston nimenomainen käyttöoikeussääntö.

Esimerkki: {"mode":"new_purchases"}
expected_versionKokonaislukuPakollinen: Ennen kirjoitusta luettu versio; ristiriita hylkää päivityksen.

minimum: 1maximum: 9223372036854775807

Esimerkki: 1
labelMerkkijonoValinnainen: Resurssin nimi kyseisessä kontekstissa.

maxLength: 300

Oletus: ""
upload_idMerkkijonoPakollinen: Resurssin tunniste; säilytä se palautetussa muodossa. · upload_id

format: "uuid"

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

Lisäkentät: Ei

FileCategory

FileCategory · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset. Lähetä tiedostot multipart/form-data-muodossa upload_id-tunnuksen luonnin jälkeen ja liitä ne tuotteeseen. Lataaminen vaatii Bearer-tunnuksen ja category-oikeuden; vastaus sisältää tiedoston tavut ilman julkista osoitetta tai salasanaa. Kun mode=period, valitse days (1–3650) tai aiempi months, älä molempia. Ehdot tallennetaan ostohetkellä; hyvitys poistaa käyttöoikeuden vain hyvitetyltä tilausriviltä.

Merkkijono

Rajoitukset

enum: ["internal", "customer_document", "digital"]

Lisäkentät: Kyllä

Valitun kontekstin hintatiedot

PriceData · Skeema · Tietoskeemat: Tuotteet

amountMerkkijonoPakollinen

JSON-merkkijonona esitetty desimaalimäärä; null vain, jos se on sallittu.

Esimerkki: "0.00"

currencyMerkkijonoPakollinen

Summan valuuttakoodi.

Rajoitukset

pattern: "^[A-Z]{3}$"

Esimerkki: "PLN"

minor_unitsKokonaislukuPakollinen

Valuutan käyttämien desimaalinumeroiden määrä.

minimum: 0maximum: 4

Esimerkki: 2

tax_includedTotuusarvoPakollinen

Sisältääkö lähetetty hinta verot.

Esimerkki: true

Lisäkentät: Ei

Hinnaston tiedot

PriceListData · Skeema · Tietoskeemat: Tuotteet

currencyMerkkijonoPakollinen: Summan valuuttakoodi.
idMerkkijonoPakollinen: Resurssin tunniste; säilytä se palautetussa muodossa. (PriceListData).
tax_includedTotuusarvoPakollinen: Sisältääkö lähetetty hinta verot.
versionKokonaislukuPakollinen: Samanaikaisuuden hallintaan käytetty resurssiversio.

Lisäkentät: Ei

Luo — Tuotteet — Pyynnön sisältö

ProductCreate · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

brand_idMerkkijono nullValinnainen

Tuotemerkin tunniste.

Merkkijono:minLength: 1maxLength: 63

conditionMerkkijonoValinnainen

Tuotteen kunto.

Rajoitukset

enum: ["new", "refurbished", "used", "returned", "display", "damaged"]

Oletus: "new"

descriptionMerkkijono nullValinnainen

Kuvaus valitulla kielellä.

Merkkijono:maxLength: 100000

feature_value_idsTaulukko <Merkkijono> Valinnainen

Valittujen ominaisuusarvojen tunnisteet.

maxItems: 1000

Taulukko:minLength: 1maxLength: 63

identifiersProductIdentifiers nullValinnainen

Tuotteen tunnistekoodit.

market_idsTaulukko <Merkkijono> Valinnainen

Valittujen markkina-alueiden tunnisteet.

maxItems: 1000

Taulukko:minLength: 1maxLength: 63

media_idsTaulukko <Merkkijono> Valinnainen

Jo olemassa olevien medioiden tunnisteet.

maxItems: 30

Taulukko:minLength: 1maxLength: 63

meta_descriptionMerkkijono nullValinnainen

Hakukonekuvaus valitulla kielellä.

Merkkijono:maxLength: 160

meta_keywordsTaulukko <Merkkijono> nullValinnainen

Hakukoneavainsanat valitulla kielellä.

Taulukko:maxItems: 20

Taulukko / Taulukko:maxLength: 50

meta_titleMerkkijono nullValinnainen

Hakukoneotsikko valitulla kielellä.

Merkkijono:maxLength: 70

nameMerkkijonoPakollinen

Resurssin nimi kyseisessä kontekstissa.

minLength: 1maxLength: 300

Esimerkki: "Example"

pricingProductPrice Valinnainen

Hintamääritykset ja niiden samanaikaisuuden hallinnan versiot.

primary_category_idMerkkijono nullValinnainen

Ensisijaisen kategorian tunniste.

Merkkijono:minLength: 1maxLength: 63

publishedTotuusarvoValinnainen

Onko resurssi julkaistu.

Oletus: false

skuMerkkijonoPakollinen

Varastonimikkeen SKU-koodi.

minLength: 1maxLength: 100

Rajoitukset

pattern: "^\\S+$"

Esimerkki: "example"

slugMerkkijono nullValinnainen

URL-polun osa valitulla kielellä.

Merkkijono:maxLength: 160

tax_category_idMerkkijono nullValinnainen

Veroluokan tunniste.

Merkkijono:minLength: 1maxLength: 63

variant_value_idsTaulukko <Merkkijono> Valinnainen

Valittujen varianttiarvojen tunnisteet.

maxItems: 250

Taulukko:minLength: 1maxLength: 63

variants_enabledTotuusarvoValinnainen

Käyttääkö tuote variantteja.

Oletus: false

Lisäkentät: Ei

Hae — Tuotteet — Vastaus

ProductDetailData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

availabilityAvailabilityData Pakollinen

Valitun kontekstin saatavuustiedot.

Esimerkki: {"available_from":null,"available_until":null,"is_available":true}

brand_idMerkkijono nullPakollinen

Tuotemerkin tunniste.

Esimerkki: null

conditionMerkkijonoPakollinen

Tuotteen kunto.

Rajoitukset

enum: ["new", "refurbished", "used", "returned", "display", "damaged"]

Esimerkki: "new"

created_atMerkkijonoPakollinen

Luontiajankohta.

format: "date-time"

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

descriptionMerkkijono nullPakollinen

Kuvaus valitulla kielellä.

Esimerkki: "example"

featuresTaulukko <FeatureSelectionData > Pakollinen

Tuotteen ominaisuudet.

Esimerkki: [{"feature_id":"example","feature_name":"example","value":"example","value_id":"example"}]

idMerkkijonoPakollinen

Resurssin tunniste; säilytä se palautetussa muodossa. (ProductDetailData).

Esimerkki: "example"

identifiersObjektiLisäkentät: MerkkijonoPakollinen

Tuotteen tunnistekoodit.

Esimerkki: {}

mediaTaulukko <ProductMediaData > Pakollinen

Liitettyjen medioiden tiedot.

Esimerkki:

[{"alt_text":"example","id":"example","is_primary":true,"kind":"image","mime_type":"image/jpeg","position":1,"url":"https://example.invalid/product.jpg"}]

meta_descriptionMerkkijono nullPakollinen

Hakukonekuvaus valitulla kielellä.

Esimerkki: "example"

meta_keywordsTaulukko <Merkkijono> nullPakollinen

Hakukoneavainsanat valitulla kielellä.

Esimerkki: ["example"]

meta_titleMerkkijono nullPakollinen

Hakukoneotsikko valitulla kielellä.

Esimerkki: "example"

nameMerkkijono nullPakollinen

Resurssin nimi kyseisessä kontekstissa.

Esimerkki: "Example"

numberMerkkijonoPakollinen

Ihmiselle tarkoitettu tilaus- tai tapausnumero.

Esimerkki: "example"

pricePriceData nullPakollinen

Valitun kontekstin hintatiedot.

Esimerkki: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}

price_versionKokonaislukuPakollinen

Nykyinen hintaversio samanaikaisuuden hallintaan.

Esimerkki: 1

primary_category_idMerkkijono nullPakollinen

Ensisijaisen kategorian tunniste.

Esimerkki: "example"

primary_media_idMerkkijono nullPakollinen

Ensisijaisen median tunniste.

Esimerkki: "example"

publishedTotuusarvoPakollinen

Onko resurssi julkaistu.

Esimerkki: false

skuMerkkijonoPakollinen

Varastonimikkeen SKU-koodi.

Esimerkki: "example"

slugMerkkijono nullPakollinen

URL-polun osa valitulla kielellä.

Esimerkki: "example"

tax_category_idMerkkijonoPakollinen

Veroluokan tunniste.

Esimerkki: "example"

updated_atMerkkijonoPakollinen

Viimeisimmän päivityksen ajankohta.

format: "date-time"

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

variants_enabledTotuusarvoPakollinen

Käyttääkö tuote variantteja.

Esimerkki: false

versionKokonaislukuPakollinen

Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 1

Lisäkentät: Ei

ProductFileData

ProductFileData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset. Lähetä tiedostot multipart/form-data-muodossa upload_id-tunnuksen luonnin jälkeen ja liitä ne tuotteeseen. Lataaminen vaatii Bearer-tunnuksen ja category-oikeuden; vastaus sisältää tiedoston tavut ilman julkista osoitetta tai salasanaa. Kun mode=period, valitse days (1–3650) tai aiempi months, älä molempia. Ehdot tallennetaan ostohetkellä; hyvitys poistaa käyttöoikeuden vain hyvitetyltä tilausriviltä.

categoryFileCategory Pakollinen: Tiedostoluokka: internal / customer_document / digital

Esimerkki: "digital"
created_atMerkkijonoPakollinen: Luontiajankohta.

format: "date-time"

Esimerkki: "2026-01-01T12:00:00Z"
current_version_idMerkkijonoPakollinen: Resurssin tunniste; säilytä se palautetussa muodossa. · current_version_id

format: "uuid"

Esimerkki: "00000000-0000-4000-8000-000000000001"
file_idMerkkijonoPakollinen: Resurssin tunniste; säilytä se palautetussa muodossa. · file_id

format: "uuid"

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

Esimerkki: "manual.pdf"
idMerkkijonoPakollinen: Resurssin tunniste; säilytä se palautetussa muodossa.

format: "uuid"

Esimerkki: "00000000-0000-4000-8000-000000000001"
labelMerkkijonoPakollinen: Resurssin nimi kyseisessä kontekstissa.

Esimerkki: "Manual"
mime_typeMerkkijonoPakollinen: Median sisältötyyppi.

Esimerkki: "application/pdf"
sha256MerkkijonoPakollinen: SHA-256 (hex, 64)

Esimerkki: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesKokonaislukuPakollinen: Koko tavuina

Esimerkki: 46
stateMerkkijonoPakollinen: Tila

Esimerkki: "active"
version_numberKokonaislukuPakollinen: Versio

Esimerkki: 1

Lisäkentät: Ei

ProductFileListData

ProductFileListData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset. Lähetä tiedostot multipart/form-data-muodossa upload_id-tunnuksen luonnin jälkeen ja liitä ne tuotteeseen. Lataaminen vaatii Bearer-tunnuksen ja category-oikeuden; vastaus sisältää tiedoston tavut ilman julkista osoitetta tai salasanaa. Kun mode=period, valitse days (1–3650) tai aiempi months, älä molempia. Ehdot tallennetaan ostohetkellä; hyvitys poistaa käyttöoikeuden vain hyvitetyltä tilausriviltä.

filesTaulukko <ProductFileData > Pakollinen: Tuotetiedostot

Esimerkki: [{"category":"digital","created_at":"2026-01-01T12:00:00Z","current_version_id":"00000000-0000-4000-8000-000000000001","file_id":"00000000-0000-4000-8000-000000000001","filename":"manual.pdf","id":"00000000-0000-4000-8000-000000000001","label":"Manual","mime_type":"application/pdf","sha256":"5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd","size_bytes":46,"state":"active","version_number":1}]
product_versionKokonaislukuPakollinen: Nykyinen tuoteversio samanaikaisuuden hallintaan.

Esimerkki: 2

Lisäkentät: Ei

Tuotteen tunnistekoodit

ProductIdentifiers · Skeema · Tietoskeemat: Tuotteet

eanMerkkijono nullValinnainen: Tuotteen EAN-tunniste.

Merkkijono:minLength: 1maxLength: 100
isbnMerkkijono nullValinnainen: ISBN-tunniste.

Merkkijono:minLength: 1maxLength: 100
mpnMerkkijono nullValinnainen: Valmistajan osanumero.

Merkkijono:minLength: 1maxLength: 100
upcMerkkijono nullValinnainen: Tuotteen UPC-tunniste.

Merkkijono:minLength: 1maxLength: 100

Lisäkentät: Ei

Liitettyjen medioiden tiedot

ProductMediaData · Skeema · Tietoskeemat: Tuotteet

alt_textMerkkijono nullPakollinen

Kuvan vaihtoehtoinen teksti.

Esimerkki: "example"

idMerkkijonoPakollinen

Resurssin tunniste; säilytä se palautetussa muodossa. (ProductMediaData).

Esimerkki: "example"

is_primaryTotuusarvoPakollinen

Onko tämä ensisijainen kohde.

Esimerkki: true

kindMerkkijonoPakollinen

Tietorakenteen muoto, joka kuvataan sallituilla arvoilla.

Rajoitukset

enum: ["image", "video", "model_3d"]

Esimerkki: "image"

mime_typeMerkkijonoPakollinen

Median sisältötyyppi.

Esimerkki: "image/jpeg"

positionKokonaislukuPakollinen

Sijainti järjestetyssä kokoelmassa.

Esimerkki: 1

urlMerkkijono nullPakollinen

Resurssin URL-osoite.

Esimerkki: "https://example.invalid/product.jpg"

Lisäkentät: Ei

Hintamääritykset ja niiden samanaikaisuuden hallinnan versiot

ProductPrice · Skeema · Tietoskeemat: Tuotteet

amountMerkkijono nullPakollinen

JSON-merkkijonona esitetty desimaalimäärä; null vain, jos se on sallittu.

Merkkijono:maxLength: 19

Rajoitukset · Merkkijono 1

pattern: "^(0|[1-9][0-9]{0,13})(\\.[0-9]{1,4})?$"

Esimerkki: "0.00"

currencyMerkkijonoPakollinen

Summan valuuttakoodi.

Rajoitukset

pattern: "^[A-Z]{3}$"

Esimerkki: "PLN"

expected_price_list_versionKokonaislukuPakollinen

Aiemmin luettu hinnastoversio, joka vaaditaan tähän kirjoitukseen.

minimum: 1maximum: 9223372036854775807

Esimerkki: 1

expected_versionKokonaislukuPakollinen

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

minimum: 0maximum: 9223372036854775807

Esimerkki: 0

kindMerkkijonoPakollinen

Tietorakenteen muoto, joka kuvataan sallituilla arvoilla.

Rajoitukset

enum: ["base", "market_fixed"]

Esimerkki: "base"

price_list_idMerkkijonoPakollinen

Hinnaston tunniste.

minLength: 1maxLength: 63

Esimerkki: "example"

tax_includedTotuusarvoPakollinen

Sisältääkö lähetetty hinta verot.

Esimerkki: true

Lisäkentät: Ei

Listaa — Tuotteet — Vastaus

ProductSummaryData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

availabilityAvailabilityData Pakollinen

Valitun kontekstin saatavuustiedot.

Esimerkki: {"available_from":null,"available_until":null,"is_available":true}

brand_idMerkkijono nullPakollinen

Tuotemerkin tunniste.

Esimerkki: null

conditionMerkkijonoPakollinen

Tuotteen kunto.

Rajoitukset

enum: ["new", "refurbished", "used", "returned", "display", "damaged"]

Esimerkki: "new"

created_atMerkkijonoPakollinen

Luontiajankohta.

format: "date-time"

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

idMerkkijonoPakollinen

Resurssin tunniste; säilytä se palautetussa muodossa. (ProductSummaryData).

Esimerkki: "example"

nameMerkkijono nullPakollinen

Resurssin nimi kyseisessä kontekstissa.

Esimerkki: "Example"

numberMerkkijonoPakollinen

Ihmiselle tarkoitettu tilaus- tai tapausnumero.

Esimerkki: "example"

pricePriceData nullPakollinen

Valitun kontekstin hintatiedot.

Esimerkki: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}

price_versionKokonaislukuPakollinen

Nykyinen hintaversio samanaikaisuuden hallintaan.

Esimerkki: 1

primary_category_idMerkkijono nullPakollinen

Ensisijaisen kategorian tunniste.

Esimerkki: "example"

primary_media_idMerkkijono nullPakollinen

Ensisijaisen median tunniste.

Esimerkki: "example"

publishedTotuusarvoPakollinen

Onko resurssi julkaistu.

Esimerkki: false

skuMerkkijonoPakollinen

Varastonimikkeen SKU-koodi.

Esimerkki: "example"

slugMerkkijono nullPakollinen

URL-polun osa valitulla kielellä.

Esimerkki: "example"

tax_category_idMerkkijonoPakollinen

Veroluokan tunniste.

Esimerkki: "example"

updated_atMerkkijonoPakollinen

Viimeisimmän päivityksen ajankohta.

format: "date-time"

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

variants_enabledTotuusarvoPakollinen

Käyttääkö tuote variantteja.

Esimerkki: false

versionKokonaislukuPakollinen

Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 1

Lisäkentät: Ei

Päivitä — Tuotteet — Pyynnön sisältö

ProductUpdate · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

brand_idMerkkijono nullValinnainen

Tuotemerkin tunniste.

Merkkijono:minLength: 1maxLength: 63

conditionMerkkijonoValinnainen

Tuotteen kunto.

Rajoitukset

enum: ["new", "refurbished", "used", "returned", "display", "damaged"]

descriptionMerkkijono nullValinnainen

Kuvaus valitulla kielellä.

Merkkijono:maxLength: 100000

Esimerkki: null

expected_variant_price_versionsObjektiLisäkentät: Kokonaisluku

minimum: 0maximum: 9223372036854775807

Valinnainen

Aiemmin luetut hintaversiot variantin tunnisteen mukaan.

maxProperties: 250

Rajoitukset

propertyNames: {"maxLength": 63, "minLength": 1}

expected_versionKokonaislukuPakollinen

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

minimum: 1maximum: 9223372036854775807

Esimerkki: 1

feature_value_idsTaulukko <Merkkijono> Valinnainen

Valittujen ominaisuusarvojen tunnisteet.

maxItems: 1000

Taulukko:minLength: 1maxLength: 63

identifiersProductIdentifiers nullValinnainen

Tuotteen tunnistekoodit.

market_idsTaulukko <Merkkijono> Valinnainen

Valittujen markkina-alueiden tunnisteet.

maxItems: 1000

Taulukko:minLength: 1maxLength: 63

media_idsTaulukko <Merkkijono> Valinnainen

Jo olemassa olevien medioiden tunnisteet.

maxItems: 30

Taulukko:minLength: 1maxLength: 63

meta_descriptionMerkkijono nullValinnainen

Hakukonekuvaus valitulla kielellä.

Merkkijono:maxLength: 160

meta_keywordsTaulukko <Merkkijono> nullValinnainen

Hakukoneavainsanat valitulla kielellä.

Taulukko:maxItems: 20

Taulukko / Taulukko:maxLength: 50

meta_titleMerkkijono nullValinnainen

Hakukoneotsikko valitulla kielellä.

Merkkijono:maxLength: 70

nameMerkkijono nullValinnainen

Resurssin nimi kyseisessä kontekstissa.

Merkkijono:maxLength: 300

pricingProductPrice Valinnainen

Hintamääritykset ja niiden samanaikaisuuden hallinnan versiot.

Esimerkki:

{"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_version":0,"kind":"base","price_list_id":"example","tax_included":true}

primary_category_idMerkkijono nullValinnainen

Ensisijaisen kategorian tunniste.

Merkkijono:minLength: 1maxLength: 63

publishedTotuusarvoValinnainen

Onko resurssi julkaistu.

skuMerkkijonoValinnainen

Varastonimikkeen SKU-koodi.

minLength: 1maxLength: 100

Rajoitukset

pattern: "^\\S+$"

Esimerkki: "example"

slugMerkkijono nullValinnainen

URL-polun osa valitulla kielellä.

Merkkijono:maxLength: 160

tax_category_idMerkkijono nullValinnainen

Veroluokan tunniste.

Merkkijono:minLength: 1maxLength: 63

variant_value_idsTaulukko <Merkkijono> Valinnainen

Valittujen varianttiarvojen tunnisteet.

maxItems: 250

Taulukko:minLength: 1maxLength: 63

variants_enabledTotuusarvoValinnainen

Käyttääkö tuote variantteja.

Lisäkentät: Ei

ProductVersion

ProductVersion · Tämä toiminto on poistettu käytöstä ja palauttaa 409 muuttamatta tietoja. Määritä jokaisen digitaalisen tiedoston käyttöoikeus valitsemalla vastaanottajat.

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

minimum: 1maximum: 9223372036854775807

Esimerkki: 1

Lisäkentät: Ei

ReleaseData

ReleaseData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset. Lähetä tiedostot multipart/form-data-muodossa upload_id-tunnuksen luonnin jälkeen ja liitä ne tuotteeseen. Lataaminen vaatii Bearer-tunnuksen ja category-oikeuden; vastaus sisältää tiedoston tavut ilman julkista osoitetta tai salasanaa. Kun mode=period, valitse days (1–3650) tai aiempi months, älä molempia. Ehdot tallennetaan ostohetkellä; hyvitys poistaa käyttöoikeuden vain hyvitetyltä tilausriviltä.

changelogMerkkijonoPakollinen: Muutosten kuvaus

Esimerkki: "Manual update"
filesTaulukko <ReleaseFileData > Pakollinen: Tuotetiedostot

Esimerkki: [{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}]
idMerkkijonoPakollinen: Resurssin tunniste; säilytä se palautetussa muodossa.

format: "uuid"

Esimerkki: "00000000-0000-4000-8000-000000000001"
manifest_sha256Merkkijono nullPakollinen: Digitaaliset julkaisut · SHA-256

Esimerkki: "1111111111111111111111111111111111111111111111111111111111111111"
published_atMerkkijono nullPakollinen: Julkaise · UTC

Merkkijono:format: "date-time"

Esimerkki: null
release_sequenceKokonaisluku nullPakollinen: Digitaaliset julkaisut · Sijainti järjestetyssä kokoelmassa.

Esimerkki: null
stateMerkkijonoPakollinen: Tila

Esimerkki: "active"
version_labelMerkkijonoPakollinen: Versio

Esimerkki: "1.0"
withdrawn_atMerkkijono nullPakollinen: Poista myynnistä · UTC

Merkkijono:format: "date-time"

Esimerkki: null

Lisäkentät: Ei

ReleaseDraft

ReleaseDraft · Tämä toiminto on poistettu käytöstä ja palauttaa 409 muuttamatta tietoja. Määritä jokaisen digitaalisen tiedoston käyttöoikeus valitsemalla vastaanottajat.

changelogMerkkijonoValinnainen: Muutosten kuvaus

maxLength: 20000

Oletus: ""
expected_versionKokonaislukuPakollinen: Ennen kirjoitusta luettu versio; ristiriita hylkää päivityksen.

minimum: 1maximum: 9223372036854775807

Esimerkki: 1
version_idsTaulukko <Merkkijono> Pakollinen: Versio · UUID[]

minItems: 1maxItems: 20
Taulukko:format: "uuid"

Esimerkki: ["00000000-0000-4000-8000-000000000001"]
version_labelMerkkijonoPakollinen: Versio

minLength: 1maxLength: 64

Esimerkki: "1.0"

Lisäkentät: Ei

ReleaseFileData

ReleaseFileData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset. Lähetä tiedostot multipart/form-data-muodossa upload_id-tunnuksen luonnin jälkeen ja liitä ne tuotteeseen. Lataaminen vaatii Bearer-tunnuksen ja category-oikeuden; vastaus sisältää tiedoston tavut ilman julkista osoitetta tai salasanaa. Kun mode=period, valitse days (1–3650) tai aiempi months, älä molempia. Ehdot tallennetaan ostohetkellä; hyvitys poistaa käyttöoikeuden vain hyvitetyltä tilausriviltä.

file_idMerkkijonoPakollinen: Resurssin tunniste; säilytä se palautetussa muodossa. · file_id

format: "uuid"

Esimerkki: "00000000-0000-4000-8000-000000000001"
sort_orderKokonaislukuPakollinen: Sijainti järjestetyssä kokoelmassa.

Esimerkki: 0
version_idMerkkijonoPakollinen: Resurssin tunniste; säilytä se palautetussa muodossa. · version_id

format: "uuid"

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

Lisäkentät: Ei

ReleaseListData

ReleaseListData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset. Lähetä tiedostot multipart/form-data-muodossa upload_id-tunnuksen luonnin jälkeen ja liitä ne tuotteeseen. Lataaminen vaatii Bearer-tunnuksen ja category-oikeuden; vastaus sisältää tiedoston tavut ilman julkista osoitetta tai salasanaa. Kun mode=period, valitse days (1–3650) tai aiempi months, älä molempia. Ehdot tallennetaan ostohetkellä; hyvitys poistaa käyttöoikeuden vain hyvitetyltä tilausriviltä.

current_release_idMerkkijono nullPakollinen: Resurssin tunniste; säilytä se palautetussa muodossa. · current_release_id

Merkkijono:format: "uuid"

Esimerkki: "00000000-0000-4000-8000-000000000001"
product_versionKokonaislukuPakollinen: Nykyinen tuoteversio samanaikaisuuden hallintaan.

Esimerkki: 2
releasesTaulukko <ReleaseData > Pakollinen: Digitaaliset julkaisut

Esimerkki: [{"changelog":"Manual update","files":[{"file_id":"00000000-0000-4000-8000-000000000001","sort_order":0,"version_id":"00000000-0000-4000-8000-000000000001"}],"id":"00000000-0000-4000-8000-000000000001","manifest_sha256":"1111111111111111111111111111111111111111111111111111111111111111","published_at":null,"release_sequence":null,"state":"active","version_label":"1.0","withdrawn_at":null}]
update_daysKokonaisluku nullPakollinen: Päivien määrä (days; null)

Esimerkki: 365
update_modeMerkkijonoPakollinen: Tulevien tiedostojen käyttöoikeus oston jälkeen: none / period / unlimited

Esimerkki: "period"
update_monthsKokonaisluku nullPakollinen: Kuukaudet (months; null)

Esimerkki: null

Lisäkentät: Ei

UpdatePolicy

UpdatePolicy · Tämä toiminto on poistettu käytöstä ja palauttaa 409 muuttamatta tietoja. Määritä jokaisen digitaalisen tiedoston käyttöoikeus valitsemalla vastaanottajat.

daysKokonaisluku nullValinnainen

Päivien määrä (1–3650; mode=period; months=null)

Kokonaisluku:minimum: 1maximum: 3650

Esimerkki: 365

expected_versionKokonaislukuPakollinen

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

minimum: 1maximum: 9223372036854775807

Esimerkki: 1

modeMerkkijonoPakollinen

Tulevien tiedostojen käyttöoikeus oston jälkeen: none / period / unlimited

Rajoitukset

enum: ["none", "period", "unlimited"]

Esimerkki: "period"

monthsKokonaisluku nullValinnainen

Kuukaudet (1–120; mode=period; days=null)

Kokonaisluku:minimum: 1maximum: 120

Esimerkki: null

Lisäkentät: Ei

UploadCreate

UploadCreate · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset. Lähetä tiedostot multipart/form-data-muodossa upload_id-tunnuksen luonnin jälkeen ja liitä ne tuotteeseen. Lataaminen vaatii Bearer-tunnuksen ja category-oikeuden; vastaus sisältää tiedoston tavut ilman julkista osoitetta tai salasanaa. Kun mode=period, valitse days (1–3650) tai aiempi months, älä molempia. Ehdot tallennetaan ostohetkellä; hyvitys poistaa käyttöoikeuden vain hyvitetyltä tilausriviltä.

filenameMerkkijonoPakollinen

Tiedosto

minLength: 1maxLength: 255

Esimerkki: "manual.pdf"

product_idMerkkijono nullValinnainen

Tuotteen tunniste.

Rajoitukset · Merkkijono 1

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

Esimerkki: "example"

sha256MerkkijonoPakollinen

SHA-256 (hex, 64)

Rajoitukset

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

Esimerkki: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"

size_bytesKokonaislukuPakollinen

Koko tavuina

minimum: 1maximum: 262144000

Esimerkki: 46

Lisäkentät: Ei

UploadData

UploadData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset. Lähetä tiedostot multipart/form-data-muodossa upload_id-tunnuksen luonnin jälkeen ja liitä ne tuotteeseen. Lataaminen vaatii Bearer-tunnuksen ja category-oikeuden; vastaus sisältää tiedoston tavut ilman julkista osoitetta tai salasanaa. Kun mode=period, valitse days (1–3650) tai aiempi months, älä molempia. Ehdot tallennetaan ostohetkellä; hyvitys poistaa käyttöoikeuden vain hyvitetyltä tilausriviltä.

categoryFileCategory Pakollinen: Tiedostoluokka: internal / customer_document / digital

Esimerkki: "digital"
expires_atMerkkijonoPakollinen: Käyttöoikeustunnuksen vanhenemispäivä ja -aika.

format: "date-time"

Esimerkki: "2026-01-01T12:00:00Z"
filenameMerkkijonoPakollinen: Tiedosto

Esimerkki: "manual.pdf"
idMerkkijonoPakollinen: Resurssin tunniste; säilytä se palautetussa muodossa.

format: "uuid"

Esimerkki: "00000000-0000-4000-8000-000000000001"
product_idMerkkijono nullPakollinen: Tuotteen tunniste.

Esimerkki: "example"
received_bytesKokonaislukuPakollinen: Lähetetään… · Koko tavuina

Esimerkki: 46
sha256MerkkijonoPakollinen: SHA-256 (hex, 64)

Esimerkki: "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd"
size_bytesKokonaislukuPakollinen: Koko tavuina

Esimerkki: 46
statusMerkkijonoPakollinen: Tämän nimenomaisen toiminnon hyväksymä tila.

Esimerkki: "ready"

Lisäkentät: Ei