Dátové schémy: Varianty a možnosti

Dátové schémy: Varianty a možnosti. Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

Dátové schémy

Zobraziť zoznam · Varianty produktu — Varianty a možnosti — Odpoveď

ApiResponse_list_ProductVariantData__ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

dataPole <ProductVariantData > Povinné: Príklad odpovede · ApiResponse_list_ProductVariantData__.

Príklad: [{"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 Povinné: Metaúdaje odpovede.

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

Ďalšie polia: Nie

Zobraziť zoznam · Možnosti — Varianty a možnosti — Odpoveď

ApiResponse_list_VariantOptionData__ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

dataPole <shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData > Povinné: Príklad odpovede · ApiResponse_list_VariantOptionData__.

Príklad: [{"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 Povinné: Metaúdaje odpovede.

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

Ďalšie polia: Nie

Zobraziť zoznam · Hodnoty možností — Varianty a možnosti — Odpoveď

ApiResponse_list_VariantValueData__ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

dataPole <VariantValueData > Povinné: Príklad odpovede · ApiResponse_list_VariantValueData__.

Príklad: [{"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 Povinné: Metaúdaje odpovede.

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

Ďalšie polia: Nie

Načítať · Varianty produktu — Varianty a možnosti — Odpoveď

ApiResponse_ProductVariantData_ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

dataProductVariantData Povinné: Príklad odpovede · ProductVariantData.

Príklad: {"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 Povinné: Metaúdaje odpovede.

Príklad: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Ďalšie polia: Nie

Načítať · Možnosti — Varianty a možnosti — Odpoveď

ApiResponse_VariantOptionData_ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

datashopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData Povinné: Príklad odpovede · shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData.

Príklad: {"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 Povinné: Metaúdaje odpovede.

Príklad: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Ďalšie polia: Nie

Načítať · Hodnoty možností — Varianty a možnosti — Odpoveď

ApiResponse_VariantValueData_ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

dataVariantValueData Povinné: Príklad odpovede · VariantValueData.

Príklad: {"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 Povinné: Metaúdaje odpovede.

Príklad: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Ďalšie polia: Nie

Načítať · Možnosti — Varianty a možnosti — Odpoveď

shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

created_atReťazecPovinné

Čas vytvorenia.

format: "date-time"

Príklad: "2026-01-01T12:00:00Z"

idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData).

Príklad: "example"

nameReťazec nullPovinné

Názov zdroja v príslušnom kontexte.

Príklad: "Example"

numberReťazecPovinné

Číslo objednávky alebo zákazníckej žiadosti určené pre používateľa.

Príklad: "example"

positionCelé čísloPovinné

Pozícia v zoradenom zozname.

Príklad: 1

selection_typeReťazecPovinné

Povolený režim výberu hodnôt vlastnosti.

Obmedzenia

enum: ["button", "dropdown"]

Príklad: "button"

updated_atReťazecPovinné

Čas poslednej aktualizácie.

format: "date-time"

Príklad: "2026-01-01T12:00:00Z"

value_presentation_typeReťazecPovinné

Spôsob zobrazenia hodnôt číselníka.

Obmedzenia

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

Príklad: "text"

versionCelé čísloPovinné

Verzia zdroja používaná na riadenie súbežných zmien.

Príklad: 1

Ďalšie polia: Nie

Načítať · Varianty produktu — Varianty a možnosti — Odpoveď

ProductVariantData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

activeLogická hodnotaPovinné: Či je zdroj aktívny.

Príklad: true
created_atReťazecPovinné: Čas vytvorenia.

format: "date-time"

Príklad: "2026-01-01T12:00:00Z"
idReťazecPovinné: Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (ProductVariantData).

Príklad: "example"
is_defaultLogická hodnotaPovinné: Či ide o predvolenú voľbu.

Príklad: true
media_idsPole <Reťazec> Povinné: Identifikátory už existujúcich mediálnych súborov.

Príklad: ["example"]
positionCelé čísloPovinné: Pozícia v zoradenom zozname.

Príklad: 1
pricingVariantPricingData Povinné: Nastavenie cien a ich verzie na riadenie súbežných zmien.

Príklad: {"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_idReťazec nullPovinné: Identifikátor hlavného mediálneho súboru.

Príklad: "example"
product_idReťazecPovinné: Identifikátor produktu.

Príklad: "example"
skuReťazecPovinné: Skladový kód položky.

Príklad: "example"
updated_atReťazecPovinné: Čas poslednej aktualizácie.

format: "date-time"

Príklad: "2026-01-01T12:00:00Z"
valuesPole <VariantChoiceData > Povinné: Hodnoty číselníka.

Príklad: [{"option_id":"example","option_name":"example","value":"example","value_id":"example"}]
versionCelé čísloPovinné: Verzia zdroja používaná na riadenie súbežných zmien.

Príklad: 1

Ďalšie polia: Nie

Hodnoty číselníka

VariantChoiceData · Schéma · Dátové schémy: Varianty a možnosti

option_idReťazecPovinné: Identifikátor možnosti variantu.

Príklad: "example"
option_nameReťazec nullPovinné: Názov možnosti variantu.

Príklad: "example"
valueReťazec nullPovinné: Hodnota opísaná okolitou schémou.

Príklad: "example"
value_idReťazecPovinné: Identifikátor hodnoty číselníka.

Príklad: "example"

Ďalšie polia: Nie

Vytvoriť · Varianty produktu — Varianty a možnosti — Telo požiadavky

VariantCreate · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

activeLogická hodnotaVoliteľné

Či je zdroj aktívny.

Predvolená hodnota: true

expected_versionCelé čísloPovinné

Verzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.

minimum: 1maximum: 9223372036854775807

Príklad: 1

is_defaultLogická hodnotaVoliteľné

Či ide o predvolenú voľbu.

media_idsPole <Reťazec> Voliteľné

Identifikátory už existujúcich mediálnych súborov.

maxItems: 20

Pole:minLength: 1maxLength: 63

pricingVariantPrice Voliteľné

Nastavenie cien a ich verzie na riadenie súbežných zmien.

skuReťazecVoliteľné

Skladový kód položky.

minLength: 1maxLength: 100

Obmedzenia

pattern: "^\\S+$"

value_idsPole <Reťazec> Povinné

Identifikátory hodnôt číselníka.

minItems: 1maxItems: 250

Pole:minLength: 1maxLength: 63

Príklad: ["example"]

Ďalšie polia: Nie

Vytvoriť · Možnosti — Varianty a možnosti — Telo požiadavky

VariantOptionCreate · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

nameReťazecPovinné

Názov zdroja v príslušnom kontexte.

minLength: 1maxLength: 120

Obmedzenia

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

Príklad: "Example"

selection_typeReťazecVoliteľné

Povolený režim výberu hodnôt vlastnosti.

Obmedzenia

enum: ["button", "dropdown"]

Predvolená hodnota: "button"

value_presentation_typeReťazecVoliteľné

Spôsob zobrazenia hodnôt číselníka.

Obmedzenia

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

Predvolená hodnota: "text"

Ďalšie polia: Nie

Upraviť · Možnosti — Varianty a možnosti — Telo požiadavky

VariantOptionUpdate · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

expected_versionCelé čísloPovinné

Verzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.

minimum: 1maximum: 9223372036854775807

Príklad: 1

nameReťazec nullVoliteľné

Názov zdroja v príslušnom kontexte.

Reťazec:minLength: 1maxLength: 120

Obmedzenia · Reťazec 1

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

Príklad: "Example"

selection_typeReťazecVoliteľné

Povolený režim výberu hodnôt vlastnosti.

Obmedzenia

enum: ["button", "dropdown"]

value_presentation_typeReťazecVoliteľné

Spôsob zobrazenia hodnôt číselníka.

Obmedzenia

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

Ďalšie polia: Nie

Nastavenie cien a ich verzie na riadenie súbežných zmien

VariantPrice · Schéma · Dátové schémy: Varianty a možnosti

amountReťazec nullPovinné

Desatinná suma zapísaná ako reťazec JSON; null iba tam, kde je povolené.

Reťazec:maxLength: 20

Obmedzenia · Reťazec 1

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

Príklad: "0.00"

currencyReťazecPovinné

Kód meny sumy.

Obmedzenia

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

Príklad: "PLN"

expected_price_list_versionCelé čísloPovinné

Skôr načítaná verzia cenníka požadovaná pre tento zápis.

minimum: 1maximum: 9223372036854775807

Príklad: 1

expected_product_versionCelé čísloPovinné

Skôr načítaná verzia produktu požadovaná pre tento zápis.

minimum: 0maximum: 9223372036854775807

Príklad: 1

expected_versionCelé čísloPovinné

Verzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.

minimum: 0maximum: 9223372036854775807

Príklad: 0

kindReťazecPovinné

Variant dátovej štruktúry opísaný povolenými hodnotami.

Obmedzenia

enum: ["base_adjustment", "market_fixed"]

Príklad: "base_adjustment"

price_list_idReťazecPovinné

Identifikátor cenníka.

minLength: 1maxLength: 63

Príklad: "example"

Ďalšie polia: Nie

Nastavenie cien a ich verzie na riadenie súbežných zmien

VariantPricingData · Schéma · Dátové schémy: Varianty a možnosti

base_adjustmentMoneyData Povinné: Úprava ceny voči základnej cene.

Príklad: {"amount":"0.00","currency":"PLN","minor_units":2}
market_priceMoneyData nullPovinné: Cena pre vybraný trh.

Príklad: null
pricePriceData nullPovinné: Informácie o cene vo vybranom kontexte.

Príklad: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
product_versionCelé čísloPovinné: Aktuálna verzia produktu na riadenie súbežných zmien.

Príklad: 1
versionCelé čísloPovinné: Verzia zdroja používaná na riadenie súbežných zmien.

Príklad: 1

Ďalšie polia: Nie

Upraviť · Varianty produktu — Varianty a možnosti — Telo požiadavky

VariantUpdate · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

activeLogická hodnotaVoliteľné

Či je zdroj aktívny.

expected_versionCelé čísloPovinné

Verzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.

minimum: 1maximum: 9223372036854775807

Príklad: 1

is_defaultLogická hodnotaVoliteľné

Či ide o predvolenú voľbu.

media_idsPole <Reťazec> Voliteľné

Identifikátory už existujúcich mediálnych súborov.

maxItems: 20

Pole:minLength: 1maxLength: 63

pricingVariantPrice Voliteľné

Nastavenie cien a ich verzie na riadenie súbežných zmien.

Príklad:

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

skuReťazecVoliteľné

Skladový kód položky.

minLength: 1maxLength: 100

Obmedzenia

pattern: "^\\S+$"

Príklad: "example"

Ďalšie polia: Nie

Vytvoriť · Hodnoty možností — Varianty a možnosti — Telo požiadavky

VariantValueCreate · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

color_hexReťazec nullVoliteľné

Farba vyjadrená šestnástkovým kódom.

Obmedzenia · Reťazec 1

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

expected_versionCelé čísloPovinné

Verzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.

minimum: 1maximum: 9223372036854775807

Príklad: 1

valueReťazecPovinné

Hodnota opísaná okolitou schémou.

minLength: 1maxLength: 180

Obmedzenia

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

Príklad: "Example"

Ďalšie polia: Nie

Načítať · Hodnoty možností — Varianty a možnosti — Odpoveď

VariantValueData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

color_hexReťazec nullPovinné: Farba vyjadrená šestnástkovým kódom.

Príklad: "#008855"
created_atReťazecPovinné: Čas vytvorenia.

format: "date-time"

Príklad: "2026-01-01T12:00:00Z"
idReťazecPovinné: Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (VariantValueData).

Príklad: "example"
image_media_idReťazec nullPovinné: Identifikátor vybraného obrázkového súboru.

Príklad: null
numberReťazecPovinné: Číslo objednávky alebo zákazníckej žiadosti určené pre používateľa.

Príklad: "example"
option_idReťazecPovinné: Identifikátor možnosti variantu.

Príklad: "example"
positionCelé čísloPovinné: Pozícia v zoradenom zozname.

Príklad: 1
sku_codeReťazecPovinné: Skladový kód položky.

Príklad: "example"
updated_atReťazecPovinné: Čas poslednej aktualizácie.

format: "date-time"

Príklad: "2026-01-01T12:00:00Z"
valueReťazec nullPovinné: Hodnota opísaná okolitou schémou.

Príklad: "example"
versionCelé čísloPovinné: Verzia zdroja používaná na riadenie súbežných zmien.

Príklad: 1

Ďalšie polia: Nie

Upraviť · Hodnoty možností — Varianty a možnosti — Telo požiadavky

VariantValueUpdate · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

color_hexReťazec nullVoliteľné

Farba vyjadrená šestnástkovým kódom.

Obmedzenia · Reťazec 1

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

expected_versionCelé čísloPovinné

Verzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.

minimum: 1maximum: 9223372036854775807

Príklad: 1

valueReťazec nullVoliteľné

Hodnota opísaná okolitou schémou.

Reťazec:minLength: 1maxLength: 180

Obmedzenia · Reťazec 1

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

Príklad: "Example"

Ďalšie polia: Nie