Datová schémata: Varianty a možnosti

Datová schémata: Varianty a možnosti. Pole, typy a omezení dat přijímaných nebo vracených API.

Datová schémata

Vypsat · Varianty produktu — Varianty a možnosti — Odpověď

ApiResponse_list_ProductVariantData__ · Pole, typy a omezení dat přijímaných nebo vracených API.

dataPole <ProductVariantData > Povinné: Příklad odpovědi · ApiResponse_list_ProductVariantData__.

Pří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é: Metadata odpovědi.

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

Další pole: Ne

Vypsat · Možnosti — Varianty a možnosti — Odpověď

ApiResponse_list_VariantOptionData__ · Pole, typy a omezení dat přijímaných nebo vracených API.

dataPole <shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData > Povinné: Příklad odpovědi · ApiResponse_list_VariantOptionData__.

Pří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é: Metadata odpovědi.

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

Další pole: Ne

Vypsat · Hodnoty možností — Varianty a možnosti — Odpověď

ApiResponse_list_VariantValueData__ · Pole, typy a omezení dat přijímaných nebo vracených API.

dataPole <VariantValueData > Povinné: Příklad odpovědi · ApiResponse_list_VariantValueData__.

Pří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é: Metadata odpovědi.

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

Další pole: Ne

Načíst · Varianty produktu — Varianty a možnosti — Odpověď

ApiResponse_ProductVariantData_ · Pole, typy a omezení dat přijímaných nebo vracených API.

dataProductVariantData Povinné: Příklad odpovědi · ProductVariantData.

Pří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é: Metadata odpovědi.

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

Další pole: Ne

Načíst · Možnosti — Varianty a možnosti — Odpověď

ApiResponse_VariantOptionData_ · Pole, typy a omezení dat přijímaných nebo vracených API.

datashopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData Povinné: Příklad odpovědi · shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData.

Pří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é: Metadata odpovědi.

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

Další pole: Ne

Načíst · Hodnoty možností — Varianty a možnosti — Odpověď

ApiResponse_VariantValueData_ · Pole, typy a omezení dat přijímaných nebo vracených API.

dataVariantValueData Povinné: Příklad odpovědi · VariantValueData.

Pří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é: Metadata odpovědi.

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

Další pole: Ne

Načíst · Možnosti — Varianty a možnosti — Odpověď

shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData · Pole, typy a omezení dat přijímaných nebo vracených API.

created_atŘetězecPovinné

Čas vytvoření.

format: "date-time"

Příklad: "2026-01-01T12:00:00Z"

idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData).

Příklad: "example"

nameŘetězec nullPovinné

Název zdroje v příslušném kontextu.

Příklad: "Example"

numberŘetězecPovinné

Číslo objednávky nebo zákaznického požadavku určené pro uživatele.

Příklad: "example"

positionCelé čísloPovinné

Pozice v seřazeném seznamu.

Příklad: 1

selection_typeŘetězecPovinné

Povolený režim výběru hodnot vlastnosti.

Omezení

enum: ["button", "dropdown"]

Příklad: "button"

updated_atŘetězecPovinné

Čas poslední aktualizace.

format: "date-time"

Příklad: "2026-01-01T12:00:00Z"

value_presentation_typeŘetězecPovinné

Způsob zobrazení hodnot číselníku.

Omezení

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

Příklad: "text"

versionCelé čísloPovinné

Verze zdroje používaná k řízení souběžných změn.

Příklad: 1

Další pole: Ne

Načíst · Varianty produktu — Varianty a možnosti — Odpověď

ProductVariantData · Pole, typy a omezení dat přijímaných nebo vracených API.

activeLogická hodnotaPovinné: Zda je zdroj aktivní.

Příklad: true
created_atŘetězecPovinné: Čas vytvoření.

format: "date-time"

Příklad: "2026-01-01T12:00:00Z"
idŘetězecPovinné: Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (ProductVariantData).

Příklad: "example"
is_defaultLogická hodnotaPovinné: Zda jde o výchozí volbu.

Příklad: true
media_idsPole <Řetězec> Povinné: Identifikátory již existujících mediálních souborů.

Příklad: ["example"]
positionCelé čísloPovinné: Pozice v seřazeném seznamu.

Příklad: 1
pricingVariantPricingData Povinné: Nastavení cen a jejich verze pro řízení souběžných změn.

Pří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_idŘetězec nullPovinné: Identifikátor hlavního mediálního souboru.

Příklad: "example"
product_idŘetězecPovinné: Identifikátor produktu.

Příklad: "example"
skuŘetězecPovinné: Skladový kód položky.

