Zum Inhalt springen
ShopentlyLearn

Datenschemas: CMS-Seiten

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

Datenschemas

Metadaten der Antwort

AnalyticsPageMeta · Schema · Datenschemas: CMS-Seiten
paginationPagination Erforderlich

Metadaten der Cursor-Paginierung.

Beispiel: {"has_more":false,"limit":20,"next_cursor":null}
periodAnalyticsPeriodData Erforderlich

Berichtszeitraum und seine Grenzen.

Beispiel: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idZeichenfolgeErforderlich

Vorgangskennung; in Antwortmetadaten die Kennung der HTTP-Anfrage.

minLength: 1maxLength: 100
Beispiel: "example"

Zusätzliche Felder: Nein

Auflisten — CMS-Seiten — Antwort

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

Beispielantwort · ApiResponse_list_PageSummaryData__.

Beispiel: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_available":true,"market_scope":"all","number":"example","published":false,"slug":"example","title":"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

Abrufen — CMS-Seiten — Antwort

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

Beispielantwort · PageDetailData.

Beispiel: {"body_html":"<p>Example</p>","created_at":"2026-01-01T12:00:00Z","id":"example","is_available":true,"market_scope":"all","meta_description":"example","meta_keywords":["example"],"meta_title":"example","number":"example","published":false,"slug":"example","title":"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

Erstellen — CMS-Seiten — Anfrageinhalt

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

Seiteninhalt im HTML-Format.

Zeichenfolge:maxLength: 100000
market_idsArray <Zeichenfolge> Optional

Kennungen der ausgewählten Märkte.

maxItems: 1000
Array:minLength: 1maxLength: 63
market_scopeZeichenfolgeOptional

Gibt an, ob alle oder nur ausgewählte Märkte gelten.

Einschränkungen
enum
["all", "selected"]
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: 60
meta_titleZeichenfolge nullOptional

Suchmaschinentitel in der ausgewählten Sprache.

Zeichenfolge:maxLength: 70
publishedBoolescher WertOptional

Gibt an, ob die Ressource veröffentlicht ist.

Standardwert: false
slugZeichenfolge nullOptional

URL-Pfadsegment in der ausgewählten Sprache.

Zeichenfolge:maxLength: 160
titleZeichenfolgeErforderlich

Titel in der ausgewählten Sprache.

minLength: 1maxLength: 300
Beispiel: "Example"

Zusätzliche Felder: Nein

Abrufen — CMS-Seiten — Antwort

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

Seiteninhalt im HTML-Format.

Beispiel: "<p>Example</p>"
created_atZeichenfolgeErforderlich

Zeitpunkt der Erstellung.

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

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

Beispiel: "example"
is_availableBoolescher WertErforderlich

Gibt an, ob der Artikel in diesem Kontext verfügbar ist.

Beispiel: true
market_scopeZeichenfolgeErforderlich

Gibt an, ob alle oder nur ausgewählte Märkte gelten.

Einschränkungen
enum
["all", "selected"]
Beispiel: "all"
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"
numberZeichenfolgeErforderlich

Für Benutzer sichtbare Bestell- oder Vorgangsnummer.

Beispiel: "example"
publishedBoolescher WertErforderlich

Gibt an, ob die Ressource veröffentlicht ist.

Beispiel: false
slugZeichenfolge nullErforderlich

URL-Pfadsegment in der ausgewählten Sprache.

Beispiel: "example"
titleZeichenfolge nullErforderlich

Titel 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 — CMS-Seiten — Antwort

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

Beispiel: "example"
is_availableBoolescher WertErforderlich

Gibt an, ob der Artikel in diesem Kontext verfügbar ist.

Beispiel: true
market_scopeZeichenfolgeErforderlich

Gibt an, ob alle oder nur ausgewählte Märkte gelten.

Einschränkungen
enum
["all", "selected"]
Beispiel: "all"
numberZeichenfolgeErforderlich

Für Benutzer sichtbare Bestell- oder Vorgangsnummer.

Beispiel: "example"
publishedBoolescher WertErforderlich

Gibt an, ob die Ressource veröffentlicht ist.

Beispiel: false
slugZeichenfolge nullErforderlich

URL-Pfadsegment in der ausgewählten Sprache.

Beispiel: "example"
titleZeichenfolge nullErforderlich

Titel 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 — CMS-Seiten — Anfrageinhalt

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

Seiteninhalt im HTML-Format.

Zeichenfolge:maxLength: 100000
expected_versionGanzzahlErforderlich

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

minimum: 1maximum: 2147483647
Beispiel: 1
market_idsArray <Zeichenfolge> Optional

Kennungen der ausgewählten Märkte.

maxItems: 1000
Array:minLength: 1maxLength: 63
market_scopeZeichenfolgeOptional

Gibt an, ob alle oder nur ausgewählte Märkte gelten.

Einschränkungen
enum
["all", "selected"]
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: 60
meta_titleZeichenfolge nullOptional

Suchmaschinentitel in der ausgewählten Sprache.

Zeichenfolge:maxLength: 70
publishedBoolescher WertOptional

Gibt an, ob die Ressource veröffentlicht ist.

slugZeichenfolge nullOptional

URL-Pfadsegment in der ausgewählten Sprache.

Zeichenfolge:maxLength: 160
titleZeichenfolge nullOptional

Titel in der ausgewählten Sprache.

Zeichenfolge:maxLength: 300
Beispiel: "Example"

Zusätzliche Felder: Nein