Dataskemaer: Varianter og valgmuligheder

Dataskemaer: Varianter og valgmuligheder. Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

Dataskemaer

Vis liste · Produktvarianter — Varianter og valgmuligheder — Svar

ApiResponse_list_ProductVariantData__ · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

dataArray <ProductVariantData > Obligatorisk: Eksempel på svar · ApiResponse_list_ProductVariantData__.

Eksempel: [{"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 Obligatorisk: Svarmetadata.

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

Yderligere felter: Nej

Vis liste · Valgmuligheder — Varianter og valgmuligheder — Svar

ApiResponse_list_VariantOptionData__ · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

dataArray <shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData > Obligatorisk: Eksempel på svar · ApiResponse_list_VariantOptionData__.

Eksempel: [{"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 Obligatorisk: Svarmetadata.

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

Yderligere felter: Nej

Vis liste · Valgværdier — Varianter og valgmuligheder — Svar

ApiResponse_list_VariantValueData__ · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

dataArray <VariantValueData > Obligatorisk: Eksempel på svar · ApiResponse_list_VariantValueData__.

Eksempel: [{"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 Obligatorisk: Svarmetadata.

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

Yderligere felter: Nej

Hent · Produktvarianter — Varianter og valgmuligheder — Svar

ApiResponse_ProductVariantData_ · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

dataProductVariantData Obligatorisk: Eksempel på svar · ProductVariantData.

Eksempel: {"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 Obligatorisk: Svarmetadata.

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

Yderligere felter: Nej

Hent · Valgmuligheder — Varianter og valgmuligheder — Svar

ApiResponse_VariantOptionData_ · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

datashopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData Obligatorisk: Eksempel på svar · shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData.

Eksempel: {"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 Obligatorisk: Svarmetadata.

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

Yderligere felter: Nej

Hent · Valgværdier — Varianter og valgmuligheder — Svar

ApiResponse_VariantValueData_ · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

dataVariantValueData Obligatorisk: Eksempel på svar · VariantValueData.

Eksempel: {"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 Obligatorisk: Svarmetadata.

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

Yderligere felter: Nej

Hent · Valgmuligheder — Varianter og valgmuligheder — Svar

shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

created_atStrengObligatorisk

Oprettelsestidspunkt.

format: "date-time"

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

idStrengObligatorisk

Ressourceidentifikator; bevar den som returneret. (shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData).

Eksempel: "example"

nameStreng nullObligatorisk

Ressourcens navn i den relevante kontekst.

Eksempel: "Example"

numberStrengObligatorisk

Ordre- eller sagsnummer beregnet til mennesker.

Eksempel: "example"

positionHeltalObligatorisk

Placering i den sorterede samling.

Eksempel: 1

selection_typeStrengObligatorisk

Tilladt valgtilstand for egenskabsværdier.

Begrænsninger

enum: ["button", "dropdown"]

Eksempel: "button"

updated_atStrengObligatorisk

Tidspunkt for seneste opdatering.

format: "date-time"

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

value_presentation_typeStrengObligatorisk

Hvordan opslagsværdier vises.

Begrænsninger

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

Eksempel: "text"

versionHeltalObligatorisk

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1

Yderligere felter: Nej

Hent · Produktvarianter — Varianter og valgmuligheder — Svar

ProductVariantData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

activeBoolesk værdiObligatorisk: Om ressourcen er aktiv.

Eksempel: true
created_atStrengObligatorisk: Oprettelsestidspunkt.

format: "date-time"

Eksempel: "2026-01-01T12:00:00Z"
idStrengObligatorisk: Ressourceidentifikator; bevar den som returneret. (ProductVariantData).

Eksempel: "example"
is_defaultBoolesk værdiObligatorisk: Om dette er standardvalget.

Eksempel: true
media_idsArray <Streng> Obligatorisk: Identifikatorer for allerede eksisterende medier.

Eksempel: ["example"]
positionHeltalObligatorisk: Placering i den sorterede samling.

Eksempel: 1
pricingVariantPricingData Obligatorisk: Priskonfiguration og dens versioner til samtidighedskontrol.

Eksempel: {"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_idStreng nullObligatorisk: Identifikator for primært medie.

Eksempel: "example"
product_idStrengObligatorisk: Produktidentifikator.

Eksempel: "example"
skuStrengObligatorisk: SKU-varekode.

Eksempel: "example"
updated_atStrengObligatorisk: Tidspunkt for seneste opdatering.

format: "date-time"

Eksempel: "2026-01-01T12:00:00Z"
valuesArray <VariantChoiceData > Obligatorisk: Opslagsværdier.

Eksempel: [{"option_id":"example","option_name":"example","value":"example","value_id":"example"}]
versionHeltalObligatorisk: Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1

Yderligere felter: Nej

Opslagsværdier

VariantChoiceData · Skema · Dataskemaer: Varianter og valgmuligheder

option_idStrengObligatorisk: Identifikator for variantvalg.

Eksempel: "example"
option_nameStreng nullObligatorisk: Navn på variantvalg.

Eksempel: "example"
valueStreng nullObligatorisk: Værdi beskrevet af det omgivende skema.

Eksempel: "example"
value_idStrengObligatorisk: Identifikator for en opslagsværdi.

Eksempel: "example"

Yderligere felter: Nej

Opret · Produktvarianter — Varianter og valgmuligheder — Forespørgselsindhold

VariantCreate · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

activeBoolesk værdiValgfrit

Om ressourcen er aktiv.

Standard: true

expected_versionHeltalObligatorisk

Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 1maximum: 9223372036854775807

Eksempel: 1

is_defaultBoolesk værdiValgfrit

Om dette er standardvalget.

media_idsArray <Streng> Valgfrit

Identifikatorer for allerede eksisterende medier.

maxItems: 20

Array:minLength: 1maxLength: 63

pricingVariantPrice Valgfrit

Priskonfiguration og dens versioner til samtidighedskontrol.

skuStrengValgfrit

SKU-varekode.

minLength: 1maxLength: 100

Begrænsninger

pattern: "^\\S+$"

value_idsArray <Streng> Obligatorisk

Identifikatorer for opslagsværdier.

minItems: 1maxItems: 250

Array:minLength: 1maxLength: 63

Eksempel: ["example"]

Yderligere felter: Nej

Opret · Valgmuligheder — Varianter og valgmuligheder — Forespørgselsindhold

VariantOptionCreate · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

nameStrengObligatorisk

Ressourcens navn i den relevante kontekst.

minLength: 1maxLength: 120

Begrænsninger

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

Eksempel: "Example"

selection_typeStrengValgfrit

Tilladt valgtilstand for egenskabsværdier.

Begrænsninger

enum: ["button", "dropdown"]

Standard: "button"

value_presentation_typeStrengValgfrit

Hvordan opslagsværdier vises.

Begrænsninger

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

Standard: "text"

Yderligere felter: Nej

Opdater · Valgmuligheder — Varianter og valgmuligheder — Forespørgselsindhold

VariantOptionUpdate · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

expected_versionHeltalObligatorisk

Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 1maximum: 9223372036854775807

Eksempel: 1

nameStreng nullValgfrit

Ressourcens navn i den relevante kontekst.

Streng:minLength: 1maxLength: 120

Begrænsninger · Streng 1

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

Eksempel: "Example"

selection_typeStrengValgfrit

Tilladt valgtilstand for egenskabsværdier.

Begrænsninger

enum: ["button", "dropdown"]

value_presentation_typeStrengValgfrit

Hvordan opslagsværdier vises.

Begrænsninger

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

Yderligere felter: Nej

Priskonfiguration og dens versioner til samtidighedskontrol

VariantPrice · Skema · Dataskemaer: Varianter og valgmuligheder

amountStreng nullObligatorisk

Decimalbeløb kodet som en JSON-streng; null kun hvor tilladt.

Streng:maxLength: 20

Begrænsninger · Streng 1

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

Eksempel: "0.00"

currencyStrengObligatorisk

Valutakode for beløbet.

Begrænsninger

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

Eksempel: "PLN"

expected_price_list_versionHeltalObligatorisk

Tidligere læst prislisteversion, som kræves til denne skriveoperation.

minimum: 1maximum: 9223372036854775807

Eksempel: 1

expected_product_versionHeltalObligatorisk

Tidligere læst produktversion, som kræves til denne skriveoperation.

minimum: 0maximum: 9223372036854775807

Eksempel: 1

expected_versionHeltalObligatorisk

Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 0maximum: 9223372036854775807

Eksempel: 0

kindStrengObligatorisk

Variant af datastrukturen beskrevet ved de tilladte værdier.

Begrænsninger

enum: ["base_adjustment", "market_fixed"]

Eksempel: "base_adjustment"

price_list_idStrengObligatorisk

Prislisteidentifikator.

minLength: 1maxLength: 63

Eksempel: "example"

Yderligere felter: Nej

Priskonfiguration og dens versioner til samtidighedskontrol

VariantPricingData · Skema · Dataskemaer: Varianter og valgmuligheder

base_adjustmentMoneyData Obligatorisk: Prisjustering i forhold til basisprisen.

Eksempel: {"amount":"0.00","currency":"PLN","minor_units":2}
market_priceMoneyData nullObligatorisk: Pris for det valgte marked.

Eksempel: null
pricePriceData nullObligatorisk: Prisoplysninger i den valgte kontekst.

Eksempel: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
product_versionHeltalObligatorisk: Aktuel produktversion til samtidighedskontrol.

Eksempel: 1
versionHeltalObligatorisk: Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1

Yderligere felter: Nej

Opdater · Produktvarianter — Varianter og valgmuligheder — Forespørgselsindhold

VariantUpdate · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

activeBoolesk værdiValgfrit

Om ressourcen er aktiv.

expected_versionHeltalObligatorisk

Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 1maximum: 9223372036854775807

Eksempel: 1

is_defaultBoolesk værdiValgfrit

Om dette er standardvalget.

media_idsArray <Streng> Valgfrit

Identifikatorer for allerede eksisterende medier.

maxItems: 20

Array:minLength: 1maxLength: 63

pricingVariantPrice Valgfrit

Priskonfiguration og dens versioner til samtidighedskontrol.

Eksempel:

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

skuStrengValgfrit

SKU-varekode.

minLength: 1maxLength: 100

Begrænsninger

pattern: "^\\S+$"

Eksempel: "example"

Yderligere felter: Nej

Opret · Valgværdier — Varianter og valgmuligheder — Forespørgselsindhold

VariantValueCreate · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

color_hexStreng nullValgfrit

Farve repræsenteret ved en hexadecimal kode.

Begrænsninger · Streng 1

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

expected_versionHeltalObligatorisk

Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 1maximum: 9223372036854775807

Eksempel: 1

valueStrengObligatorisk

Værdi beskrevet af det omgivende skema.

minLength: 1maxLength: 180

Begrænsninger

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

Eksempel: "Example"

Yderligere felter: Nej

Hent · Valgværdier — Varianter og valgmuligheder — Svar

VariantValueData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

color_hexStreng nullObligatorisk: Farve repræsenteret ved en hexadecimal kode.

Eksempel: "#008855"
created_atStrengObligatorisk: Oprettelsestidspunkt.

format: "date-time"

Eksempel: "2026-01-01T12:00:00Z"
idStrengObligatorisk: Ressourceidentifikator; bevar den som returneret. (VariantValueData).

Eksempel: "example"
image_media_idStreng nullObligatorisk: Identifikator for det valgte billedmedie.

Eksempel: null
numberStrengObligatorisk: Ordre- eller sagsnummer beregnet til mennesker.

Eksempel: "example"
option_idStrengObligatorisk: Identifikator for variantvalg.

Eksempel: "example"
positionHeltalObligatorisk: Placering i den sorterede samling.

Eksempel: 1
sku_codeStrengObligatorisk: SKU-varekode.

Eksempel: "example"
updated_atStrengObligatorisk: Tidspunkt for seneste opdatering.

format: "date-time"

Eksempel: "2026-01-01T12:00:00Z"
valueStreng nullObligatorisk: Værdi beskrevet af det omgivende skema.

Eksempel: "example"
versionHeltalObligatorisk: Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1

Yderligere felter: Nej

Opdater · Valgværdier — Varianter og valgmuligheder — Forespørgselsindhold

VariantValueUpdate · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

color_hexStreng nullValgfrit

Farve repræsenteret ved en hexadecimal kode.

Begrænsninger · Streng 1

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

expected_versionHeltalObligatorisk

Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

minimum: 1maximum: 9223372036854775807

Eksempel: 1

valueStreng nullValgfrit

Værdi beskrevet af det omgivende skema.

Streng:minLength: 1maxLength: 180

Begrænsninger · Streng 1

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

Eksempel: "Example"

Yderligere felter: Nej