Adatsémák: Variánsok és opciók

dataTömb <ProductVariantData > Kötelező

Példaválasz · ApiResponse_list_ProductVariantData__.

Példa: [{"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 Kötelező

A válasz metaadatai.

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

További mezők: Nem

dataTömb <shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData > Kötelező

Példaválasz · ApiResponse_list_VariantOptionData__.

Példa: [{"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 Kötelező

A válasz metaadatai.

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

További mezők: Nem

dataTömb <VariantValueData > Kötelező

Példaválasz · ApiResponse_list_VariantValueData__.

Példa: [{"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 Kötelező

A válasz metaadatai.

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

További mezők: Nem

dataProductVariantData Kötelező

Példaválasz · ProductVariantData.

Példa: {"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 Kötelező

A válasz metaadatai.

Példa: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

További mezők: Nem

datashopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData Kötelező

Példaválasz · shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData.

Példa: {"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 Kötelező

A válasz metaadatai.

Példa: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

További mezők: Nem

dataVariantValueData Kötelező

Példaválasz · VariantValueData.

Példa: {"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 Kötelező

A válasz metaadatai.

Példa: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

További mezők: Nem

created_atKarakterláncKötelező

A létrehozás időpontja.

format: "date-time"

Példa: "2026-01-01T12:00:00Z"

idKarakterláncKötelező

Erőforrás-azonosító; a visszaadott alakban őrizze meg. (shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData).

Példa: "example"

nameKarakterlánc | nullKötelező

Az erőforrás neve az adott környezetben.

Példa: "Example"

numberKarakterláncKötelező

A rendelés vagy bejelentés felhasználóknak szánt száma.

Példa: "example"

positionEgész számKötelező

Pozíció a rendezett gyűjteményben.

Példa: 1

selection_typeKarakterláncKötelező

A jellemzőértékek megengedett kiválasztási módja.

Korlátozások

enum

["button", "dropdown"]

Példa: "button"

updated_atKarakterláncKötelező

A legutóbbi módosítás időpontja.

format: "date-time"

Példa: "2026-01-01T12:00:00Z"

value_presentation_typeKarakterláncKötelező

A szótárértékek megjelenítési módja.

Korlátozások

enum

["text", "color", "image"]

Példa: "text"

versionEgész számKötelező

Az erőforrás verziója az egyidejű módosítások ellenőrzéséhez.

Példa: 1

További mezők: Nem

activeLogikai értékKötelező

Jelzi, hogy az erőforrás aktív-e.

Példa: true

created_atKarakterláncKötelező

A létrehozás időpontja.

format: "date-time"

Példa: "2026-01-01T12:00:00Z"

idKarakterláncKötelező

Erőforrás-azonosító; a visszaadott alakban őrizze meg. (ProductVariantData).

Példa: "example"

is_defaultLogikai értékKötelező

Jelzi, hogy ez az alapértelmezett választás-e.

Példa: true

media_idsTömb <Karakterlánc> Kötelező

Már létező médiaelemek azonosítói.

Példa: ["example"]

positionEgész számKötelező

Pozíció a rendezett gyűjteményben.

Példa: 1

pricingVariantPricingData Kötelező

Árbeállítások és a hozzájuk tartozó verzióértékek.

Példa: {"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_idKarakterlánc | nullKötelező

Az elsődleges médiaelem azonosítója.

Példa: "example"

product_idKarakterláncKötelező

Termékazonosító.

Példa: "example"

skuKarakterláncKötelező

Készletnyilvántartási cikkszám.

Példa: "example"

updated_atKarakterláncKötelező

A legutóbbi módosítás időpontja.

format: "date-time"

Példa: "2026-01-01T12:00:00Z"

valuesTömb <VariantChoiceData > Kötelező

Szótárértékek.

Példa: [{"option_id":"example","option_name":"example","value":"example","value_id":"example"}]

versionEgész számKötelező

Az erőforrás verziója az egyidejű módosítások ellenőrzéséhez.

Példa: 1

További mezők: Nem

option_idKarakterláncKötelező

Variánsopció-azonosító.

Példa: "example"

option_nameKarakterlánc | nullKötelező

A variánsopció neve.

Példa: "example"

valueKarakterlánc | nullKötelező

A környező séma által leírt érték.

Példa: "example"

value_idKarakterláncKötelező

Szótárérték-azonosító.

Példa: "example"

További mezők: Nem

activeLogikai értékNem kötelező

Jelzi, hogy az erőforrás aktív-e.

Alapértelmezett: true

expected_versionEgész számKötelező

Az írás előtt kiolvasott verzió; eltérés esetén a módosítás elutasításra kerül.

minimum: 1maximum: 9223372036854775807

Példa: 1

is_defaultLogikai értékNem kötelező

Jelzi, hogy ez az alapértelmezett választás-e.

media_idsTömb <Karakterlánc> Nem kötelező

Már létező médiaelemek azonosítói.

maxItems: 20

Tömb:minLength: 1maxLength: 63

pricingVariantPrice Nem kötelező

Árbeállítások és a hozzájuk tartozó verzióértékek.

skuKarakterláncNem kötelező

Készletnyilvántartási cikkszám.

minLength: 1maxLength: 100

Korlátozások

pattern

"^\\S+$"

value_idsTömb <Karakterlánc> Kötelező

Szótárértékek azonosítói.

minItems: 1maxItems: 250

Tömb:minLength: 1maxLength: 63

Példa: ["example"]

További mezők: Nem

nameKarakterláncKötelező

Az erőforrás neve az adott környezetben.

minLength: 1maxLength: 120

Korlátozások

pattern

"^[^\\x00]*$"

Példa: "Example"

selection_typeKarakterláncNem kötelező

A jellemzőértékek megengedett kiválasztási módja.

Korlátozások

enum

["button", "dropdown"]

Alapértelmezett: "button"

value_presentation_typeKarakterláncNem kötelező

A szótárértékek megjelenítési módja.

Korlátozások

enum

["text", "color", "image"]

Alapértelmezett: "text"

További mezők: Nem

expected_versionEgész számKötelező

Az írás előtt kiolvasott verzió; eltérés esetén a módosítás elutasításra kerül.

minimum: 1maximum: 9223372036854775807

Példa: 1

nameKarakterlánc | nullNem kötelező

Az erőforrás neve az adott környezetben.

Karakterlánc:minLength: 1maxLength: 120

Korlátozások · Karakterlánc 1

pattern

"^[^\\x00]*$"

Példa: "Example"

selection_typeKarakterláncNem kötelező

A jellemzőértékek megengedett kiválasztási módja.

Korlátozások

enum

["button", "dropdown"]

value_presentation_typeKarakterláncNem kötelező

A szótárértékek megjelenítési módja.

Korlátozások

enum

["text", "color", "image"]

További mezők: Nem

amountKarakterlánc | nullKötelező

JSON-karakterláncként kódolt tizedes összeg; null csak ott, ahol engedélyezett.

Karakterlánc:maxLength: 20

Korlátozások · Karakterlánc 1

pattern

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

Példa: "0.00"

currencyKarakterláncKötelező

Az összeg pénznemkódja.

Korlátozások

pattern

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

Példa: "PLN"

expected_price_list_versionEgész számKötelező

Az íráshoz szükséges, korábban kiolvasott árlistaverzió.

minimum: 1maximum: 9223372036854775807

Példa: 1

expected_product_versionEgész számKötelező

Az íráshoz szükséges, korábban kiolvasott termékverzió.

minimum: 0maximum: 9223372036854775807

Példa: 1

expected_versionEgész számKötelező

Az írás előtt kiolvasott verzió; eltérés esetén a módosítás elutasításra kerül.

minimum: 0maximum: 9223372036854775807

Példa: 0

kindKarakterláncKötelező

Az adatstruktúra változata, a megengedett értékek szerint.

Korlátozások

enum

["base_adjustment", "market_fixed"]

Példa: "base_adjustment"

price_list_idKarakterláncKötelező

Árlista-azonosító.

minLength: 1maxLength: 63

Példa: "example"

További mezők: Nem

base_adjustmentMoneyData Kötelező

Az alapárhoz viszonyított ármódosítás.

Példa: {"amount":"0.00","currency":"PLN","minor_units":2}

market_priceMoneyData | nullKötelező

Ár a kiválasztott piacon.

Példa: null

pricePriceData | nullKötelező

Áradatok a kiválasztott környezetben.

Példa: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}

product_versionEgész számKötelező

A termék aktuális verziója az egyidejű módosítások ellenőrzéséhez.

Példa: 1

versionEgész számKötelező

Az erőforrás verziója az egyidejű módosítások ellenőrzéséhez.

Példa: 1

További mezők: Nem

activeLogikai értékNem kötelező

Jelzi, hogy az erőforrás aktív-e.

expected_versionEgész számKötelező

Az írás előtt kiolvasott verzió; eltérés esetén a módosítás elutasításra kerül.

minimum: 1maximum: 9223372036854775807

Példa: 1

is_defaultLogikai értékNem kötelező

Jelzi, hogy ez az alapértelmezett választás-e.

media_idsTömb <Karakterlánc> Nem kötelező

Már létező médiaelemek azonosítói.

maxItems: 20

Tömb:minLength: 1maxLength: 63

pricingVariantPrice Nem kötelező

Árbeállítások és a hozzájuk tartozó verzióértékek.

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

skuKarakterláncNem kötelező

Készletnyilvántartási cikkszám.

minLength: 1maxLength: 100

Korlátozások

pattern

"^\\S+$"

Példa: "example"

További mezők: Nem

color_hexKarakterlánc | nullNem kötelező

Hexadecimális kóddal megadott szín.

Korlátozások · Karakterlánc 1

pattern

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

expected_versionEgész számKötelező

Az írás előtt kiolvasott verzió; eltérés esetén a módosítás elutasításra kerül.

minimum: 1maximum: 9223372036854775807

Példa: 1

valueKarakterláncKötelező

A környező séma által leírt érték.

minLength: 1maxLength: 180

Korlátozások

pattern

"^[^\\x00]*$"

Példa: "Example"

További mezők: Nem

color_hexKarakterlánc | nullKötelező

Hexadecimális kóddal megadott szín.

Példa: "#008855"

created_atKarakterláncKötelező

A létrehozás időpontja.

format: "date-time"

Példa: "2026-01-01T12:00:00Z"

idKarakterláncKötelező

Erőforrás-azonosító; a visszaadott alakban őrizze meg. (VariantValueData).

Példa: "example"

image_media_idKarakterlánc | nullKötelező

A kiválasztott képfájl azonosítója.

Példa: null

numberKarakterláncKötelező

A rendelés vagy bejelentés felhasználóknak szánt száma.

Példa: "example"

option_idKarakterláncKötelező

Variánsopció-azonosító.

Példa: "example"

positionEgész számKötelező

Pozíció a rendezett gyűjteményben.

Példa: 1

sku_codeKarakterláncKötelező

Készletnyilvántartási cikkszám.

Példa: "example"

updated_atKarakterláncKötelező

A legutóbbi módosítás időpontja.

format: "date-time"

Példa: "2026-01-01T12:00:00Z"

valueKarakterlánc | nullKötelező

A környező séma által leírt érték.

Példa: "example"

versionEgész számKötelező

Az erőforrás verziója az egyidejű módosítások ellenőrzéséhez.

Példa: 1

További mezők: Nem

color_hexKarakterlánc | nullNem kötelező

Hexadecimális kóddal megadott szín.

Korlátozások · Karakterlánc 1

pattern

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

expected_versionEgész számKötelező

Az írás előtt kiolvasott verzió; eltérés esetén a módosítás elutasításra kerül.

minimum: 1maximum: 9223372036854775807

Példa: 1

valueKarakterlánc | nullNem kötelező

A környező séma által leírt érték.

Karakterlánc:minLength: 1maxLength: 180

Korlátozások · Karakterlánc 1

pattern

"^[^\\x00]*$"

Példa: "Example"

További mezők: Nem