Gegevensschema’s: Varianten en opties

Gegevensschema’s: Varianten en opties. Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

Gegevensschema’s

Lijst ophalen · Productvarianten — Varianten en opties — Antwoord

ApiResponse_list_ProductVariantData__ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

dataArray <ProductVariantData > Verplicht: Voorbeeldantwoord · ApiResponse_list_ProductVariantData__.

Voorbeeld: [{"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 Verplicht: Metadata van het antwoord.

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

Aanvullende velden: Nee

Lijst ophalen · Opties — Varianten en opties — Antwoord

ApiResponse_list_VariantOptionData__ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

dataArray <shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData > Verplicht: Voorbeeldantwoord · ApiResponse_list_VariantOptionData__.

Voorbeeld: [{"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 Verplicht: Metadata van het antwoord.

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

Aanvullende velden: Nee

Lijst ophalen · Optiewaarden — Varianten en opties — Antwoord

ApiResponse_list_VariantValueData__ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

dataArray <VariantValueData > Verplicht: Voorbeeldantwoord · ApiResponse_list_VariantValueData__.

Voorbeeld: [{"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 Verplicht: Metadata van het antwoord.

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

Aanvullende velden: Nee

Ophalen · Productvarianten — Varianten en opties — Antwoord

ApiResponse_ProductVariantData_ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

dataProductVariantData Verplicht: Voorbeeldantwoord · ProductVariantData.

Voorbeeld: {"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 Verplicht: Metadata van het antwoord.

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

Aanvullende velden: Nee

Ophalen · Opties — Varianten en opties — Antwoord

ApiResponse_VariantOptionData_ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

datashopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData Verplicht: Voorbeeldantwoord · shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData.

Voorbeeld: {"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 Verplicht: Metadata van het antwoord.

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

Aanvullende velden: Nee

Ophalen · Optiewaarden — Varianten en opties — Antwoord

ApiResponse_VariantValueData_ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

dataVariantValueData Verplicht: Voorbeeldantwoord · VariantValueData.

Voorbeeld: {"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 Verplicht: Metadata van het antwoord.

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

Aanvullende velden: Nee

Ophalen · Opties — Varianten en opties — Antwoord

shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

created_atTekenreeksVerplicht

Tijdstip van aanmaak.

format: "date-time"

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

idTekenreeksVerplicht

Resource-identificatie; bewaar deze zoals teruggegeven. (shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData).

Voorbeeld: "example"

nameTekenreeks nullVerplicht

Resourcenaam in de betreffende context.

Voorbeeld: "Example"

numberTekenreeksVerplicht

Bestel- of aanvraagnummer voor menselijk gebruik.

Voorbeeld: "example"

positionGeheel getalVerplicht

Positie in de geordende verzameling.

Voorbeeld: 1

selection_typeTekenreeksVerplicht

Toegestane selectiemodus voor kenmerkwaarden.

Beperkingen

enum: ["button", "dropdown"]

Voorbeeld: "button"

updated_atTekenreeksVerplicht

Tijdstip van de meest recente wijziging.

format: "date-time"

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

value_presentation_typeTekenreeksVerplicht

Presentatiewijze van woordenboekwaarden.

Beperkingen

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

Voorbeeld: "text"

versionGeheel getalVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1

Aanvullende velden: Nee

Ophalen · Productvarianten — Varianten en opties — Antwoord

ProductVariantData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

activeBooleaanse waardeVerplicht: Of de resource actief is.

Voorbeeld: true
created_atTekenreeksVerplicht: Tijdstip van aanmaak.

format: "date-time"

Voorbeeld: "2026-01-01T12:00:00Z"
idTekenreeksVerplicht: Resource-identificatie; bewaar deze zoals teruggegeven. (ProductVariantData).

Voorbeeld: "example"
is_defaultBooleaanse waardeVerplicht: Of dit de standaardkeuze is.

Voorbeeld: true
media_idsArray <Tekenreeks> Verplicht: Identificaties van bestaande mediabestanden.

Voorbeeld: ["example"]
positionGeheel getalVerplicht: Positie in de geordende verzameling.

Voorbeeld: 1
pricingVariantPricingData Verplicht: Prijsconfiguratie en versies voor gelijktijdige wijzigingen.

Voorbeeld: {"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_idTekenreeks nullVerplicht: Identificatie van het primaire mediabestand.

Voorbeeld: "example"
product_idTekenreeksVerplicht: Productidentificatie.

Voorbeeld: "example"
skuTekenreeksVerplicht: Voorraadartikelcode (SKU).

Voorbeeld: "example"
updated_atTekenreeksVerplicht: Tijdstip van de meest recente wijziging.

format: "date-time"

Voorbeeld: "2026-01-01T12:00:00Z"
valuesArray <VariantChoiceData > Verplicht: Woordenboekwaarden.

Voorbeeld: [{"option_id":"example","option_name":"example","value":"example","value_id":"example"}]
versionGeheel getalVerplicht: Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1

Aanvullende velden: Nee

Woordenboekwaarden

VariantChoiceData · Schema · Gegevensschema’s: Varianten en opties

option_idTekenreeksVerplicht: Identificatie van de variantoptie.

Voorbeeld: "example"
option_nameTekenreeks nullVerplicht: Naam van de variantoptie.

Voorbeeld: "example"
valueTekenreeks nullVerplicht: Waarde zoals beschreven door het omringende schema.

Voorbeeld: "example"
value_idTekenreeksVerplicht: Identificatie van een woordenboekwaarde.

Voorbeeld: "example"

Aanvullende velden: Nee

Aanmaken · Productvarianten — Varianten en opties — Verzoekinhoud

VariantCreate · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

activeBooleaanse waardeOptioneel

Of de resource actief is.

Standaard: true

expected_versionGeheel getalVerplicht

Versie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.

minimum: 1maximum: 9223372036854775807

Voorbeeld: 1

is_defaultBooleaanse waardeOptioneel

Of dit de standaardkeuze is.

media_idsArray <Tekenreeks> Optioneel

Identificaties van bestaande mediabestanden.

maxItems: 20

Array:minLength: 1maxLength: 63

pricingVariantPrice Optioneel

Prijsconfiguratie en versies voor gelijktijdige wijzigingen.

skuTekenreeksOptioneel

Voorraadartikelcode (SKU).

minLength: 1maxLength: 100

Beperkingen

pattern: "^\\S+$"

value_idsArray <Tekenreeks> Verplicht

Identificaties van woordenboekwaarden.

minItems: 1maxItems: 250

Array:minLength: 1maxLength: 63

Voorbeeld: ["example"]

Aanvullende velden: Nee

Aanmaken · Opties — Varianten en opties — Verzoekinhoud

VariantOptionCreate · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

nameTekenreeksVerplicht

Resourcenaam in de betreffende context.

minLength: 1maxLength: 120

Beperkingen

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

Voorbeeld: "Example"

selection_typeTekenreeksOptioneel

Toegestane selectiemodus voor kenmerkwaarden.

Beperkingen

enum: ["button", "dropdown"]

Standaard: "button"

value_presentation_typeTekenreeksOptioneel

Presentatiewijze van woordenboekwaarden.

Beperkingen

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

Standaard: "text"

Aanvullende velden: Nee

Bijwerken · Opties — Varianten en opties — Verzoekinhoud

VariantOptionUpdate · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

expected_versionGeheel getalVerplicht

Versie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.

minimum: 1maximum: 9223372036854775807

Voorbeeld: 1

nameTekenreeks nullOptioneel

Resourcenaam in de betreffende context.

Tekenreeks:minLength: 1maxLength: 120

Beperkingen · Tekenreeks 1

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

Voorbeeld: "Example"

selection_typeTekenreeksOptioneel

Toegestane selectiemodus voor kenmerkwaarden.

Beperkingen

enum: ["button", "dropdown"]

value_presentation_typeTekenreeksOptioneel

Presentatiewijze van woordenboekwaarden.

Beperkingen

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

Aanvullende velden: Nee

Prijsconfiguratie en versies voor gelijktijdige wijzigingen

VariantPrice · Schema · Gegevensschema’s: Varianten en opties

amountTekenreeks nullVerplicht

Decimaal bedrag als JSON-tekenreeks; null uitsluitend waar toegestaan.

Tekenreeks:maxLength: 20

Beperkingen · Tekenreeks 1

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

Voorbeeld: "0.00"

currencyTekenreeksVerplicht

Valutacode voor het bedrag.

Beperkingen

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

Voorbeeld: "PLN"

expected_price_list_versionGeheel getalVerplicht

Eerder gelezen prijslijstversie die voor deze schrijfbewerking vereist is.

minimum: 1maximum: 9223372036854775807

Voorbeeld: 1

expected_product_versionGeheel getalVerplicht

Eerder gelezen productversie die voor deze schrijfbewerking vereist is.

minimum: 0maximum: 9223372036854775807

Voorbeeld: 1

expected_versionGeheel getalVerplicht

Versie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.

minimum: 0maximum: 9223372036854775807

Voorbeeld: 0

kindTekenreeksVerplicht

Variant van de gegevensstructuur, zoals beschreven door de toegestane waarden.

Beperkingen

enum: ["base_adjustment", "market_fixed"]

Voorbeeld: "base_adjustment"

price_list_idTekenreeksVerplicht

Prijslijstidentificatie.

minLength: 1maxLength: 63

Voorbeeld: "example"

Aanvullende velden: Nee

Prijsconfiguratie en versies voor gelijktijdige wijzigingen

VariantPricingData · Schema · Gegevensschema’s: Varianten en opties

base_adjustmentMoneyData Verplicht: Prijsaanpassing ten opzichte van de basisprijs.

Voorbeeld: {"amount":"0.00","currency":"PLN","minor_units":2}
market_priceMoneyData nullVerplicht: Prijs voor de geselecteerde markt.

Voorbeeld: null
pricePriceData nullVerplicht: Prijsgegevens in de geselecteerde context.

Voorbeeld: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
product_versionGeheel getalVerplicht: Huidige productversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1
versionGeheel getalVerplicht: Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1

Aanvullende velden: Nee

Bijwerken · Productvarianten — Varianten en opties — Verzoekinhoud

VariantUpdate · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

activeBooleaanse waardeOptioneel

Of de resource actief is.

expected_versionGeheel getalVerplicht

Versie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.

minimum: 1maximum: 9223372036854775807

Voorbeeld: 1

is_defaultBooleaanse waardeOptioneel

Of dit de standaardkeuze is.

media_idsArray <Tekenreeks> Optioneel

Identificaties van bestaande mediabestanden.

maxItems: 20

Array:minLength: 1maxLength: 63

pricingVariantPrice Optioneel

Prijsconfiguratie en versies voor gelijktijdige wijzigingen.

Voorbeeld:

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

skuTekenreeksOptioneel

Voorraadartikelcode (SKU).

minLength: 1maxLength: 100

Beperkingen

pattern: "^\\S+$"

Voorbeeld: "example"

Aanvullende velden: Nee

Aanmaken · Optiewaarden — Varianten en opties — Verzoekinhoud

VariantValueCreate · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

color_hexTekenreeks nullOptioneel

Kleur als hexadecimale code.

Beperkingen · Tekenreeks 1

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

expected_versionGeheel getalVerplicht

Versie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.

minimum: 1maximum: 9223372036854775807

Voorbeeld: 1

valueTekenreeksVerplicht

Waarde zoals beschreven door het omringende schema.

minLength: 1maxLength: 180

Beperkingen

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

Voorbeeld: "Example"

Aanvullende velden: Nee

Ophalen · Optiewaarden — Varianten en opties — Antwoord

VariantValueData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

color_hexTekenreeks nullVerplicht: Kleur als hexadecimale code.

Voorbeeld: "#008855"
created_atTekenreeksVerplicht: Tijdstip van aanmaak.

format: "date-time"

Voorbeeld: "2026-01-01T12:00:00Z"
idTekenreeksVerplicht: Resource-identificatie; bewaar deze zoals teruggegeven. (VariantValueData).

Voorbeeld: "example"
image_media_idTekenreeks nullVerplicht: Identificatie van het geselecteerde afbeeldingsbestand.

Voorbeeld: null
numberTekenreeksVerplicht: Bestel- of aanvraagnummer voor menselijk gebruik.

Voorbeeld: "example"
option_idTekenreeksVerplicht: Identificatie van de variantoptie.

Voorbeeld: "example"
positionGeheel getalVerplicht: Positie in de geordende verzameling.

Voorbeeld: 1
sku_codeTekenreeksVerplicht: Voorraadartikelcode (SKU).

Voorbeeld: "example"
updated_atTekenreeksVerplicht: Tijdstip van de meest recente wijziging.

format: "date-time"

Voorbeeld: "2026-01-01T12:00:00Z"
valueTekenreeks nullVerplicht: Waarde zoals beschreven door het omringende schema.

Voorbeeld: "example"
versionGeheel getalVerplicht: Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1

Aanvullende velden: Nee

Bijwerken · Optiewaarden — Varianten en opties — Verzoekinhoud

VariantValueUpdate · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

color_hexTekenreeks nullOptioneel

Kleur als hexadecimale code.

Beperkingen · Tekenreeks 1

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

expected_versionGeheel getalVerplicht

Versie die vóór de schrijfbewerking is gelezen; bij afwijking wordt de wijziging geweigerd.

minimum: 1maximum: 9223372036854775807

Voorbeeld: 1

valueTekenreeks nullOptioneel

Waarde zoals beschreven door het omringende schema.

Tekenreeks:minLength: 1maxLength: 180

Beperkingen · Tekenreeks 1

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

Voorbeeld: "Example"

Aanvullende velden: Nee