Tietoskeemat: Tuotteet

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

Tietoskeemat

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

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

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: 20

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

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: 20

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

Esimerkki: null

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