Scheme de date: Variante și opțiuni

Scheme de date: Variante și opțiuni. Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

Scheme de date

Listează · Variante de produs — Variante și opțiuni — Răspuns

ApiResponse_list_ProductVariantData__ · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

dataTablou <ProductVariantData > Obligatoriu: Exemplu de răspuns · ApiResponse_list_ProductVariantData__.

Exemplu: [{"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 Obligatoriu: Metadatele răspunsului.

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

Câmpuri suplimentare: Nu

Listează · Opțiuni — Variante și opțiuni — Răspuns

ApiResponse_list_VariantOptionData__ · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

dataTablou <shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData > Obligatoriu: Exemplu de răspuns · ApiResponse_list_VariantOptionData__.

Exemplu: [{"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 Obligatoriu: Metadatele răspunsului.

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

Câmpuri suplimentare: Nu

Listează · Valorile opțiunilor — Variante și opțiuni — Răspuns

ApiResponse_list_VariantValueData__ · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

dataTablou <VariantValueData > Obligatoriu: Exemplu de răspuns · ApiResponse_list_VariantValueData__.

Exemplu: [{"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 Obligatoriu: Metadatele răspunsului.

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

Câmpuri suplimentare: Nu

Obține · Variante de produs — Variante și opțiuni — Răspuns

ApiResponse_ProductVariantData_ · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

dataProductVariantData Obligatoriu: Exemplu de răspuns · ProductVariantData.

Exemplu: {"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 Obligatoriu: Metadatele răspunsului.

Exemplu: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Câmpuri suplimentare: Nu

Obține · Opțiuni — Variante și opțiuni — Răspuns

ApiResponse_VariantOptionData_ · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

datashopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData Obligatoriu: Exemplu de răspuns · shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData.

Exemplu: {"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 Obligatoriu: Metadatele răspunsului.

Exemplu: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Câmpuri suplimentare: Nu

Obține · Valorile opțiunilor — Variante și opțiuni — Răspuns

ApiResponse_VariantValueData_ · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

dataVariantValueData Obligatoriu: Exemplu de răspuns · VariantValueData.

Exemplu: {"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 Obligatoriu: Metadatele răspunsului.

Exemplu: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Câmpuri suplimentare: Nu

Obține · Opțiuni — Variante și opțiuni — Răspuns

shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

created_atȘir de caractereObligatoriu

Momentul creării.

format: "date-time"

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

idȘir de caractereObligatoriu

Identificatorul resursei; păstrați-l în forma returnată. (shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData).

Exemplu: "example"

nameȘir de caractere nullObligatoriu

Numele resursei în contextul relevant.

Exemplu: "Example"

numberȘir de caractereObligatoriu

Numărul comenzii sau al solicitării, destinat utilizatorilor.

Exemplu: "example"

positionNumăr întregObligatoriu

Poziția în colecția ordonată.

Exemplu: 1

selection_typeȘir de caractereObligatoriu

Modul permis de selectare a valorilor caracteristicilor.

Restricții

enum: ["button", "dropdown"]

Exemplu: "button"

updated_atȘir de caractereObligatoriu

Momentul celei mai recente actualizări.

format: "date-time"

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

value_presentation_typeȘir de caractereObligatoriu

Modul de prezentare a valorilor din dicționar.

Restricții

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

Exemplu: "text"

versionNumăr întregObligatoriu

Versiunea resursei folosită pentru controlul concurenței.

Exemplu: 1

Câmpuri suplimentare: Nu

Obține · Variante de produs — Variante și opțiuni — Răspuns

ProductVariantData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

activeValoare booleanăObligatoriu: Indică dacă resursa este activă.

Exemplu: true
created_atȘir de caractereObligatoriu: Momentul creării.

format: "date-time"

Exemplu: "2026-01-01T12:00:00Z"
idȘir de caractereObligatoriu: Identificatorul resursei; păstrați-l în forma returnată. (ProductVariantData).

Exemplu: "example"
is_defaultValoare booleanăObligatoriu: Indică dacă aceasta este alegerea implicită.

Exemplu: true
media_idsTablou <Șir de caractere> Obligatoriu: Identificatorii fișierelor media deja existente.

Exemplu: ["example"]
positionNumăr întregObligatoriu: Poziția în colecția ordonată.

Exemplu: 1
pricingVariantPricingData Obligatoriu: Configurația prețurilor și versiunile pentru controlul concurenței.

Exemplu: {"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Șir de caractere nullObligatoriu: Identificatorul fișierului media principal.

Exemplu: "example"
product_idȘir de caractereObligatoriu: Identificatorul produsului.

Exemplu: "example"
skuȘir de caractereObligatoriu: Codul unității de stoc.

Exemplu: "example"
updated_atȘir de caractereObligatoriu: Momentul celei mai recente actualizări.

format: "date-time"

Exemplu: "2026-01-01T12:00:00Z"
valuesTablou <VariantChoiceData > Obligatoriu: Valorile dicționarului.

Exemplu: [{"option_id":"example","option_name":"example","value":"example","value_id":"example"}]
versionNumăr întregObligatoriu: Versiunea resursei folosită pentru controlul concurenței.

Exemplu: 1

Câmpuri suplimentare: Nu

Valorile dicționarului

VariantChoiceData · Schemă · Scheme de date: Variante și opțiuni

option_idȘir de caractereObligatoriu: Identificatorul opțiunii de variantă.

Exemplu: "example"
option_nameȘir de caractere nullObligatoriu: Numele opțiunii de variantă.

Exemplu: "example"
valueȘir de caractere nullObligatoriu: Valoarea descrisă de schema în care apare.

Exemplu: "example"
value_idȘir de caractereObligatoriu: Identificatorul valorii din dicționar.

Exemplu: "example"

Câmpuri suplimentare: Nu

Creează · Variante de produs — Variante și opțiuni — Corpul cererii

VariantCreate · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

activeValoare booleanăOpțional

Indică dacă resursa este activă.

Valoare implicită: true

expected_versionNumăr întregObligatoriu

Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 1maximum: 9223372036854775807

Exemplu: 1

is_defaultValoare booleanăOpțional

Indică dacă aceasta este alegerea implicită.

media_idsTablou <Șir de caractere> Opțional

Identificatorii fișierelor media deja existente.

maxItems: 20

Tablou:minLength: 1maxLength: 63

pricingVariantPrice Opțional

Configurația prețurilor și versiunile pentru controlul concurenței.

skuȘir de caractereOpțional

Codul unității de stoc.

minLength: 1maxLength: 100

Restricții

pattern: "^\\S+$"

value_idsTablou <Șir de caractere> Obligatoriu

Identificatorii valorilor din dicționar.

minItems: 1maxItems: 250

Tablou:minLength: 1maxLength: 63

Exemplu: ["example"]

Câmpuri suplimentare: Nu

Creează · Opțiuni — Variante și opțiuni — Corpul cererii

VariantOptionCreate · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

nameȘir de caractereObligatoriu

Numele resursei în contextul relevant.

minLength: 1maxLength: 120

Restricții

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

Exemplu: "Example"

selection_typeȘir de caractereOpțional

Modul permis de selectare a valorilor caracteristicilor.

Restricții

enum: ["button", "dropdown"]

Valoare implicită: "button"

value_presentation_typeȘir de caractereOpțional

Modul de prezentare a valorilor din dicționar.

Restricții

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

Valoare implicită: "text"

Câmpuri suplimentare: Nu

Actualizează · Opțiuni — Variante și opțiuni — Corpul cererii

VariantOptionUpdate · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

expected_versionNumăr întregObligatoriu

Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 1maximum: 9223372036854775807

Exemplu: 1

nameȘir de caractere nullOpțional

Numele resursei în contextul relevant.

Șir de caractere:minLength: 1maxLength: 120

Restricții · Șir de caractere 1

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

Exemplu: "Example"

selection_typeȘir de caractereOpțional

Modul permis de selectare a valorilor caracteristicilor.

Restricții

enum: ["button", "dropdown"]

value_presentation_typeȘir de caractereOpțional

Modul de prezentare a valorilor din dicționar.

Restricții

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

Câmpuri suplimentare: Nu

Configurația prețurilor și versiunile pentru controlul concurenței

VariantPrice · Schemă · Scheme de date: Variante și opțiuni

amountȘir de caractere nullObligatoriu

Sumă zecimală codificată ca șir JSON; null numai unde este permis.

Șir de caractere:maxLength: 20

Restricții · Șir de caractere 1

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

Exemplu: "0.00"

currencyȘir de caractereObligatoriu

Codul monedei în care este exprimată suma.

Restricții

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

Exemplu: "PLN"

expected_price_list_versionNumăr întregObligatoriu

Versiunea listei de prețuri citită anterior, necesară pentru această scriere.

minimum: 1maximum: 9223372036854775807

Exemplu: 1

expected_product_versionNumăr întregObligatoriu

Versiunea produsului citită anterior, necesară pentru această scriere.

minimum: 0maximum: 9223372036854775807

Exemplu: 1

expected_versionNumăr întregObligatoriu

Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 0maximum: 9223372036854775807

Exemplu: 0

kindȘir de caractereObligatoriu

Varianta structurii de date, descrisă prin valorile permise.

Restricții

enum: ["base_adjustment", "market_fixed"]

Exemplu: "base_adjustment"

price_list_idȘir de caractereObligatoriu

Identificatorul listei de prețuri.

minLength: 1maxLength: 63

Exemplu: "example"

Câmpuri suplimentare: Nu

Configurația prețurilor și versiunile pentru controlul concurenței

VariantPricingData · Schemă · Scheme de date: Variante și opțiuni

base_adjustmentMoneyData Obligatoriu: Ajustarea prețului față de prețul de bază.

Exemplu: {"amount":"0.00","currency":"PLN","minor_units":2}
market_priceMoneyData nullObligatoriu: Prețul pentru piața selectată.

Exemplu: null
pricePriceData nullObligatoriu: Informații despre preț în contextul selectat.

Exemplu: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
product_versionNumăr întregObligatoriu: Versiunea curentă a produsului, pentru controlul concurenței.

Exemplu: 1
versionNumăr întregObligatoriu: Versiunea resursei folosită pentru controlul concurenței.

Exemplu: 1

Câmpuri suplimentare: Nu

Actualizează · Variante de produs — Variante și opțiuni — Corpul cererii

VariantUpdate · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

activeValoare booleanăOpțional

Indică dacă resursa este activă.

expected_versionNumăr întregObligatoriu

Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 1maximum: 9223372036854775807

Exemplu: 1

is_defaultValoare booleanăOpțional

Indică dacă aceasta este alegerea implicită.

media_idsTablou <Șir de caractere> Opțional

Identificatorii fișierelor media deja existente.

maxItems: 20

Tablou:minLength: 1maxLength: 63

pricingVariantPrice Opțional

Configurația prețurilor și versiunile pentru controlul concurenței.

Exemplu:

{"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Șir de caractereOpțional

Codul unității de stoc.

minLength: 1maxLength: 100

Restricții

pattern: "^\\S+$"

Exemplu: "example"

Câmpuri suplimentare: Nu

Creează · Valorile opțiunilor — Variante și opțiuni — Corpul cererii

VariantValueCreate · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

color_hexȘir de caractere nullOpțional

Culoare reprezentată printr-un cod hexazecimal.

Restricții · Șir de caractere 1

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

expected_versionNumăr întregObligatoriu

Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 1maximum: 9223372036854775807

Exemplu: 1

valueȘir de caractereObligatoriu

Valoarea descrisă de schema în care apare.

minLength: 1maxLength: 180

Restricții

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

Exemplu: "Example"

Câmpuri suplimentare: Nu

Obține · Valorile opțiunilor — Variante și opțiuni — Răspuns

VariantValueData · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

color_hexȘir de caractere nullObligatoriu: Culoare reprezentată printr-un cod hexazecimal.

Exemplu: "#008855"
created_atȘir de caractereObligatoriu: Momentul creării.

format: "date-time"

Exemplu: "2026-01-01T12:00:00Z"
idȘir de caractereObligatoriu: Identificatorul resursei; păstrați-l în forma returnată. (VariantValueData).

Exemplu: "example"
image_media_idȘir de caractere nullObligatoriu: Identificatorul fișierului de imagine selectat.

Exemplu: null
numberȘir de caractereObligatoriu: Numărul comenzii sau al solicitării, destinat utilizatorilor.

Exemplu: "example"
option_idȘir de caractereObligatoriu: Identificatorul opțiunii de variantă.

Exemplu: "example"
positionNumăr întregObligatoriu: Poziția în colecția ordonată.

Exemplu: 1
sku_codeȘir de caractereObligatoriu: Codul unității de stoc.

Exemplu: "example"
updated_atȘir de caractereObligatoriu: Momentul celei mai recente actualizări.

format: "date-time"

Exemplu: "2026-01-01T12:00:00Z"
valueȘir de caractere nullObligatoriu: Valoarea descrisă de schema în care apare.

Exemplu: "example"
versionNumăr întregObligatoriu: Versiunea resursei folosită pentru controlul concurenței.

Exemplu: 1

Câmpuri suplimentare: Nu

Actualizează · Valorile opțiunilor — Variante și opțiuni — Corpul cererii

VariantValueUpdate · Câmpurile, tipurile și restricțiile datelor acceptate sau returnate de API.

color_hexȘir de caractere nullOpțional

Culoare reprezentată printr-un cod hexazecimal.

Restricții · Șir de caractere 1

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

expected_versionNumăr întregObligatoriu

Versiunea citită înainte de scriere; o neconcordanță respinge actualizarea.

minimum: 1maximum: 9223372036854775807

Exemplu: 1

valueȘir de caractere nullOpțional

Valoarea descrisă de schema în care apare.

Șir de caractere:minLength: 1maxLength: 180

Restricții · Șir de caractere 1

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

Exemplu: "Example"

Câmpuri suplimentare: Nu