Tietoskeemat: Variantit ja valinnat

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

Tietoskeemat

Listaa · Tuotevariantit — Variantit ja valinnat — Vastaus

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

dataTaulukko <ProductVariantData > Pakollinen: Vastausesimerkki · ApiResponse_list_ProductVariantData__.

Esimerkki: [{"active":true,"created_at":"2026-01-01T12:00:00Z","id":"example","is_default":true,"media_ids":["example"],"position":1,"pricing":{"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1},"primary_media_id":"example","product_id":"example","sku":"example","updated_at":"2026-01-01T12:00:00Z","values":[{"option_id":"example","option_name":"example","value":"example","value_id":"example"}],"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

Listaa · Vaihtoehdot — Variantit ja valinnat — Vastaus

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

dataTaulukko <shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData > Pakollinen: Vastausesimerkki · ApiResponse_list_VariantOptionData__.

Esimerkki: [{"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","position":1,"selection_type":"button","updated_at":"2026-01-01T12:00:00Z","value_presentation_type":"text","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

Listaa · Vaihtoehtojen arvot — Variantit ja valinnat — Vastaus

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

dataTaulukko <VariantValueData > Pakollinen: Vastausesimerkki · ApiResponse_list_VariantValueData__.

Esimerkki: [{"color_hex":"#008855","created_at":"2026-01-01T12:00:00Z","id":"example","image_media_id":null,"number":"example","option_id":"example","position":1,"sku_code":"example","updated_at":"2026-01-01T12:00:00Z","value":"example","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 · Tuotevariantit — Variantit ja valinnat — Vastaus

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

dataProductVariantData Pakollinen: Vastausesimerkki · ProductVariantData.

Esimerkki: {"active":true,"created_at":"2026-01-01T12:00:00Z","id":"example","is_default":true,"media_ids":["example"],"position":1,"pricing":{"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1},"primary_media_id":"example","product_id":"example","sku":"example","updated_at":"2026-01-01T12:00:00Z","values":[{"option_id":"example","option_name":"example","value":"example","value_id":"example"}],"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

Hae · Vaihtoehdot — Variantit ja valinnat — Vastaus

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

datashopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData Pakollinen: Vastausesimerkki · shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData.

Esimerkki: {"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","position":1,"selection_type":"button","updated_at":"2026-01-01T12:00:00Z","value_presentation_type":"text","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

Hae · Vaihtoehtojen arvot — Variantit ja valinnat — Vastaus

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

dataVariantValueData Pakollinen: Vastausesimerkki · VariantValueData.

Esimerkki: {"color_hex":"#008855","created_at":"2026-01-01T12:00:00Z","id":"example","image_media_id":null,"number":"example","option_id":"example","position":1,"sku_code":"example","updated_at":"2026-01-01T12:00:00Z","value":"example","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

Hae · Vaihtoehdot — Variantit ja valinnat — Vastaus

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

created_atMerkkijonoPakollinen

Luontiajankohta.

format: "date-time"

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

idMerkkijonoPakollinen

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

Esimerkki: "example"

nameMerkkijono nullPakollinen

Resurssin nimi kyseisessä kontekstissa.

Esimerkki: "Example"

numberMerkkijonoPakollinen

Ihmiselle tarkoitettu tilaus- tai tapausnumero.

Esimerkki: "example"

positionKokonaislukuPakollinen

Sijainti järjestetyssä kokoelmassa.

Esimerkki: 1

selection_typeMerkkijonoPakollinen

Ominaisuusarvojen sallittu valintatapa.

Rajoitukset

enum: ["button", "dropdown"]

Esimerkki: "button"

updated_atMerkkijonoPakollinen

Viimeisimmän päivityksen ajankohta.

format: "date-time"

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

value_presentation_typeMerkkijonoPakollinen

Luetteloarvojen esitystapa.

Rajoitukset

enum: ["text", "color", "image"]

Esimerkki: "text"

versionKokonaislukuPakollinen

Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 1

Lisäkentät: Ei

Hae · Tuotevariantit — Variantit ja valinnat — Vastaus

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

activeTotuusarvoPakollinen: Onko resurssi aktiivinen.

Esimerkki: true
created_atMerkkijonoPakollinen: Luontiajankohta.

format: "date-time"

Esimerkki: "2026-01-01T12:00:00Z"
idMerkkijonoPakollinen: Resurssin tunniste; säilytä se palautetussa muodossa. (ProductVariantData).

Esimerkki: "example"
is_defaultTotuusarvoPakollinen: Onko tämä oletusvalinta.

Esimerkki: true
media_idsTaulukko <Merkkijono> Pakollinen: Jo olemassa olevien medioiden tunnisteet.

Esimerkki: ["example"]
positionKokonaislukuPakollinen: Sijainti järjestetyssä kokoelmassa.

Esimerkki: 1
pricingVariantPricingData Pakollinen: Hintamääritykset ja niiden samanaikaisuuden hallinnan versiot.

Esimerkki: {"base_adjustment":{"amount":"0.00","currency":"PLN","minor_units":2},"market_price":null,"price":{"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true},"product_version":1,"version":1}
primary_media_idMerkkijono nullPakollinen: Ensisijaisen median tunniste.

Esimerkki: "example"
product_idMerkkijonoPakollinen: Tuotteen tunniste.

Esimerkki: "example"
skuMerkkijonoPakollinen: Varastonimikkeen SKU-koodi.

Esimerkki: "example"
updated_atMerkkijonoPakollinen: Viimeisimmän päivityksen ajankohta.

format: "date-time"

Esimerkki: "2026-01-01T12:00:00Z"
valuesTaulukko <VariantChoiceData > Pakollinen: Luetteloarvot.

Esimerkki: [{"option_id":"example","option_name":"example","value":"example","value_id":"example"}]
versionKokonaislukuPakollinen: Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 1

Lisäkentät: Ei

Luetteloarvot

VariantChoiceData · Skeema · Tietoskeemat: Variantit ja valinnat

option_idMerkkijonoPakollinen: Varianttivalinnan tunniste.

Esimerkki: "example"
option_nameMerkkijono nullPakollinen: Varianttivalinnan nimi.

Esimerkki: "example"
valueMerkkijono nullPakollinen: Ympäröivän skeeman kuvaama arvo.

Esimerkki: "example"
value_idMerkkijonoPakollinen: Luetteloarvon tunniste.

Esimerkki: "example"

Lisäkentät: Ei

Luo · Tuotevariantit — Variantit ja valinnat — Pyynnön sisältö

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

activeTotuusarvoValinnainen

Onko resurssi aktiivinen.

Oletus: true

expected_versionKokonaislukuPakollinen

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

minimum: 1maximum: 9223372036854775807

Esimerkki: 1

is_defaultTotuusarvoValinnainen

Onko tämä oletusvalinta.

media_idsTaulukko <Merkkijono> Valinnainen

Jo olemassa olevien medioiden tunnisteet.

maxItems: 20

Taulukko:minLength: 1maxLength: 63

pricingVariantPrice Valinnainen

Hintamääritykset ja niiden samanaikaisuuden hallinnan versiot.

skuMerkkijonoValinnainen

Varastonimikkeen SKU-koodi.

minLength: 1maxLength: 100

Rajoitukset

pattern: "^\\S+$"

value_idsTaulukko <Merkkijono> Pakollinen

Luetteloarvojen tunnisteet.

minItems: 1maxItems: 250

Taulukko:minLength: 1maxLength: 63

Esimerkki: ["example"]

Lisäkentät: Ei

Luo · Vaihtoehdot — Variantit ja valinnat — Pyynnön sisältö

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

nameMerkkijonoPakollinen

Resurssin nimi kyseisessä kontekstissa.

minLength: 1maxLength: 120

Rajoitukset

pattern: "^[^\\x00]*$"

Esimerkki: "Example"

selection_typeMerkkijonoValinnainen

Ominaisuusarvojen sallittu valintatapa.

Rajoitukset

enum: ["button", "dropdown"]

Oletus: "button"

value_presentation_typeMerkkijonoValinnainen

Luetteloarvojen esitystapa.

Rajoitukset

enum: ["text", "color", "image"]

Oletus: "text"

Lisäkentät: Ei

Päivitä · Vaihtoehdot — Variantit ja valinnat — Pyynnön sisältö

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

expected_versionKokonaislukuPakollinen

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

minimum: 1maximum: 9223372036854775807

Esimerkki: 1

nameMerkkijono nullValinnainen

Resurssin nimi kyseisessä kontekstissa.

Merkkijono:minLength: 1maxLength: 120

Rajoitukset · Merkkijono 1

pattern: "^[^\\x00]*$"

Esimerkki: "Example"

selection_typeMerkkijonoValinnainen

Ominaisuusarvojen sallittu valintatapa.

Rajoitukset

enum: ["button", "dropdown"]

value_presentation_typeMerkkijonoValinnainen

Luetteloarvojen esitystapa.

Rajoitukset

enum: ["text", "color", "image"]

Lisäkentät: Ei

Hintamääritykset ja niiden samanaikaisuuden hallinnan versiot

VariantPrice · Skeema · Tietoskeemat: Variantit ja valinnat

amountMerkkijono nullPakollinen

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

Merkkijono:maxLength: 20

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_product_versionKokonaislukuPakollinen

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

minimum: 0maximum: 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_adjustment", "market_fixed"]

Esimerkki: "base_adjustment"

price_list_idMerkkijonoPakollinen

Hinnaston tunniste.

minLength: 1maxLength: 63

Esimerkki: "example"

Lisäkentät: Ei

Hintamääritykset ja niiden samanaikaisuuden hallinnan versiot

VariantPricingData · Skeema · Tietoskeemat: Variantit ja valinnat

base_adjustmentMoneyData Pakollinen: Hinnan muutos suhteessa perushintaan.

Esimerkki: {"amount":"0.00","currency":"PLN","minor_units":2}
market_priceMoneyData nullPakollinen: Valitun markkina-alueen hinta.

Esimerkki: null
pricePriceData nullPakollinen: Valitun kontekstin hintatiedot.

Esimerkki: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
product_versionKokonaislukuPakollinen: Nykyinen tuoteversio samanaikaisuuden hallintaan.

Esimerkki: 1
versionKokonaislukuPakollinen: Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 1

Lisäkentät: Ei

Päivitä · Tuotevariantit — Variantit ja valinnat — Pyynnön sisältö

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

activeTotuusarvoValinnainen

Onko resurssi aktiivinen.

expected_versionKokonaislukuPakollinen

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

minimum: 1maximum: 9223372036854775807

Esimerkki: 1

is_defaultTotuusarvoValinnainen

Onko tämä oletusvalinta.

media_idsTaulukko <Merkkijono> Valinnainen

Jo olemassa olevien medioiden tunnisteet.

maxItems: 20

Taulukko:minLength: 1maxLength: 63

pricingVariantPrice Valinnainen

Hintamääritykset ja niiden samanaikaisuuden hallinnan versiot.

Esimerkki:

{"amount":"0.00","currency":"PLN","expected_price_list_version":1,"expected_product_version":1,"expected_version":0,"kind":"base_adjustment","price_list_id":"example"}

skuMerkkijonoValinnainen

Varastonimikkeen SKU-koodi.

minLength: 1maxLength: 100

Rajoitukset

pattern: "^\\S+$"

Esimerkki: "example"

Lisäkentät: Ei

Luo · Vaihtoehtojen arvot — Variantit ja valinnat — Pyynnön sisältö

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

color_hexMerkkijono nullValinnainen

Heksadesimaalikoodina esitetty väri.

Rajoitukset · Merkkijono 1

pattern: "^#[0-9A-Fa-f]{6}$"

expected_versionKokonaislukuPakollinen

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

minimum: 1maximum: 9223372036854775807

Esimerkki: 1

valueMerkkijonoPakollinen

Ympäröivän skeeman kuvaama arvo.

minLength: 1maxLength: 180

Rajoitukset

pattern: "^[^\\x00]*$"

Esimerkki: "Example"

Lisäkentät: Ei

Hae · Vaihtoehtojen arvot — Variantit ja valinnat — Vastaus

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

color_hexMerkkijono nullPakollinen: Heksadesimaalikoodina esitetty väri.

Esimerkki: "#008855"
created_atMerkkijonoPakollinen: Luontiajankohta.

format: "date-time"

Esimerkki: "2026-01-01T12:00:00Z"
idMerkkijonoPakollinen: Resurssin tunniste; säilytä se palautetussa muodossa. (VariantValueData).

Esimerkki: "example"
image_media_idMerkkijono nullPakollinen: Valitun kuvamedian tunniste.

Esimerkki: null
numberMerkkijonoPakollinen: Ihmiselle tarkoitettu tilaus- tai tapausnumero.

Esimerkki: "example"
option_idMerkkijonoPakollinen: Varianttivalinnan tunniste.

Esimerkki: "example"
positionKokonaislukuPakollinen: Sijainti järjestetyssä kokoelmassa.

Esimerkki: 1
sku_codeMerkkijonoPakollinen: Varastonimikkeen SKU-koodi.

Esimerkki: "example"
updated_atMerkkijonoPakollinen: Viimeisimmän päivityksen ajankohta.

format: "date-time"

Esimerkki: "2026-01-01T12:00:00Z"
valueMerkkijono nullPakollinen: Ympäröivän skeeman kuvaama arvo.

Esimerkki: "example"
versionKokonaislukuPakollinen: Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 1

Lisäkentät: Ei

Päivitä · Vaihtoehtojen arvot — Variantit ja valinnat — Pyynnön sisältö

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

color_hexMerkkijono nullValinnainen

Heksadesimaalikoodina esitetty väri.

Rajoitukset · Merkkijono 1

pattern: "^#[0-9A-Fa-f]{6}$"

expected_versionKokonaislukuPakollinen

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

minimum: 1maximum: 9223372036854775807

Esimerkki: 1

valueMerkkijono nullValinnainen

Ympäröivän skeeman kuvaama arvo.

Merkkijono:minLength: 1maxLength: 180

Rajoitukset · Merkkijono 1

pattern: "^[^\\x00]*$"

Esimerkki: "Example"

Lisäkentät: Ei