Datenschemas: Varianten und Optionen

Datenschemas: Varianten und Optionen. Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

Datenschemas

Auflisten · Produktvarianten — Varianten und Optionen — Antwort

ApiResponse_list_ProductVariantData__ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

dataArray <ProductVariantData > Erforderlich: Beispielantwort · ApiResponse_list_ProductVariantData__.

Beispiel: [{"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 Erforderlich: Metadaten der Antwort.

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

Zusätzliche Felder: Nein

Auflisten · Optionen — Varianten und Optionen — Antwort

ApiResponse_list_VariantOptionData__ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

dataArray <shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData > Erforderlich: Beispielantwort · ApiResponse_list_VariantOptionData__.

Beispiel: [{"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 Erforderlich: Metadaten der Antwort.

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

Zusätzliche Felder: Nein

Auflisten · Optionswerte — Varianten und Optionen — Antwort

ApiResponse_list_VariantValueData__ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

dataArray <VariantValueData > Erforderlich: Beispielantwort · ApiResponse_list_VariantValueData__.

Beispiel: [{"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 Erforderlich: Metadaten der Antwort.

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

Zusätzliche Felder: Nein

Abrufen · Produktvarianten — Varianten und Optionen — Antwort

ApiResponse_ProductVariantData_ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

dataProductVariantData Erforderlich: Beispielantwort · ProductVariantData.

Beispiel: {"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 Erforderlich: Metadaten der Antwort.

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

Zusätzliche Felder: Nein

Abrufen · Optionen — Varianten und Optionen — Antwort

ApiResponse_VariantOptionData_ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

datashopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData Erforderlich: Beispielantwort · shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData.

Beispiel: {"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 Erforderlich: Metadaten der Antwort.

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

Zusätzliche Felder: Nein

Abrufen · Optionswerte — Varianten und Optionen — Antwort

ApiResponse_VariantValueData_ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

dataVariantValueData Erforderlich: Beispielantwort · VariantValueData.

Beispiel: {"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 Erforderlich: Metadaten der Antwort.

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

Zusätzliche Felder: Nein

Abrufen · Optionen — Varianten und Optionen — Antwort

shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

created_atZeichenfolgeErforderlich

Zeitpunkt der Erstellung.

format: "date-time"

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

idZeichenfolgeErforderlich

Ressourcenkennung; unverändert aus der Antwort übernehmen. (shopently_engine__domains__catalog__adapters__public_http__dictionaries__schemas__VariantOptionData).

Beispiel: "example"

nameZeichenfolge nullErforderlich

Name der Ressource im jeweiligen Kontext.

Beispiel: "Example"

numberZeichenfolgeErforderlich

Für Benutzer sichtbare Bestell- oder Vorgangsnummer.

Beispiel: "example"

positionGanzzahlErforderlich

Position in der geordneten Sammlung.

Beispiel: 1

selection_typeZeichenfolgeErforderlich

Zulässiger Auswahlmodus für Merkmalswerte.

Einschränkungen

enum: ["button", "dropdown"]

Beispiel: "button"

updated_atZeichenfolgeErforderlich

Zeitpunkt der letzten Änderung.

format: "date-time"

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

value_presentation_typeZeichenfolgeErforderlich

Darstellung der Verzeichniswerte.

Einschränkungen

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

Beispiel: "text"

versionGanzzahlErforderlich

Ressourcenversion zur Nebenläufigkeitskontrolle.

Beispiel: 1

Zusätzliche Felder: Nein

Abrufen · Produktvarianten — Varianten und Optionen — Antwort

ProductVariantData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

activeBoolescher WertErforderlich: Gibt an, ob die Ressource aktiv ist.

Beispiel: true
created_atZeichenfolgeErforderlich: Zeitpunkt der Erstellung.

format: "date-time"

Beispiel: "2026-01-01T12:00:00Z"
idZeichenfolgeErforderlich: Ressourcenkennung; unverändert aus der Antwort übernehmen. (ProductVariantData).

Beispiel: "example"
is_defaultBoolescher WertErforderlich: Gibt an, ob dies die Standardauswahl ist.

Beispiel: true
media_idsArray <Zeichenfolge> Erforderlich: Kennungen bereits vorhandener Mediendateien.

Beispiel: ["example"]
positionGanzzahlErforderlich: Position in der geordneten Sammlung.

Beispiel: 1
pricingVariantPricingData Erforderlich: Preiskonfiguration und zugehörige Versionsprüfungen.

Beispiel: {"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_idZeichenfolge nullErforderlich: Kennung der primären Mediendatei.

Beispiel: "example"
product_idZeichenfolgeErforderlich: Produktkennung.

Beispiel: "example"
skuZeichenfolgeErforderlich: Artikelcode der Lagerhaltungseinheit.

Beispiel: "example"
updated_atZeichenfolgeErforderlich: Zeitpunkt der letzten Änderung.

format: "date-time"

Beispiel: "2026-01-01T12:00:00Z"
valuesArray <VariantChoiceData > Erforderlich: Verzeichniswerte.

Beispiel: [{"option_id":"example","option_name":"example","value":"example","value_id":"example"}]
versionGanzzahlErforderlich: Ressourcenversion zur Nebenläufigkeitskontrolle.

Beispiel: 1

Zusätzliche Felder: Nein

Verzeichniswerte

VariantChoiceData · Schema · Datenschemas: Varianten und Optionen

option_idZeichenfolgeErforderlich: Kennung der Variantenoption.

Beispiel: "example"
option_nameZeichenfolge nullErforderlich: Name der Variantenoption.

Beispiel: "example"
valueZeichenfolge nullErforderlich: Durch das umgebende Schema beschriebener Wert.

Beispiel: "example"
value_idZeichenfolgeErforderlich: Kennung eines Verzeichniswerts.

Beispiel: "example"

Zusätzliche Felder: Nein

Erstellen · Produktvarianten — Varianten und Optionen — Anfrageinhalt

VariantCreate · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

activeBoolescher WertOptional

Gibt an, ob die Ressource aktiv ist.

Standardwert: true

expected_versionGanzzahlErforderlich

Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 1maximum: 9223372036854775807

Beispiel: 1

is_defaultBoolescher WertOptional

Gibt an, ob dies die Standardauswahl ist.

media_idsArray <Zeichenfolge> Optional

Kennungen bereits vorhandener Mediendateien.

maxItems: 20

Array:minLength: 1maxLength: 63

pricingVariantPrice Optional

Preiskonfiguration und zugehörige Versionsprüfungen.

skuZeichenfolgeOptional

Artikelcode der Lagerhaltungseinheit.

minLength: 1maxLength: 100

Einschränkungen

pattern: "^\\S+$"

value_idsArray <Zeichenfolge> Erforderlich

Kennungen von Verzeichniswerten.

minItems: 1maxItems: 250

Array:minLength: 1maxLength: 63

Beispiel: ["example"]

Zusätzliche Felder: Nein

Erstellen · Optionen — Varianten und Optionen — Anfrageinhalt

VariantOptionCreate · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

nameZeichenfolgeErforderlich

Name der Ressource im jeweiligen Kontext.

minLength: 1maxLength: 120

Einschränkungen

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

Beispiel: "Example"

selection_typeZeichenfolgeOptional

Zulässiger Auswahlmodus für Merkmalswerte.

Einschränkungen

enum: ["button", "dropdown"]

Standardwert: "button"

value_presentation_typeZeichenfolgeOptional

Darstellung der Verzeichniswerte.

Einschränkungen

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

Standardwert: "text"

Zusätzliche Felder: Nein

Aktualisieren · Optionen — Varianten und Optionen — Anfrageinhalt

VariantOptionUpdate · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

expected_versionGanzzahlErforderlich

Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 1maximum: 9223372036854775807

Beispiel: 1

nameZeichenfolge nullOptional

Name der Ressource im jeweiligen Kontext.

Zeichenfolge:minLength: 1maxLength: 120

Einschränkungen · Zeichenfolge 1

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

Beispiel: "Example"

selection_typeZeichenfolgeOptional

Zulässiger Auswahlmodus für Merkmalswerte.

Einschränkungen

enum: ["button", "dropdown"]

value_presentation_typeZeichenfolgeOptional

Darstellung der Verzeichniswerte.

Einschränkungen

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

Zusätzliche Felder: Nein

Preiskonfiguration und zugehörige Versionsprüfungen

VariantPrice · Schema · Datenschemas: Varianten und Optionen

amountZeichenfolge nullErforderlich

Dezimalbetrag als JSON-Zeichenfolge; null nur, wenn ausdrücklich zulässig.

Zeichenfolge:maxLength: 20

Einschränkungen · Zeichenfolge 1

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

Beispiel: "0.00"

currencyZeichenfolgeErforderlich

Währungscode des Betrags.

Einschränkungen

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

Beispiel: "PLN"

expected_price_list_versionGanzzahlErforderlich

Zuvor gelesene Preislistenversion für diesen Schreibvorgang.

minimum: 1maximum: 9223372036854775807

Beispiel: 1

expected_product_versionGanzzahlErforderlich

Zuvor gelesene Produktversion für diesen Schreibvorgang.

minimum: 0maximum: 9223372036854775807

Beispiel: 1

expected_versionGanzzahlErforderlich

Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 0maximum: 9223372036854775807

Beispiel: 0

kindZeichenfolgeErforderlich

Durch die zulässigen Werte beschriebene Variante der Datenstruktur.

Einschränkungen

enum: ["base_adjustment", "market_fixed"]

Beispiel: "base_adjustment"

price_list_idZeichenfolgeErforderlich

Preislistenkennung.

minLength: 1maxLength: 63

Beispiel: "example"

Zusätzliche Felder: Nein

Preiskonfiguration und zugehörige Versionsprüfungen

VariantPricingData · Schema · Datenschemas: Varianten und Optionen

base_adjustmentMoneyData Erforderlich: Preisanpassung gegenüber dem Basispreis.

Beispiel: {"amount":"0.00","currency":"PLN","minor_units":2}
market_priceMoneyData nullErforderlich: Preis für den ausgewählten Markt.

Beispiel: null
pricePriceData nullErforderlich: Preisinformationen im ausgewählten Kontext.

Beispiel: {"amount":"0.00","currency":"PLN","minor_units":2,"tax_included":true}
product_versionGanzzahlErforderlich: Aktuelle Produktversion zur Nebenläufigkeitskontrolle.

Beispiel: 1
versionGanzzahlErforderlich: Ressourcenversion zur Nebenläufigkeitskontrolle.

Beispiel: 1

Zusätzliche Felder: Nein

Aktualisieren · Produktvarianten — Varianten und Optionen — Anfrageinhalt

VariantUpdate · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

activeBoolescher WertOptional

Gibt an, ob die Ressource aktiv ist.

expected_versionGanzzahlErforderlich

Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 1maximum: 9223372036854775807

Beispiel: 1

is_defaultBoolescher WertOptional

Gibt an, ob dies die Standardauswahl ist.

media_idsArray <Zeichenfolge> Optional

Kennungen bereits vorhandener Mediendateien.

maxItems: 20

Array:minLength: 1maxLength: 63

pricingVariantPrice Optional

Preiskonfiguration und zugehörige Versionsprüfungen.

Beispiel:

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

skuZeichenfolgeOptional

Artikelcode der Lagerhaltungseinheit.

minLength: 1maxLength: 100

Einschränkungen

pattern: "^\\S+$"

Beispiel: "example"

Zusätzliche Felder: Nein

Erstellen · Optionswerte — Varianten und Optionen — Anfrageinhalt

VariantValueCreate · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

color_hexZeichenfolge nullOptional

Farbe als Hexadezimalcode.

Einschränkungen · Zeichenfolge 1

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

expected_versionGanzzahlErforderlich

Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 1maximum: 9223372036854775807

Beispiel: 1

valueZeichenfolgeErforderlich

Durch das umgebende Schema beschriebener Wert.

minLength: 1maxLength: 180

Einschränkungen

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

Beispiel: "Example"

Zusätzliche Felder: Nein

Abrufen · Optionswerte — Varianten und Optionen — Antwort

VariantValueData · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

color_hexZeichenfolge nullErforderlich: Farbe als Hexadezimalcode.

Beispiel: "#008855"
created_atZeichenfolgeErforderlich: Zeitpunkt der Erstellung.

format: "date-time"

Beispiel: "2026-01-01T12:00:00Z"
idZeichenfolgeErforderlich: Ressourcenkennung; unverändert aus der Antwort übernehmen. (VariantValueData).

Beispiel: "example"
image_media_idZeichenfolge nullErforderlich: Kennung der ausgewählten Bilddatei.

Beispiel: null
numberZeichenfolgeErforderlich: Für Benutzer sichtbare Bestell- oder Vorgangsnummer.

Beispiel: "example"
option_idZeichenfolgeErforderlich: Kennung der Variantenoption.

Beispiel: "example"
positionGanzzahlErforderlich: Position in der geordneten Sammlung.

Beispiel: 1
sku_codeZeichenfolgeErforderlich: Artikelcode der Lagerhaltungseinheit.

Beispiel: "example"
updated_atZeichenfolgeErforderlich: Zeitpunkt der letzten Änderung.

format: "date-time"

Beispiel: "2026-01-01T12:00:00Z"
valueZeichenfolge nullErforderlich: Durch das umgebende Schema beschriebener Wert.

Beispiel: "example"
versionGanzzahlErforderlich: Ressourcenversion zur Nebenläufigkeitskontrolle.

Beispiel: 1

Zusätzliche Felder: Nein

Aktualisieren · Optionswerte — Varianten und Optionen — Anfrageinhalt

VariantValueUpdate · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.

color_hexZeichenfolge nullOptional

Farbe als Hexadezimalcode.

Einschränkungen · Zeichenfolge 1

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

expected_versionGanzzahlErforderlich

Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 1maximum: 9223372036854775807

Beispiel: 1

valueZeichenfolge nullOptional

Durch das umgebende Schema beschriebener Wert.

Zeichenfolge:minLength: 1maxLength: 180

Einschränkungen · Zeichenfolge 1

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

Beispiel: "Example"

Zusätzliche Felder: Nein