Gå til indhold
ShopentlyLearn

Dataskemaer: CMS-sider

Dataskemaer: CMS-sider. Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.

Dataskemaer

Svarmetadata

AnalyticsPageMeta · Skema · Dataskemaer: CMS-sider
paginationPagination Obligatorisk

Metadata for markørbaseret sideinddeling.

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

Rapporteringsperiode og dens grænser.

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

Sagsidentifikator; i svarmetadata identificerer den HTTP-forespørgslen.

minLength: 1maxLength: 100
Eksempel: "example"

Yderligere felter: Nej

Vis liste — CMS-sider — Svar

ApiResponse_list_PageSummaryData__ · Felter, typer og begrænsninger for data, som API'et modtager 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"}

Yderligere felter: Nej

Hent — CMS-sider — Svar

ApiResponse_PageDetailData_ · Felter, typer og begrænsninger for data, som API'et modtager 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"}

Yderligere felter: Nej

Opret — CMS-sider — Forespørgselsindhold

PageCreate · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
body_htmlStreng nullValgfrit

Sidens indhold i HTML.

Streng:maxLength: 100000
market_idsArray <Streng> Valgfrit

Identifikatorer for valgte markeder.

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

Om ressourcen gælder for alle eller udvalgte markeder.

Begrænsninger
enum
["all", "selected"]
meta_descriptionStreng nullValgfrit

Beskrivelse til søgemaskiner på det valgte sprog.

Streng:maxLength: 160
meta_keywordsArray <Streng> nullValgfrit

Nøgleord til søgemaskiner på det valgte sprog.

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

Titel til søgemaskiner på det valgte sprog.

Streng:maxLength: 70
publishedBoolesk værdiValgfrit

Om ressourcen er offentliggjort.

Standard: false
slugStreng nullValgfrit

URL-stisegment på det valgte sprog.

Streng:maxLength: 160
titleStrengObligatorisk

Titel på det valgte sprog.

minLength: 1maxLength: 300
Eksempel: "Example"

Yderligere felter: Nej

Hent — CMS-sider — Svar

PageDetailData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
body_htmlStreng nullObligatorisk

Sidens indhold i HTML.

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

Oprettelsestidspunkt.

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

Ressourceidentifikator; bevar den som returneret. (PageDetailData).

Eksempel: "example"
is_availableBoolesk værdiObligatorisk

Om varen er tilgængelig i denne kontekst.

Eksempel: true
market_scopeStrengObligatorisk

Om ressourcen gælder for alle eller udvalgte markeder.

Begrænsninger
enum
["all", "selected"]
Eksempel: "all"
meta_descriptionStreng nullObligatorisk

Beskrivelse til søgemaskiner på det valgte sprog.

Eksempel: "example"
meta_keywordsArray <Streng> nullObligatorisk

Nøgleord til søgemaskiner på det valgte sprog.

Eksempel: ["example"]
meta_titleStreng nullObligatorisk

Titel til søgemaskiner på det valgte sprog.

Eksempel: "example"
numberStrengObligatorisk

Ordre- eller sagsnummer beregnet til mennesker.

Eksempel: "example"
publishedBoolesk værdiObligatorisk

Om ressourcen er offentliggjort.

Eksempel: false
slugStreng nullObligatorisk

URL-stisegment på det valgte sprog.

Eksempel: "example"
titleStreng nullObligatorisk

Titel på det valgte sprog.

Eksempel: "example"
updated_atStrengObligatorisk

Tidspunkt for seneste opdatering.

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

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1

Yderligere felter: Nej

Vis liste — CMS-sider — Svar

PageSummaryData · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
created_atStrengObligatorisk

Oprettelsestidspunkt.

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

Ressourceidentifikator; bevar den som returneret. (PageSummaryData).

Eksempel: "example"
is_availableBoolesk værdiObligatorisk

Om varen er tilgængelig i denne kontekst.

Eksempel: true
market_scopeStrengObligatorisk

Om ressourcen gælder for alle eller udvalgte markeder.

Begrænsninger
enum
["all", "selected"]
Eksempel: "all"
numberStrengObligatorisk

Ordre- eller sagsnummer beregnet til mennesker.

Eksempel: "example"
publishedBoolesk værdiObligatorisk

Om ressourcen er offentliggjort.

Eksempel: false
slugStreng nullObligatorisk

URL-stisegment på det valgte sprog.

Eksempel: "example"
titleStreng nullObligatorisk

Titel på det valgte sprog.

Eksempel: "example"
updated_atStrengObligatorisk

Tidspunkt for seneste opdatering.

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

Ressourceversion anvendt til samtidighedskontrol.

Eksempel: 1

Yderligere felter: Nej

Opdater — CMS-sider — Forespørgselsindhold

PageUpdate · Felter, typer og begrænsninger for data, som API'et modtager eller returnerer.
body_htmlStreng nullValgfrit

Sidens indhold i HTML.

Streng:maxLength: 100000
expected_versionHeltalObligatorisk

Version læst før skriveoperationen; uoverensstemmelse afviser opdateringen.

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

Identifikatorer for valgte markeder.

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

Om ressourcen gælder for alle eller udvalgte markeder.

Begrænsninger
enum
["all", "selected"]
meta_descriptionStreng nullValgfrit

Beskrivelse til søgemaskiner på det valgte sprog.

Streng:maxLength: 160
meta_keywordsArray <Streng> nullValgfrit

Nøgleord til søgemaskiner på det valgte sprog.

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

Titel til søgemaskiner på det valgte sprog.

Streng:maxLength: 70
publishedBoolesk værdiValgfrit

Om ressourcen er offentliggjort.

slugStreng nullValgfrit

URL-stisegment på det valgte sprog.

Streng:maxLength: 160
titleStreng nullValgfrit

Titel på det valgte sprog.

Streng:maxLength: 300
Eksempel: "Example"

Yderligere felter: Nej