Gå til innhold
ShopentlyLearn

Dataskjemaer: CMS-sider

Dataskjemaer: CMS-sider. Felter, typer og begrensninger for data som API-et mottar eller returnerer.

Dataskjemaer

Svarmetadata

AnalyticsPageMeta · Skjema · Dataskjemaer: CMS-sider
paginationPagination Obligatorisk

Metadata for markørbasert sideinndeling.

Eksempel: {"has_more":false,"limit":20,"next_cursor":null}
periodAnalyticsPeriodData Obligatorisk

Rapporteringsperiode og grensene for den.

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

Saksidentifikator; i svarmetadata identifiserer den HTTP-forespørselen.

minLength: 1maxLength: 100
Eksempel: "example"

Ytterligere felt: Nei

Vis liste — CMS-sider — Svar

ApiResponse_list_PageSummaryData__ · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
dataArray <PageSummaryData > Obligatorisk

Eksempel på svar · ApiResponse_list_PageSummaryData__.

Eksempel: [{"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 Obligatorisk

Svarmetadata.

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

Ytterligere felt: Nei

Hent — CMS-sider — Svar

ApiResponse_PageDetailData_ · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
dataPageDetailData Obligatorisk

Eksempel på svar · PageDetailData.

Eksempel: {"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 Obligatorisk

Svarmetadata.

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

Ytterligere felt: Nei

Opprett — CMS-sider — Forespørselsinnhold

PageCreate · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
body_htmlStreng nullValgfritt

Sidens innhold i HTML.

Streng:maxLength: 100000
market_idsArray <Streng> Valgfritt

Identifikatorer for valgte markeder.

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

Om ressursen gjelder alle eller utvalgte markeder.

Begrensninger
enum
["all", "selected"]
meta_descriptionStreng nullValgfritt

Søkemotorbeskrivelse på valgt språk.

Streng:maxLength: 160
meta_keywordsArray <Streng> nullValgfritt

Søkemotornøkkelord på valgt språk.

Array:maxItems: 20
Array / Array:maxLength: 60
meta_titleStreng nullValgfritt

Søkemotortittel på valgt språk.

Streng:maxLength: 70
publishedBoolsk verdiValgfritt

Om ressursen er publisert.

Standard: false
slugStreng nullValgfritt

URL-stisegment på valgt språk.

Streng:maxLength: 160
titleStrengObligatorisk

Tittel på valgt språk.

minLength: 1maxLength: 300
Eksempel: "Example"

Ytterligere felt: Nei

Hent — CMS-sider — Svar

PageDetailData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
body_htmlStreng nullObligatorisk

Sidens innhold i HTML.

Eksempel: "<p>Example</p>"
created_atStrengObligatorisk

Opprettelsestidspunkt.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
idStrengObligatorisk

Ressursidentifikator; behold den slik den returneres. (PageDetailData).

Eksempel: "example"
is_availableBoolsk verdiObligatorisk

Om varen er tilgjengelig i denne konteksten.

Eksempel: true
market_scopeStrengObligatorisk

Om ressursen gjelder alle eller utvalgte markeder.

Begrensninger
enum
["all", "selected"]
Eksempel: "all"
meta_descriptionStreng nullObligatorisk

Søkemotorbeskrivelse på valgt språk.

Eksempel: "example"
meta_keywordsArray <Streng> nullObligatorisk

Søkemotornøkkelord på valgt språk.

Eksempel: ["example"]
meta_titleStreng nullObligatorisk

Søkemotortittel på valgt språk.

Eksempel: "example"
numberStrengObligatorisk

Ordre- eller saksnummer beregnet på mennesker.

Eksempel: "example"
publishedBoolsk verdiObligatorisk

Om ressursen er publisert.

Eksempel: false
slugStreng nullObligatorisk

URL-stisegment på valgt språk.

Eksempel: "example"
titleStreng nullObligatorisk

Tittel på valgt språk.

Eksempel: "example"
updated_atStrengObligatorisk

Tidspunkt for siste oppdatering.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
versionHeltallObligatorisk

Ressursversjon brukt til samtidighetskontroll.

Eksempel: 1

Ytterligere felt: Nei

Vis liste — CMS-sider — Svar

PageSummaryData · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
created_atStrengObligatorisk

Opprettelsestidspunkt.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
idStrengObligatorisk

Ressursidentifikator; behold den slik den returneres. (PageSummaryData).

Eksempel: "example"
is_availableBoolsk verdiObligatorisk

Om varen er tilgjengelig i denne konteksten.

Eksempel: true
market_scopeStrengObligatorisk

Om ressursen gjelder alle eller utvalgte markeder.

Begrensninger
enum
["all", "selected"]
Eksempel: "all"
numberStrengObligatorisk

Ordre- eller saksnummer beregnet på mennesker.

Eksempel: "example"
publishedBoolsk verdiObligatorisk

Om ressursen er publisert.

Eksempel: false
slugStreng nullObligatorisk

URL-stisegment på valgt språk.

Eksempel: "example"
titleStreng nullObligatorisk

Tittel på valgt språk.

Eksempel: "example"
updated_atStrengObligatorisk

Tidspunkt for siste oppdatering.

format: "date-time"
Eksempel: "2026-01-01T12:00:00Z"
versionHeltallObligatorisk

Ressursversjon brukt til samtidighetskontroll.

Eksempel: 1

Ytterligere felt: Nei

Oppdater — CMS-sider — Forespørselsinnhold

PageUpdate · Felter, typer og begrensninger for data som API-et mottar eller returnerer.
body_htmlStreng nullValgfritt

Sidens innhold i HTML.

Streng:maxLength: 100000
expected_versionHeltallObligatorisk

Versjon lest før skriveoperasjonen; et avvik avviser oppdateringen.

minimum: 1maximum: 2147483647
Eksempel: 1
market_idsArray <Streng> Valgfritt

Identifikatorer for valgte markeder.

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

Om ressursen gjelder alle eller utvalgte markeder.

Begrensninger
enum
["all", "selected"]
meta_descriptionStreng nullValgfritt

Søkemotorbeskrivelse på valgt språk.

Streng:maxLength: 160
meta_keywordsArray <Streng> nullValgfritt

Søkemotornøkkelord på valgt språk.

Array:maxItems: 20
Array / Array:maxLength: 60
meta_titleStreng nullValgfritt

Søkemotortittel på valgt språk.

Streng:maxLength: 70
publishedBoolsk verdiValgfritt

Om ressursen er publisert.

slugStreng nullValgfritt

URL-stisegment på valgt språk.

Streng:maxLength: 160
titleStreng nullValgfritt

Tittel på valgt språk.

Streng:maxLength: 300
Eksempel: "Example"

Ytterligere felt: Nei