Datenschemas: Kategorien

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

Datenschemas

Abrufen — Kategorien — Antwort

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

dataCategoryDetailData Erforderlich: Beispielantwort · CategoryDetailData.

Beispiel: {"created_at":"2026-01-01T12:00:00Z","description":"example","id":"example","introduction":"example","is_available":true,"is_visible":false,"meta_description":"example","meta_keywords":["example"],"meta_title":"example","name":"Example","number":"example","parent_id":null,"slug":"example","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

Auflisten — Kategorien — Antwort

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

dataArray <CategorySummaryData > Erforderlich: Beispielantwort · ApiResponse_list_CategorySummaryData__.

Beispiel: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_available":true,"is_visible":false,"name":"Example","number":"example","parent_id":null,"slug":"example","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

Erstellen — Kategorien — Anfrageinhalt

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

descriptionZeichenfolge nullOptional: Beschreibung in der ausgewählten Sprache.

Zeichenfolge:maxLength: 50000
introductionZeichenfolge nullOptional: Einleitungstext in der ausgewählten Sprache.

Zeichenfolge:maxLength: 5000
is_visibleBoolescher WertOptional: Gibt an, ob die Ressource sichtbar ist.

Standardwert: false
market_idsArray <Zeichenfolge> Optional: Kennungen der ausgewählten Märkte.

maxItems: 1000
Array:minLength: 1maxLength: 63
meta_descriptionZeichenfolge nullOptional: Suchmaschinenbeschreibung in der ausgewählten Sprache.

Zeichenfolge:maxLength: 160
meta_keywordsArray <Zeichenfolge> nullOptional: Suchmaschinen-Schlüsselwörter in der ausgewählten Sprache.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleZeichenfolge nullOptional: Suchmaschinentitel in der ausgewählten Sprache.

Zeichenfolge:maxLength: 70
nameZeichenfolgeErforderlich: Name der Ressource im jeweiligen Kontext.

minLength: 1maxLength: 200

Beispiel: "Example"
parent_idZeichenfolge nullOptional: Kennung der übergeordneten Kategorie.

Zeichenfolge:minLength: 1maxLength: 63
slugZeichenfolge nullOptional: URL-Pfadsegment in der ausgewählten Sprache.

Zeichenfolge:maxLength: 160

Zusätzliche Felder: Nein

Abrufen — Kategorien — Antwort

CategoryDetailData · 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"
descriptionZeichenfolge nullErforderlich: Beschreibung in der ausgewählten Sprache.

Beispiel: "example"
idZeichenfolgeErforderlich: Ressourcenkennung; unverändert aus der Antwort übernehmen. (CategoryDetailData).

Beispiel: "example"
introductionZeichenfolge nullErforderlich: Einleitungstext in der ausgewählten Sprache.

Beispiel: "example"
is_availableBoolescher WertErforderlich: Gibt an, ob der Artikel in diesem Kontext verfügbar ist.

Beispiel: true
is_visibleBoolescher WertErforderlich: Gibt an, ob die Ressource sichtbar ist.

Beispiel: false
meta_descriptionZeichenfolge nullErforderlich: Suchmaschinenbeschreibung in der ausgewählten Sprache.

Beispiel: "example"
meta_keywordsArray <Zeichenfolge> nullErforderlich: Suchmaschinen-Schlüsselwörter in der ausgewählten Sprache.

Beispiel: ["example"]
meta_titleZeichenfolge nullErforderlich: Suchmaschinentitel in der ausgewählten Sprache.

Beispiel: "example"
nameZeichenfolge nullErforderlich: Name der Ressource im jeweiligen Kontext.

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

Beispiel: "example"
parent_idZeichenfolge nullErforderlich: Kennung der übergeordneten Kategorie.

Beispiel: null
slugZeichenfolge nullErforderlich: URL-Pfadsegment in der ausgewählten Sprache.

Beispiel: "example"
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

Auflisten — Kategorien — Antwort

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

Beispiel: "example"
is_availableBoolescher WertErforderlich: Gibt an, ob der Artikel in diesem Kontext verfügbar ist.

Beispiel: true
is_visibleBoolescher WertErforderlich: Gibt an, ob die Ressource sichtbar ist.

Beispiel: false
nameZeichenfolge nullErforderlich: Name der Ressource im jeweiligen Kontext.

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

Beispiel: "example"
parent_idZeichenfolge nullErforderlich: Kennung der übergeordneten Kategorie.

Beispiel: null
slugZeichenfolge nullErforderlich: URL-Pfadsegment in der ausgewählten Sprache.

Beispiel: "example"
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

Aktualisieren — Kategorien — Anfrageinhalt

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

descriptionZeichenfolge nullOptional: Beschreibung in der ausgewählten Sprache.

Zeichenfolge:maxLength: 50000
expected_versionGanzzahlErforderlich: Vor dem Schreiben gelesene Version; eine Abweichung verhindert die Änderung.

minimum: 1maximum: 9223372036854775807

Beispiel: 1
introductionZeichenfolge nullOptional: Einleitungstext in der ausgewählten Sprache.

Zeichenfolge:maxLength: 5000
is_visibleBoolescher WertOptional: Gibt an, ob die Ressource sichtbar ist.
market_idsArray <Zeichenfolge> Optional: Kennungen der ausgewählten Märkte.

maxItems: 1000
Array:minLength: 1maxLength: 63
meta_descriptionZeichenfolge nullOptional: Suchmaschinenbeschreibung in der ausgewählten Sprache.

Zeichenfolge:maxLength: 160
meta_keywordsArray <Zeichenfolge> nullOptional: Suchmaschinen-Schlüsselwörter in der ausgewählten Sprache.

Array:maxItems: 20
Array / Array:maxLength: 50
meta_titleZeichenfolge nullOptional: Suchmaschinentitel in der ausgewählten Sprache.

Zeichenfolge:maxLength: 70
nameZeichenfolge nullOptional: Name der Ressource im jeweiligen Kontext.

Zeichenfolge:maxLength: 200

Beispiel: "Example"
parent_idZeichenfolge nullOptional: Kennung der übergeordneten Kategorie.

Zeichenfolge:minLength: 1maxLength: 63
slugZeichenfolge nullOptional: URL-Pfadsegment in der ausgewählten Sprache.

Zeichenfolge:maxLength: 160

Zusätzliche Felder: Nein