Příklad: "example"
updated_atŘetězecPovinné: Čas poslední aktualizace.

format: "date-time"

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

Příklad: [{"option_id":"example","option_name":"example","value":"example","value_id":"example"}]
versionCelé čísloPovinné: Verze zdroje používaná k řízení souběžných změn.

Příklad: 1

Další pole: Ne

Hodnoty číselníku

VariantChoiceData · Schéma · Datová schémata: Varianty a možnosti

option_idŘetězecPovinné: Identifikátor možnosti varianty.

Příklad: "example"
option_nameŘetězec nullPovinné: Název možnosti varianty.

Příklad: "example"
valueŘetězec nullPovinné: Hodnota popsaná okolním schématem.

Příklad: "example"
value_idŘetězecPovinné: Identifikátor hodnoty číselníku.

Příklad: "example"

Další pole: Ne

Vytvořit · Varianty produktu — Varianty a možnosti — Tělo požadavku

VariantCreate · Pole, typy a omezení dat přijímaných nebo vracených API.

activeLogická hodnotaVolitelné

Zda je zdroj aktivní.

Výchozí hodnota: true

expected_versionCelé čísloPovinné

Verze načtená před zápisem; při neshodě se aktualizace odmítne.

minimum: 1maximum: 9223372036854775807

Příklad: 1

is_defaultLogická hodnotaVolitelné

Zda jde o výchozí volbu.

media_idsPole <Řetězec> Volitelné

Identifikátory již existujících mediálních souborů.

maxItems: 20

Pole:minLength: 1maxLength: 63

pricingVariantPrice Volitelné

Nastavení cen a jejich verze pro řízení souběžných změn.

skuŘetězecVolitelné

Skladový kód položky.

minLength: 1maxLength: 100

Omezení

pattern: "^\\S+$"

value_idsPole <Řetězec> Povinné

Identifikátory hodnot číselníku.

minItems: 1maxItems: 250

Pole:minLength: 1maxLength: 63

Příklad: ["example"]

Další pole: Ne

Vytvořit · Možnosti — Varianty a možnosti — Tělo požadavku

VariantOptionCreate · Pole, typy a omezení dat přijímaných nebo vracených API.

nameŘetězecPovinné

Název zdroje v příslušném kontextu.

minLength: 1maxLength: 120

Omezení

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

Příklad: "Example"

selection_typeŘetězecVolitelné

Povolený režim výběru hodnot vlastnosti.

Omezení

enum: ["button", "dropdown"]

Výchozí hodnota: "button"

value_presentation_typeŘetězecVolitelné

Způsob zobrazení hodnot číselníku.

Omezení

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

Výchozí hodnota: "text"

Další pole: Ne

Upravit · Možnosti — Varianty a možnosti — Tělo požadavku

VariantOptionUpdate · Pole, typy a omezení dat přijímaných nebo vracených API.

expected_versionCelé čísloPovinné

Verze načtená před zápisem; při neshodě se aktualizace odmítne.

minimum: 1maximum: 9223372036854775807

Příklad: 1

nameŘetězec nullVolitelné

Název zdroje v příslušném kontextu.

Řetězec:minLength: 1maxLength: 120

Omezení · Řetězec 1

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

Příklad: "Example"

selection_typeŘetězecVolitelné

Povolený režim výběru hodnot vlastnosti.

Omezení

enum: ["button", "dropdown"]

value_presentation_typeŘetězecVolitelné

Způsob zobrazení hodnot číselníku.

Omezení

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

Další pole: Ne

Nastavení cen a jejich verze pro řízení souběžných změn

VariantPrice · Schéma · Datová schémata: Varianty a možnosti

amountŘetězec nullPovinné

Desetinná částka zapsaná jako řetězec JSON; null pouze tam, kde je povoleno.

Řetězec:maxLength: 20

Omezení · Řetězec 1

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

Příklad: "0.00"

currencyŘetězecPovinné

Kód měny částky.

Omezení

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

Příklad: "PLN"

expected_price_list_versionCelé čísloPovinné

Dříve načtená verze ceníku požadovaná pro tento zápis.

minimum: 1maximum: 9223372036854775807

Příklad: 1

expected_product_versionCelé čísloPovinné

Dříve načtená verze produktu požadovaná pro tento zápis.

minimum: 0maximum: 9223372036854775807

Příklad: 1

expected_versionCelé čísloPovinné

Verze načtená před zápisem; při neshodě se aktualizace odmítne.

minimum: 0maximum: 9223372036854775807

Příklad: 0

kindŘetězecPovinné

