Zum Inhalt springen
ShopentlyLearn

Datenschemas: Merkmale und Werte

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

Datenschemas

Abrufen — Merkmale und Werte — Antwort

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

Beispielantwort · FeatureData.

Beispiel: {"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","position":1,"updated_at":"2026-01-01T12:00:00Z","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 · Werte — Merkmale und Werte — Antwort

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

Beispielantwort · FeatureValueData.

Beispiel: {"created_at":"2026-01-01T12:00:00Z","feature_id":"example","id":"example","number":"example","position":1,"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

Auflisten — Merkmale und Werte — Antwort

ApiResponse_list_FeatureData__ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.
dataArray <FeatureData > Erforderlich

Beispielantwort · ApiResponse_list_FeatureData__.

Beispiel: [{"created_at":"2026-01-01T12:00:00Z","id":"example","name":"Example","number":"example","position":1,"updated_at":"2026-01-01T12:00:00Z","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 · Werte — Merkmale und Werte — Antwort

ApiResponse_list_FeatureValueData__ · Felder, Typen und Einschränkungen der von der API angenommenen oder zurückgegebenen Daten.
dataArray <FeatureValueData > Erforderlich

Beispielantwort · ApiResponse_list_FeatureValueData__.

Beispiel: [{"created_at":"2026-01-01T12:00:00Z","feature_id":"example","id":"example","number":"example","position":1,"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

Erstellen — Merkmale und Werte — Anfrageinhalt

FeatureCreate · 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"
positionGanzzahlOptional

Position in der geordneten Sammlung.

minimum: 0maximum: 2147483647

Zusätzliche Felder: Nein

Abrufen — Merkmale und Werte — Antwort

FeatureData · 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. (FeatureData).

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
updated_atZeichenfolgeErforderlich

Zeitpunkt der letzten Änderung.

format: "date-time"
Beispiel: "2026-01-01T12:00:00Z"
versionGanzzahlErforderlich

Ressourcenversion zur Nebenläufigkeitskontrolle.

Beispiel: 1

Zusätzliche Felder: Nein

Produktmerkmale

FeatureSelectionData · Schema · Datenschemas: Merkmale und Werte
feature_idZeichenfolgeErforderlich

Merkmalskennung.

Beispiel: "example"
feature_nameZeichenfolge nullErforderlich

Name des Merkmals.

Beispiel: "example"
valueZeichenfolge nullErforderlich

Durch das umgebende Schema beschriebener Wert.

Beispiel: "example"
value_idZeichenfolgeErforderlich

Kennung eines Verzeichniswerts.

Beispiel: "example"

Zusätzliche Felder: Nein

Aktualisieren — Merkmale und Werte — Anfrageinhalt

FeatureUpdate · 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"
positionGanzzahlOptional

Position in der geordneten Sammlung.

minimum: 0maximum: 2147483647

Zusätzliche Felder: Nein

Erstellen · Werte — Merkmale und Werte — Anfrageinhalt

FeatureValueCreate · 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
positionGanzzahlOptional

Position in der geordneten Sammlung.

minimum: 0maximum: 2147483647
valueZeichenfolgeErforderlich

Durch das umgebende Schema beschriebener Wert.

minLength: 1maxLength: 180
Einschränkungen
pattern
"^[^\\x00]*$"
Beispiel: "Example"

Zusätzliche Felder: Nein

Abrufen · Werte — Merkmale und Werte — Antwort

FeatureValueData · 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"
feature_idZeichenfolgeErforderlich

Merkmalskennung.

Beispiel: "example"
idZeichenfolgeErforderlich

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

Beispiel: "example"
numberZeichenfolgeErforderlich

Für Benutzer sichtbare Bestell- oder Vorgangsnummer.

Beispiel: "example"
positionGanzzahlErforderlich

Position in der geordneten Sammlung.

Beispiel: 1
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 · Werte — Merkmale und Werte — Anfrageinhalt

FeatureValueUpdate · 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
positionGanzzahlOptional

Position in der geordneten Sammlung.

minimum: 0maximum: 2147483647
valueZeichenfolge nullOptional

Durch das umgebende Schema beschriebener Wert.

Zeichenfolge:minLength: 1maxLength: 180
Einschränkungen · Zeichenfolge 1
pattern
"^[^\\x00]*$"
Beispiel: "Example"

Zusätzliche Felder: Nein