Hoppa till innehållet
ShopentlyLearn

Datascheman: CMS-sidor

Datascheman: CMS-sidor. Fält, typer och begränsningar för data som API:et tar emot eller returnerar.

Datascheman

Metadata för svaret

AnalyticsPageMeta · Schema · Datascheman: CMS-sidor
paginationPagination Obligatoriskt

Metadata för markörbaserad paginering.

Exempel: {"has_more":false,"limit":20,"next_cursor":null}
periodAnalyticsPeriodData Obligatoriskt

Rapporteringsperiod och dess gränser.

Exempel: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idSträngObligatoriskt

Ärendets identifierare; i svarsmetadata identifierar detta HTTP-begäran.

minLength: 1maxLength: 100
Exempel: "example"

Ytterligare fält: Nej

Lista — CMS-sidor — Svar

ApiResponse_list_PageSummaryData__ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
dataArray <PageSummaryData > Obligatoriskt

Exempel på svar · ApiResponse_list_PageSummaryData__.

Exempel: [{"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 Obligatoriskt

Metadata för svaret.

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

Ytterligare fält: Nej

Hämta — CMS-sidor — Svar

ApiResponse_PageDetailData_ · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
dataPageDetailData Obligatoriskt

Exempel på svar · PageDetailData.

Exempel: {"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 Obligatoriskt

Metadata för svaret.

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

Ytterligare fält: Nej

Skapa — CMS-sidor — Begärans innehåll

PageCreate · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
body_htmlSträng nullValfritt

Sidans innehåll i HTML.

Sträng:maxLength: 100000
market_idsArray <Sträng> Valfritt

Identifierare för valda marknader.

maxItems: 1000
Array:minLength: 1maxLength: 63
market_scopeSträngValfritt

Anger om resursen gäller alla eller valda marknader.

Begränsningar
enum
["all", "selected"]
meta_descriptionSträng nullValfritt

Sökmotorbeskrivning på valt språk.

Sträng:maxLength: 160
meta_keywordsArray <Sträng> nullValfritt

Sökord för sökmotorer på valt språk.

Array:maxItems: 20
Array / Array:maxLength: 60
meta_titleSträng nullValfritt

Sökmotortitel på valt språk.

Sträng:maxLength: 70
publishedBooleskt värdeValfritt

Anger om resursen är publicerad.

Standardvärde: false
slugSträng nullValfritt

URL-segment på valt språk.

Sträng:maxLength: 160
titleSträngObligatoriskt

Titel på valt språk.

minLength: 1maxLength: 300
Exempel: "Example"

Ytterligare fält: Nej

Hämta — CMS-sidor — Svar

PageDetailData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
body_htmlSträng nullObligatoriskt

Sidans innehåll i HTML.

Exempel: "<p>Example</p>"
created_atSträngObligatoriskt

Tidpunkt för skapande.

format: "date-time"
Exempel: "2026-01-01T12:00:00Z"
idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. (PageDetailData).

Exempel: "example"
is_availableBooleskt värdeObligatoriskt

Anger om artikeln är tillgänglig i denna kontext.

Exempel: true
market_scopeSträngObligatoriskt

Anger om resursen gäller alla eller valda marknader.

Begränsningar
enum
["all", "selected"]
Exempel: "all"
meta_descriptionSträng nullObligatoriskt

Sökmotorbeskrivning på valt språk.

Exempel: "example"
meta_keywordsArray <Sträng> nullObligatoriskt

Sökord för sökmotorer på valt språk.

Exempel: ["example"]
meta_titleSträng nullObligatoriskt

Sökmotortitel på valt språk.

Exempel: "example"
numberSträngObligatoriskt

Beställnings- eller ärendenummer som visas för användaren.

Exempel: "example"
publishedBooleskt värdeObligatoriskt

Anger om resursen är publicerad.

Exempel: false
slugSträng nullObligatoriskt

URL-segment på valt språk.

Exempel: "example"
titleSträng nullObligatoriskt

Titel på valt språk.

Exempel: "example"
updated_atSträngObligatoriskt

Tidpunkt för senaste uppdatering.

format: "date-time"
Exempel: "2026-01-01T12:00:00Z"
versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

Exempel: 1

Ytterligare fält: Nej

Lista — CMS-sidor — Svar

PageSummaryData · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
created_atSträngObligatoriskt

Tidpunkt för skapande.

format: "date-time"
Exempel: "2026-01-01T12:00:00Z"
idSträngObligatoriskt

Resursens identifierare; bevara den som den returneras. (PageSummaryData).

Exempel: "example"
is_availableBooleskt värdeObligatoriskt

Anger om artikeln är tillgänglig i denna kontext.

Exempel: true
market_scopeSträngObligatoriskt

Anger om resursen gäller alla eller valda marknader.

Begränsningar
enum
["all", "selected"]
Exempel: "all"
numberSträngObligatoriskt

Beställnings- eller ärendenummer som visas för användaren.

Exempel: "example"
publishedBooleskt värdeObligatoriskt

Anger om resursen är publicerad.

Exempel: false
slugSträng nullObligatoriskt

URL-segment på valt språk.

Exempel: "example"
titleSträng nullObligatoriskt

Titel på valt språk.

Exempel: "example"
updated_atSträngObligatoriskt

Tidpunkt för senaste uppdatering.

format: "date-time"
Exempel: "2026-01-01T12:00:00Z"
versionHeltalObligatoriskt

Resursversion för samtidighetskontroll.

Exempel: 1

Ytterligare fält: Nej

Uppdatera — CMS-sidor — Begärans innehåll

PageUpdate · Fält, typer och begränsningar för data som API:et tar emot eller returnerar.
body_htmlSträng nullValfritt

Sidans innehåll i HTML.

Sträng:maxLength: 100000
expected_versionHeltalObligatoriskt

Version läst före skrivningen; avvikelse gör att ändringen avvisas.

minimum: 1maximum: 2147483647
Exempel: 1
market_idsArray <Sträng> Valfritt

Identifierare för valda marknader.

maxItems: 1000
Array:minLength: 1maxLength: 63
market_scopeSträngValfritt

Anger om resursen gäller alla eller valda marknader.

Begränsningar
enum
["all", "selected"]
meta_descriptionSträng nullValfritt

Sökmotorbeskrivning på valt språk.

Sträng:maxLength: 160
meta_keywordsArray <Sträng> nullValfritt

Sökord för sökmotorer på valt språk.

Array:maxItems: 20
Array / Array:maxLength: 60
meta_titleSträng nullValfritt

Sökmotortitel på valt språk.

Sträng:maxLength: 70
publishedBooleskt värdeValfritt

Anger om resursen är publicerad.

slugSträng nullValfritt

URL-segment på valt språk.

Sträng:maxLength: 160
titleSträng nullValfritt

Titel på valt språk.

Sträng:maxLength: 300
Exempel: "Example"

Ytterligare fält: Nej