Varianta datové struktury popsaná povolenými hodnotami.

Omezení

enum: ["base_adjustment", "market_fixed"]

Příklad: "base_adjustment"

price_list_idŘetězecPovinné

Identifikátor ceníku.

minLength: 1maxLength: 63

Příklad: "example"

Další pole: Ne

Nastavení cen a jejich verze pro řízení souběžných změn

VariantPricingData · Schéma · Datová schémata: Varianty a možnosti

base_adjustmentMoneyData Povinné: Úprava ceny vůči základní ceně.

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

Příklad: null
pricePriceData nullPovinné: Informace o ceně ve vybraném kontextu.

Příklad: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
product_versionCelé čísloPovinné: Aktuální verze produktu pro řízení souběžných změn.

Příklad: 1
versionCelé čísloPovinné: Verze zdroje používaná k řízení souběžných změn.

Příklad: 1

Další pole: Ne

Upravit · Varianty produktu — Varianty a možnosti — Tělo požadavku

VariantUpdate · Pole, typy a omezení dat přijímaných nebo vracených API.

activeLogická hodnotaVolitelné

Zda je zdroj aktivní.

expected_versionCelé čísloPovinné

Verze načtená před zápisem; při neshodě se aktualizace odmítne.

minimum: 1maximum: 9223372036854775807

Příklad: 1

is_defaultLogická hodnotaVolitelné

Zda jde o výchozí volbu.

media_idsPole <Řetězec> Volitelné

Identifikátory již existujících mediálních souborů.

maxItems: 20

Pole:minLength: 1maxLength: 63

pricingVariantPrice Volitelné

Nastavení cen a jejich verze pro řízení souběžných změn.

Pří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"}

skuŘetězecVolitelné

Skladový kód položky.

minLength: 1maxLength: 100

Omezení

pattern: "^\\S+$"

Příklad: "example"

Další pole: Ne

Vytvořit · Hodnoty možností — Varianty a možnosti — Tělo požadavku

VariantValueCreate · Pole, typy a omezení dat přijímaných nebo vracených API.

color_hexŘetězec nullVolitelné

Barva vyjádřená šestnáctkovým kódem.

Omezení · Řetězec 1

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

expected_versionCelé čísloPovinné

Verze načtená před zápisem; při neshodě se aktualizace odmítne.

minimum: 1maximum: 9223372036854775807

Příklad: 1

valueŘetězecPovinné

Hodnota popsaná okolním schématem.

minLength: 1maxLength: 180

Omezení

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

Příklad: "Example"

Další pole: Ne

Načíst · Hodnoty možností — Varianty a možnosti — Odpověď

VariantValueData · Pole, typy a omezení dat přijímaných nebo vracených API.

color_hexŘetězec nullPovinné: Barva vyjádřená šestnáctkovým kódem.

Příklad: "#008855"
created_atŘetězecPovinné: Čas vytvoření.

format: "date-time"

Příklad: "2026-01-01T12:00:00Z"
idŘetězecPovinné: Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (VariantValueData).

Příklad: "example"
image_media_idŘetězec nullPovinné: Identifikátor vybraného obrázkového souboru.

Příklad: null
numberŘetězecPovinné: Číslo objednávky nebo zákaznického požadavku určené pro uživatele.

Příklad: "example"
option_idŘetězecPovinné: Identifikátor možnosti varianty.

Příklad: "example"
positionCelé čísloPovinné: Pozice v seřazeném seznamu.

Příklad: 1
sku_codeŘetězecPovinné: Skladový kód položky.

Příklad: "example"
updated_atŘetězecPovinné: Čas poslední aktualizace.

format: "date-time"

Příklad: "2026-01-01T12:00:00Z"
valueŘetězec nullPovinné: Hodnota popsaná okolním schématem.

Příklad: "example"
versionCelé čísloPovinné: Verze zdroje používaná k řízení souběžných změn.

Příklad: 1

Další pole: Ne

Upravit · Hodnoty možností — Varianty a možnosti — Tělo požadavku

VariantValueUpdate · Pole, typy a omezení dat přijímaných nebo vracených API.

color_hexŘetězec nullVolitelné

Barva vyjádřená šestnáctkovým kódem.

Omezení · Řetězec 1

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

expected_versionCelé čísloPovinné

Verze načtená před zápisem; při neshodě se aktualizace odmítne.

minimum: 1maximum: 9223372036854775807

Příklad: 1

valueŘetězec nullVolitelné

Hodnota popsaná okolním schématem.

Řetězec:minLength: 1maxLength: 180

Omezení · Řetězec 1

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

Příklad: "Example"

Další pole: Ne