Ga naar de inhoud
ShopentlyLearn

Gegevensschema’s: CMS-pagina’s

Gegevensschema’s: CMS-pagina’s. Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.

Gegevensschema’s

Metadata van het antwoord

AnalyticsPageMeta · Schema · Gegevensschema’s: CMS-pagina’s
paginationPagination Verplicht

Metadata voor cursorpaginering.

Voorbeeld: {"has_more":false,"limit":20,"next_cursor":null}
periodAnalyticsPeriodData Verplicht

Rapportageperiode en de grenzen ervan.

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

Aanvraagidentificatie; in antwoordmetadata identificeert dit het HTTP-verzoek.

minLength: 1maxLength: 100
Voorbeeld: "example"

Aanvullende velden: Nee

Lijst ophalen — CMS-pagina’s — Antwoord

ApiResponse_list_PageSummaryData__ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
dataArray <PageSummaryData > Verplicht

Voorbeeldantwoord · ApiResponse_list_PageSummaryData__.

Voorbeeld: [{"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 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 — CMS-pagina’s — Antwoord

ApiResponse_PageDetailData_ · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
dataPageDetailData Verplicht

Voorbeeldantwoord · PageDetailData.

Voorbeeld: {"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 Verplicht

Metadata van het antwoord.

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

Aanvullende velden: Nee

Aanmaken — CMS-pagina’s — Verzoekinhoud

PageCreate · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
body_htmlTekenreeks nullOptioneel

Pagina-inhoud in HTML.

Tekenreeks:maxLength: 100000
market_idsArray <Tekenreeks> Optioneel

Identificaties van geselecteerde markten.

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

Of de resource voor alle of alleen geselecteerde markten geldt.

Beperkingen
enum
["all", "selected"]
meta_descriptionTekenreeks nullOptioneel

Zoekmachinebeschrijving in de geselecteerde taal.

Tekenreeks:maxLength: 160
meta_keywordsArray <Tekenreeks> nullOptioneel

Zoekmachinetrefwoorden in de geselecteerde taal.

Array:maxItems: 20
Array / Array:maxLength: 60
meta_titleTekenreeks nullOptioneel

Zoekmachinetitel in de geselecteerde taal.

Tekenreeks:maxLength: 70
publishedBooleaanse waardeOptioneel

Of de resource is gepubliceerd.

Standaard: false
slugTekenreeks nullOptioneel

URL-padsegment in de geselecteerde taal.

Tekenreeks:maxLength: 160
titleTekenreeksVerplicht

Titel in de geselecteerde taal.

minLength: 1maxLength: 300
Voorbeeld: "Example"

Aanvullende velden: Nee

Ophalen — CMS-pagina’s — Antwoord

PageDetailData · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
body_htmlTekenreeks nullVerplicht

Pagina-inhoud in HTML.

Voorbeeld: "<p>Example</p>"
created_atTekenreeksVerplicht

Tijdstip van aanmaak.

format: "date-time"
Voorbeeld: "2026-01-01T12:00:00Z"
idTekenreeksVerplicht

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

Voorbeeld: "example"
is_availableBooleaanse waardeVerplicht

Of het item beschikbaar is in deze context.

Voorbeeld: true
market_scopeTekenreeksVerplicht

Of de resource voor alle of alleen geselecteerde markten geldt.

Beperkingen
enum
["all", "selected"]
Voorbeeld: "all"
meta_descriptionTekenreeks nullVerplicht

Zoekmachinebeschrijving in de geselecteerde taal.

Voorbeeld: "example"
meta_keywordsArray <Tekenreeks> nullVerplicht

Zoekmachinetrefwoorden in de geselecteerde taal.

Voorbeeld: ["example"]
meta_titleTekenreeks nullVerplicht

Zoekmachinetitel in de geselecteerde taal.

Voorbeeld: "example"
numberTekenreeksVerplicht

Bestel- of aanvraagnummer voor menselijk gebruik.

Voorbeeld: "example"
publishedBooleaanse waardeVerplicht

Of de resource is gepubliceerd.

Voorbeeld: false
slugTekenreeks nullVerplicht

URL-padsegment in de geselecteerde taal.

Voorbeeld: "example"
titleTekenreeks nullVerplicht

Titel in de geselecteerde taal.

Voorbeeld: "example"
updated_atTekenreeksVerplicht

Tijdstip van de meest recente wijziging.

format: "date-time"
Voorbeeld: "2026-01-01T12:00:00Z"
versionGeheel getalVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1

Aanvullende velden: Nee

Lijst ophalen — CMS-pagina’s — Antwoord

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

Voorbeeld: "example"
is_availableBooleaanse waardeVerplicht

Of het item beschikbaar is in deze context.

Voorbeeld: true
market_scopeTekenreeksVerplicht

Of de resource voor alle of alleen geselecteerde markten geldt.

Beperkingen
enum
["all", "selected"]
Voorbeeld: "all"
numberTekenreeksVerplicht

Bestel- of aanvraagnummer voor menselijk gebruik.

Voorbeeld: "example"
publishedBooleaanse waardeVerplicht

Of de resource is gepubliceerd.

Voorbeeld: false
slugTekenreeks nullVerplicht

URL-padsegment in de geselecteerde taal.

Voorbeeld: "example"
titleTekenreeks nullVerplicht

Titel in de geselecteerde taal.

Voorbeeld: "example"
updated_atTekenreeksVerplicht

Tijdstip van de meest recente wijziging.

format: "date-time"
Voorbeeld: "2026-01-01T12:00:00Z"
versionGeheel getalVerplicht

Resourceversie voor controle op gelijktijdige wijzigingen.

Voorbeeld: 1

Aanvullende velden: Nee

Bijwerken — CMS-pagina’s — Verzoekinhoud

PageUpdate · Velden, typen en beperkingen van gegevens die de API ontvangt of teruggeeft.
body_htmlTekenreeks nullOptioneel

Pagina-inhoud in HTML.

Tekenreeks:maxLength: 100000
expected_versionGeheel getalVerplicht

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

minimum: 1maximum: 2147483647
Voorbeeld: 1
market_idsArray <Tekenreeks> Optioneel

Identificaties van geselecteerde markten.

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

Of de resource voor alle of alleen geselecteerde markten geldt.

Beperkingen
enum
["all", "selected"]
meta_descriptionTekenreeks nullOptioneel

Zoekmachinebeschrijving in de geselecteerde taal.

Tekenreeks:maxLength: 160
meta_keywordsArray <Tekenreeks> nullOptioneel

Zoekmachinetrefwoorden in de geselecteerde taal.

Array:maxItems: 20
Array / Array:maxLength: 60
meta_titleTekenreeks nullOptioneel

Zoekmachinetitel in de geselecteerde taal.

Tekenreeks:maxLength: 70
publishedBooleaanse waardeOptioneel

Of de resource is gepubliceerd.

slugTekenreeks nullOptioneel

URL-padsegment in de geselecteerde taal.

Tekenreeks:maxLength: 160
titleTekenreeks nullOptioneel

Titel in de geselecteerde taal.

Tekenreeks:maxLength: 300
Voorbeeld: "Example"

Aanvullende velden: Nee