Dataskjemaer: Varianter og valg

Dataskjemaer: Varianter og valg. Felter, typer og begrensninger for data som API-et mottar eller returnerer.

Dataskjemaer

Vis liste · Produktvarianter — Varianter og valg — Svar

ApiResponse_list_ProductVariantData__ · Felter, typer og begrensninger for data som API-et mottar 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"}

Ytterligere felt: Nei

Vis liste · Alternativer — Varianter og valg — Svar

ApiResponse_list_VariantOptionData__ · Felter, typer og begrensninger for data som API-et mottar 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"}

Ytterligere felt: Nei

Vis liste · Alternativverdier — Varianter og valg — Svar

ApiResponse_list_VariantValueData__ · Felter, typer og begrensninger for data som API-et mottar 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"}

Ytterligere felt: Nei

Hent · Produktvarianter — Varianter og valg — Svar

ApiResponse_ProductVariantData_ · Felter, typer og begrensninger for data som API-et mottar 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"}

Ytterligere felt: Nei

Hent · Alternativer — Varianter og valg — Svar

ApiResponse_VariantOptionData_ · Felter, typer og begrensninger for data som API-et mottar 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"}

Ytterligere felt: Nei

Hent · Alternativverdier — Varianter og valg — Svar

ApiResponse_VariantValueData_ · Felter, typer og begrensninger for data som API-et mottar 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"}

Ytterligere felt: Nei

Hent · Alternativer — Varianter og valg — Svar

shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

created_atStrengObligatorisk

Opprettelsestidspunkt.

format: "date-time"

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

idStrengObligatorisk

Ressursidentifikator; behold den slik den returneres. (shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData).

Eksempel: "example"

nameStreng nullObligatorisk

Ressursens navn i den relevante konteksten.

Eksempel: "Example"

numberStrengObligatorisk

Ordre- eller saksnummer beregnet på mennesker.

Eksempel: "example"

positionHeltallObligatorisk

Plassering i den sorterte samlingen.

Eksempel: 1

selection_typeStrengObligatorisk

Tillatt valgmodus for egenskapsverdier.

Begrensninger

enum: ["button", "dropdown"]

Eksempel: "button"

updated_atStrengObligatorisk

Tidspunkt for siste oppdatering.

format: "date-time"

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

value_presentation_typeStrengObligatorisk

Hvordan oppslagsverdier presenteres.

Begrensninger

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

Eksempel: "text"

versionHeltallObligatorisk

Ressursversjon brukt til samtidighetskontroll.

Eksempel: 1

Ytterligere felt: Nei

Hent · Produktvarianter — Varianter og valg — Svar

ProductVariantData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

activeBoolsk verdiObligatorisk: Om ressursen er aktiv.

Eksempel: true
created_atStrengObligatorisk: Opprettelsestidspunkt.

format: "date-time"

Eksempel: "2026-01-01T12:00:00Z"
idStrengObligatorisk: Ressursidentifikator; behold den slik den returneres. (ProductVariantData).

Eksempel: "example"
is_defaultBoolsk verdiObligatorisk: Om dette er standardvalget.

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

Eksempel: ["example"]
positionHeltallObligatorisk: Plassering i den sorterte samlingen.

Eksempel: 1
pricingVariantPricingData Obligatorisk: Priskonfigurasjon og versjonene for samtidighetskontroll.

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ærmediet.

Eksempel: "example"
product_idStrengObligatorisk: Produktidentifikator.

Eksempel: "example"
skuStrengObligatorisk: SKU-varekode.

Eksempel: "example"
updated_atStrengObligatorisk: Tidspunkt for siste oppdatering.

format: "date-time"

Eksempel: "2026-01-01T12:00:00Z"
valuesArray <VariantChoiceData > Obligatorisk: Oppslagsverdier.

Eksempel: [{"option_id":"example","option_name":"example","value":"example","value_id":"example"}]
versionHeltallObligatorisk: Ressursversjon brukt til samtidighetskontroll.

Eksempel: 1

Ytterligere felt: Nei

Oppslagsverdier

VariantChoiceData · Skjema · Dataskjemaer: Varianter og valg

option_idStrengObligatorisk: Identifikator for variantvalg.

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

