Skemi tad-data: Varjanti u għażliet

Skemi tad-data: Varjanti u għażliet. L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

Skemi tad-data

Elenka · Varjanti tal-prodott — Varjanti u għażliet — Risposta

ApiResponse_list_ProductVariantData__ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

dataArray <ProductVariantData > Obbligatorju: Eżempju ta’ tweġiba · ApiResponse_list_ProductVariantData__.

Eżempju: [{"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 Obbligatorju: Metadata tat-tweġiba.

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

Oqsma addizzjonali: Le

Elenka · Għażliet — Varjanti u għażliet — Risposta

ApiResponse_list_VariantOptionData__ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

dataArray <shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData > Obbligatorju: Eżempju ta’ tweġiba · ApiResponse_list_VariantOptionData__.

Eżempju: [{"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 Obbligatorju: Metadata tat-tweġiba.

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

Oqsma addizzjonali: Le

Elenka · Valuri tal-għażliet — Varjanti u għażliet — Risposta

ApiResponse_list_VariantValueData__ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

dataArray <VariantValueData > Obbligatorju: Eżempju ta’ tweġiba · ApiResponse_list_VariantValueData__.

Eżempju: [{"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 Obbligatorju: Metadata tat-tweġiba.

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

Oqsma addizzjonali: Le

Ikseb · Varjanti tal-prodott — Varjanti u għażliet — Risposta

ApiResponse_ProductVariantData_ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

dataProductVariantData Obbligatorju: Eżempju ta’ tweġiba · ProductVariantData.

Eżempju: {"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 Obbligatorju: Metadata tat-tweġiba.

Eżempju: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Oqsma addizzjonali: Le

Ikseb · Għażliet — Varjanti u għażliet — Risposta

ApiResponse_VariantOptionData_ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

datashopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData Obbligatorju: Eżempju ta’ tweġiba · shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData.

Eżempju: {"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 Obbligatorju: Metadata tat-tweġiba.

Eżempju: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Oqsma addizzjonali: Le

Ikseb · Valuri tal-għażliet — Varjanti u għażliet — Risposta

ApiResponse_VariantValueData_ · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

dataVariantValueData Obbligatorju: Eżempju ta’ tweġiba · VariantValueData.

Eżempju: {"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 Obbligatorju: Metadata tat-tweġiba.

Eżempju: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Oqsma addizzjonali: Le

Ikseb · Għażliet — Varjanti u għażliet — Risposta

shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

created_atStringObbligatorju

Ħin tal-ħolqien.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"

idStringObbligatorju

Identifikatur tar-riżorsa; żommu kif mogħti. (shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData).

Eżempju: "example"

nameString nullObbligatorju

Isem tar-riżorsa fil-kuntest rilevanti.

Eżempju: "Example"

numberStringObbligatorju

Numru tal-ordni jew tat-talba muri lill-bniedem.

Eżempju: "example"

positionNumru sħiħObbligatorju

Pożizzjoni fil-kollezzjoni ordnata.

Eżempju: 1

selection_typeStringObbligatorju

Mod permess għall-għażla tal-valuri tal-karatteristiċi.

Restrizzjonijiet

enum: ["button", "dropdown"]

Eżempju: "button"

updated_atStringObbligatorju

Ħin tal-aktar aġġornament reċenti.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"

value_presentation_typeStringObbligatorju

Kif jintwerew il-valuri tad-dizzjunarju.

Restrizzjonijiet

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

Eżempju: "text"

versionNumru sħiħObbligatorju

Verżjoni tar-riżorsa għall-kontroll tal-konkorrenza.

Eżempju: 1

Oqsma addizzjonali: Le

Ikseb · Varjanti tal-prodott — Varjanti u għażliet — Risposta

ProductVariantData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

activeBooleanObbligatorju: Jekk ir-riżorsa hijiex attiva.

Eżempju: true
created_atStringObbligatorju: Ħin tal-ħolqien.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"
idStringObbligatorju: Identifikatur tar-riżorsa; żommu kif mogħti. (ProductVariantData).

Eżempju: "example"
is_defaultBooleanObbligatorju: Jekk din hijiex l-għażla predefinita.

Eżempju: true
media_idsArray <String> Obbligatorju: Identifikaturi ta’ assi tal-midja li diġà jeżistu.

Eżempju: ["example"]
positionNumru sħiħObbligatorju: Pożizzjoni fil-kollezzjoni ordnata.

Eżempju: 1
pricingVariantPricingData Obbligatorju: Konfigurazzjoni tal-prezzijiet u l-verżjonijiet tal-konkorrenza tagħha.

Eżempju: {"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_idString nullObbligatorju: Identifikatur tal-assi ewlieni tal-midja.

Eżempju: "example"
product_idStringObbligatorju: Identifikatur tal-prodott.

Eżempju: "example"
skuStringObbligatorju: Kodiċi tal-unità ta’ ġestjoni tal-istokk.

Eżempju: "example"
updated_atStringObbligatorju: Ħin tal-aktar aġġornament reċenti.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"
valuesArray <VariantChoiceData > Obbligatorju: Valuri tad-dizzjunarju.

Eżempju: [{"option_id":"example","option_name":"example","value":"example","value_id":"example"}]
versionNumru sħiħObbligatorju: Verżjoni tar-riżorsa għall-kontroll tal-konkorrenza.

Eżempju: 1

Oqsma addizzjonali: Le

Valuri tad-dizzjunarju

VariantChoiceData · Skema · Skemi tad-data: Varjanti u għażliet

option_idStringObbligatorju: Identifikatur tal-għażla tal-varjant.

Eżempju: "example"
option_nameString nullObbligatorju: Isem tal-għażla tal-varjant.

Eżempju: "example"
valueString nullObbligatorju: Valur deskritt mill-iskema ta’ madwaru.

Eżempju: "example"
value_idStringObbligatorju: Identifikatur ta’ valur tad-dizzjunarju.

Eżempju: "example"

Oqsma addizzjonali: Le

Oħloq · Varjanti tal-prodott — Varjanti u għażliet — Kontenut tat-talba

VariantCreate · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

activeBooleanMhux obbligatorju

Jekk ir-riżorsa hijiex attiva.

Valur predefinit: true

expected_versionNumru sħiħObbligatorju

Verżjoni li nqrat qabel il-kitba; nuqqas ta’ qbil jirrifjuta l-aġġornament.

minimum: 1maximum: 9223372036854775807

Eżempju: 1

is_defaultBooleanMhux obbligatorju

Jekk din hijiex l-għażla predefinita.

media_idsArray <String> Mhux obbligatorju

Identifikaturi ta’ assi tal-midja li diġà jeżistu.

maxItems: 20

Array:minLength: 1maxLength: 63

pricingVariantPrice Mhux obbligatorju

Konfigurazzjoni tal-prezzijiet u l-verżjonijiet tal-konkorrenza tagħha.

skuStringMhux obbligatorju

Kodiċi tal-unità ta’ ġestjoni tal-istokk.

minLength: 1maxLength: 100

Restrizzjonijiet

pattern: "^\\S+$"

value_idsArray <String> Obbligatorju

Identifikaturi tal-valuri tad-dizzjunarju.

minItems: 1maxItems: 250

Array:minLength: 1maxLength: 63

Eżempju: ["example"]

Oqsma addizzjonali: Le

Oħloq · Għażliet — Varjanti u għażliet — Kontenut tat-talba

VariantOptionCreate · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

nameStringObbligatorju

Isem tar-riżorsa fil-kuntest rilevanti.

minLength: 1maxLength: 120

Restrizzjonijiet

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

Eżempju: "Example"

selection_typeStringMhux obbligatorju

Mod permess għall-għażla tal-valuri tal-karatteristiċi.

Restrizzjonijiet

enum: ["button", "dropdown"]

Valur predefinit: "button"

value_presentation_typeStringMhux obbligatorju

Kif jintwerew il-valuri tad-dizzjunarju.

Restrizzjonijiet

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

Valur predefinit: "text"

Oqsma addizzjonali: Le

Aġġorna · Għażliet — Varjanti u għażliet — Kontenut tat-talba

VariantOptionUpdate · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

expected_versionNumru sħiħObbligatorju

Verżjoni li nqrat qabel il-kitba; nuqqas ta’ qbil jirrifjuta l-aġġornament.

minimum: 1maximum: 9223372036854775807

Eżempju: 1

nameString nullMhux obbligatorju

Isem tar-riżorsa fil-kuntest rilevanti.

String:minLength: 1maxLength: 120

Restrizzjonijiet · String 1

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

Eżempju: "Example"

selection_typeStringMhux obbligatorju

Mod permess għall-għażla tal-valuri tal-karatteristiċi.

Restrizzjonijiet

enum: ["button", "dropdown"]

value_presentation_typeStringMhux obbligatorju

Kif jintwerew il-valuri tad-dizzjunarju.

Restrizzjonijiet

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

Oqsma addizzjonali: Le

Konfigurazzjoni tal-prezzijiet u l-verżjonijiet tal-konkorrenza tagħha

VariantPrice · Skema · Skemi tad-data: Varjanti u għażliet

amountString nullObbligatorju

Ammont deċimali kkodifikat bħala string JSON; null biss fejn permess.

String:maxLength: 20

Restrizzjonijiet · String 1

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

Eżempju: "0.00"

currencyStringObbligatorju

Kodiċi tal-munita tal-ammont.

Restrizzjonijiet

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

Eżempju: "PLN"

expected_price_list_versionNumru sħiħObbligatorju

Verżjoni tal-lista tal-prezzijiet li nqrat qabel u hija meħtieġa għal din il-kitba.

minimum: 1maximum: 9223372036854775807

Eżempju: 1

expected_product_versionNumru sħiħObbligatorju

Verżjoni tal-prodott li nqrat qabel u hija meħtieġa għal din il-kitba.

minimum: 0maximum: 9223372036854775807

Eżempju: 1

expected_versionNumru sħiħObbligatorju

Verżjoni li nqrat qabel il-kitba; nuqqas ta’ qbil jirrifjuta l-aġġornament.

minimum: 0maximum: 9223372036854775807

Eżempju: 0

kindStringObbligatorju

Varjant tal-istruttura tad-data deskritt mill-valuri permessi tiegħu.

Restrizzjonijiet

enum: ["base_adjustment", "market_fixed"]

Eżempju: "base_adjustment"

price_list_idStringObbligatorju

Identifikatur tal-lista tal-prezzijiet.

minLength: 1maxLength: 63

Eżempju: "example"

Oqsma addizzjonali: Le

Konfigurazzjoni tal-prezzijiet u l-verżjonijiet tal-konkorrenza tagħha

VariantPricingData · Skema · Skemi tad-data: Varjanti u għażliet

base_adjustmentMoneyData Obbligatorju: Aġġustament relattiv għall-prezz bażi.

Eżempju: {"amount":"0.00","currency":"PLN","minor_units":2}
market_priceMoneyData nullObbligatorju: Prezz għas-suq magħżul.

Eżempju: null
pricePriceData nullObbligatorju: Informazzjoni tal-prezz fil-kuntest magħżul.

Eżempju: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
product_versionNumru sħiħObbligatorju: Verżjoni attwali tal-prodott għall-kontroll tal-konkorrenza.

Eżempju: 1
versionNumru sħiħObbligatorju: Verżjoni tar-riżorsa għall-kontroll tal-konkorrenza.

Eżempju: 1

Oqsma addizzjonali: Le

Aġġorna · Varjanti tal-prodott — Varjanti u għażliet — Kontenut tat-talba

VariantUpdate · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

activeBooleanMhux obbligatorju

Jekk ir-riżorsa hijiex attiva.

expected_versionNumru sħiħObbligatorju

Verżjoni li nqrat qabel il-kitba; nuqqas ta’ qbil jirrifjuta l-aġġornament.

minimum: 1maximum: 9223372036854775807

Eżempju: 1

is_defaultBooleanMhux obbligatorju

Jekk din hijiex l-għażla predefinita.

media_idsArray <String> Mhux obbligatorju

Identifikaturi ta’ assi tal-midja li diġà jeżistu.

maxItems: 20

Array:minLength: 1maxLength: 63

pricingVariantPrice Mhux obbligatorju

Konfigurazzjoni tal-prezzijiet u l-verżjonijiet tal-konkorrenza tagħha.

Eżempju:

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

skuStringMhux obbligatorju

Kodiċi tal-unità ta’ ġestjoni tal-istokk.

minLength: 1maxLength: 100

Restrizzjonijiet

pattern: "^\\S+$"

Eżempju: "example"

Oqsma addizzjonali: Le

Oħloq · Valuri tal-għażliet — Varjanti u għażliet — Kontenut tat-talba

VariantValueCreate · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

color_hexString nullMhux obbligatorju

Kulur rappreżentat b’kodiċi eżadeċimali.

Restrizzjonijiet · String 1

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

expected_versionNumru sħiħObbligatorju

Verżjoni li nqrat qabel il-kitba; nuqqas ta’ qbil jirrifjuta l-aġġornament.

minimum: 1maximum: 9223372036854775807

Eżempju: 1

valueStringObbligatorju

Valur deskritt mill-iskema ta’ madwaru.

minLength: 1maxLength: 180

Restrizzjonijiet

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

Eżempju: "Example"

Oqsma addizzjonali: Le

Ikseb · Valuri tal-għażliet — Varjanti u għażliet — Risposta

VariantValueData · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

color_hexString nullObbligatorju: Kulur rappreżentat b’kodiċi eżadeċimali.

Eżempju: "#008855"
created_atStringObbligatorju: Ħin tal-ħolqien.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"
idStringObbligatorju: Identifikatur tar-riżorsa; żommu kif mogħti. (VariantValueData).

Eżempju: "example"
image_media_idString nullObbligatorju: Identifikatur tal-assi tal-istampa magħżula.

Eżempju: null
numberStringObbligatorju: Numru tal-ordni jew tat-talba muri lill-bniedem.

Eżempju: "example"
option_idStringObbligatorju: Identifikatur tal-għażla tal-varjant.

Eżempju: "example"
positionNumru sħiħObbligatorju: Pożizzjoni fil-kollezzjoni ordnata.

Eżempju: 1
sku_codeStringObbligatorju: Kodiċi tal-unità ta’ ġestjoni tal-istokk.

Eżempju: "example"
updated_atStringObbligatorju: Ħin tal-aktar aġġornament reċenti.

format: "date-time"

Eżempju: "2026-01-01T12:00:00Z"
valueString nullObbligatorju: Valur deskritt mill-iskema ta’ madwaru.

Eżempju: "example"
versionNumru sħiħObbligatorju: Verżjoni tar-riżorsa għall-kontroll tal-konkorrenza.

Eżempju: 1

Oqsma addizzjonali: Le

Aġġorna · Valuri tal-għażliet — Varjanti u għażliet — Kontenut tat-talba

VariantValueUpdate · L-oqsma, it-tipi u r-restrizzjonijiet tad-data li l-API taċċetta jew tirritorna.

color_hexString nullMhux obbligatorju

Kulur rappreżentat b’kodiċi eżadeċimali.

Restrizzjonijiet · String 1

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

expected_versionNumru sħiħObbligatorju

Verżjoni li nqrat qabel il-kitba; nuqqas ta’ qbil jirrifjuta l-aġġornament.

minimum: 1maximum: 9223372036854775807

Eżempju: 1

valueString nullMhux obbligatorju

Valur deskritt mill-iskema ta’ madwaru.

String:minLength: 1maxLength: 180

Restrizzjonijiet · String 1

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

Eżempju: "Example"

Oqsma addizzjonali: Le