Eksempel: "example"
valueStreng nullObligatorisk: Verdi beskrevet av det omkringliggende skjemaet.

Eksempel: "example"
value_idStrengObligatorisk: Identifikator for en oppslagsverdi.

Eksempel: "example"

Ytterligere felt: Nei

Opprett · Produktvarianter — Varianter og valg — Forespørselsinnhold

VariantCreate · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

activeBoolsk verdiValgfritt

Om ressursen er aktiv.

Standard: true

expected_versionHeltallObligatorisk

Versjon lest før skriveoperasjonen; et avvik avviser oppdateringen.

minimum: 1maximum: 9223372036854775807

Eksempel: 1

is_defaultBoolsk verdiValgfritt

Om dette er standardvalget.

media_idsArray <Streng> Valgfritt

Identifikatorer for medier som allerede finnes.

maxItems: 20

Array:minLength: 1maxLength: 63

pricingVariantPrice Valgfritt

Priskonfigurasjon og versjonene for samtidighetskontroll.

skuStrengValgfritt

SKU-varekode.

minLength: 1maxLength: 100

Begrensninger

pattern: "^\\S+$"

value_idsArray <Streng> Obligatorisk

Identifikatorer for oppslagsverdier.

minItems: 1maxItems: 250

Array:minLength: 1maxLength: 63

Eksempel: ["example"]

Ytterligere felt: Nei

Opprett · Alternativer — Varianter og valg — Forespørselsinnhold

VariantOptionCreate · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

nameStrengObligatorisk

Ressursens navn i den relevante konteksten.

minLength: 1maxLength: 120

Begrensninger

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

Eksempel: "Example"

selection_typeStrengValgfritt

Tillatt valgmodus for egenskapsverdier.

Begrensninger

enum: ["button", "dropdown"]

Standard: "button"

value_presentation_typeStrengValgfritt

Hvordan oppslagsverdier presenteres.

Begrensninger

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

Standard: "text"

Ytterligere felt: Nei

Oppdater · Alternativer — Varianter og valg — Forespørselsinnhold

VariantOptionUpdate · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

expected_versionHeltallObligatorisk

Versjon lest før skriveoperasjonen; et avvik avviser oppdateringen.

minimum: 1maximum: 9223372036854775807

Eksempel: 1

nameStreng nullValgfritt

Ressursens navn i den relevante konteksten.

Streng:minLength: 1maxLength: 120

Begrensninger · Streng 1

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

Eksempel: "Example"

selection_typeStrengValgfritt

Tillatt valgmodus for egenskapsverdier.

Begrensninger

enum: ["button", "dropdown"]

value_presentation_typeStrengValgfritt

Hvordan oppslagsverdier presenteres.

Begrensninger

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

Ytterligere felt: Nei

Priskonfigurasjon og versjonene for samtidighetskontroll

VariantPrice · Skjema · Dataskjemaer: Varianter og valg

amountStreng nullObligatorisk

Desimalbeløp kodet som en JSON-streng; null bare der det er tillatt.

Streng:maxLength: 20

Begrensninger · Streng 1

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

Eksempel: "0.00"

currencyStrengObligatorisk

Valutakode for beløpet.

Begrensninger

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

Eksempel: "PLN"

expected_price_list_versionHeltallObligatorisk

Tidligere lest prislisteversjon som kreves for denne skriveoperasjonen.

minimum: 1maximum: 9223372036854775807

Eksempel: 1

expected_product_versionHeltallObligatorisk

Tidligere lest produktversjon som kreves for denne skriveoperasjonen.

minimum: 0maximum: 9223372036854775807

Eksempel: 1

expected_versionHeltallObligatorisk

Versjon lest før skriveoperasjonen; et avvik avviser oppdateringen.

minimum: 0maximum: 9223372036854775807

Eksempel: 0

kindStrengObligatorisk

Variant av datastrukturen beskrevet av de tillatte verdiene.

Begrensninger

enum: ["base_adjustment", "market_fixed"]

Eksempel: "base_adjustment"

price_list_idStrengObligatorisk

Prislisteidentifikator.

minLength: 1maxLength: 63

Eksempel: "example"

Ytterligere felt: Nei

Priskonfigurasjon og versjonene for samtidighetskontroll

VariantPricingData · Skjema · Dataskjemaer: Varianter og valg

base_adjustmentMoneyData Obligatorisk: Prisjustering i forhold til grunnprisen.

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

Eksempel: null
pricePriceData nullObligatorisk: Prisinformasjon i valgt kontekst.

Eksempel: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
product_versionHeltallObligatorisk: Gjeldende produktversjon for samtidighetskontroll.

Eksempel: 1
versionHeltallObligatorisk: Ressursversjon brukt til samtidighetskontroll.

Eksempel: 1

Ytterligere felt: Nei

Oppdater · Produktvarianter — Varianter og valg — Forespørselsinnhold

VariantUpdate · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

activeBoolsk verdiValgfritt

Om ressursen er aktiv.

expected_versionHeltallObligatorisk

Versjon lest før skriveoperasjonen; et avvik avviser oppdateringen.

minimum: 1maximum: 9223372036854775807

Eksempel: 1

is_defaultBoolsk verdiValgfritt

Om dette er standardvalget.

media_idsArray <Streng> Valgfritt

Identifikatorer for medier som allerede finnes.

maxItems: 20

Array:minLength: 1maxLength: 63

pricingVariantPrice Valgfritt

Priskonfigurasjon og versjonene for samtidighetskontroll.

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"}

skuStrengValgfritt

SKU-varekode.

minLength: 1maxLength: 100

Begrensninger

pattern: "^\\S+$"

Eksempel: "example"

Ytterligere felt: Nei

Opprett · Alternativverdier — Varianter og valg — Forespørselsinnhold

VariantValueCreate · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

color_hexStreng nullValgfritt

Farge representert ved en heksadesimal kode.

Begrensninger · Streng 1

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

expected_versionHeltallObligatorisk

Versjon lest før skriveoperasjonen; et avvik avviser oppdateringen.

minimum: 1maximum: 9223372036854775807

Eksempel: 1

valueStrengObligatorisk

Verdi beskrevet av det omkringliggende skjemaet.

minLength: 1maxLength: 180

Begrensninger

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

Eksempel: "Example"

Ytterligere felt: Nei

Hent · Alternativverdier — Varianter og valg — Svar

VariantValueData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

color_hexStreng nullObligatorisk: Farge representert ved en heksadesimal kode.

Eksempel: "#008855"
created_atStrengObligatorisk: Opprettelsestidspunkt.

format: "date-time"

Eksempel: "2026-01-01T12:00:00Z"
idStrengObligatorisk: Ressursidentifikator; behold den slik den returneres. (VariantValueData).

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

Eksempel: null
numberStrengObligatorisk: Ordre- eller saksnummer beregnet på mennesker.

Eksempel: "example"
option_idStrengObligatorisk: Identifikator for variantvalg.

Eksempel: "example"
positionHeltallObligatorisk: Plassering i den sorterte samlingen.

Eksempel: 1
sku_codeStrengObligatorisk: SKU-varekode.

Eksempel: "example"
updated_atStrengObligatorisk: Tidspunkt for siste oppdatering.

format: "date-time"

Eksempel: "2026-01-01T12:00:00Z"
valueStreng nullObligatorisk: Verdi beskrevet av det omkringliggende skjemaet.

Eksempel: "example"
versionHeltallObligatorisk: Ressursversjon brukt til samtidighetskontroll.

Eksempel: 1

Ytterligere felt: Nei

Oppdater · Alternativverdier — Varianter og valg — Forespørselsinnhold

VariantValueUpdate · Felter, typer og begrensninger for data som API-et mottar eller returnerer.

color_hexStreng nullValgfritt

Farge representert ved en heksadesimal kode.

Begrensninger · Streng 1

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

expected_versionHeltallObligatorisk

Versjon lest før skriveoperasjonen; et avvik avviser oppdateringen.

minimum: 1maximum: 9223372036854775807

Eksempel: 1

valueStreng nullValgfritt

Verdi beskrevet av det omkringliggende skjemaet.

Streng:minLength: 1maxLength: 180

Begrensninger · Streng 1

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

Eksempel: "Example"

Ytterligere felt: Nei