Siirry sisältöön
ShopentlyLearn

Tietoskeemat: CMS-sivut

Tietoskeemat: CMS-sivut. API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.

Tietoskeemat

Vastauksen metatiedot

AnalyticsPageMeta · Skeema · Tietoskeemat: CMS-sivut
paginationPagination Pakollinen

Kohdistinpohjaisen sivutuksen metatiedot.

Esimerkki: {"has_more":false,"limit":20,"next_cursor":null}
periodAnalyticsPeriodData Pakollinen

Raportointijakso ja sen rajat.

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

Tapauksen tunniste; vastauksen metatiedoissa se yksilöi HTTP-pyynnön.

minLength: 1maxLength: 100
Esimerkki: "example"

Lisäkentät: Ei

Listaa — CMS-sivut — Vastaus

ApiResponse_list_PageSummaryData__ · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.
dataTaulukko <PageSummaryData > Pakollinen

Vastausesimerkki · ApiResponse_list_PageSummaryData__.

Esimerkki: [{"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 Pakollinen

Vastauksen metatiedot.

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

Lisäkentät: Ei

Hae — CMS-sivut — Vastaus

ApiResponse_PageDetailData_ · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.
dataPageDetailData Pakollinen

Vastausesimerkki · PageDetailData.

Esimerkki: {"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 Pakollinen

Vastauksen metatiedot.

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

Lisäkentät: Ei

Luo — CMS-sivut — Pyynnön sisältö

PageCreate · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.
body_htmlMerkkijono nullValinnainen

Sivun HTML-sisältö.

Merkkijono:maxLength: 100000
market_idsTaulukko <Merkkijono> Valinnainen

Valittujen markkina-alueiden tunnisteet.

maxItems: 1000
Taulukko:minLength: 1maxLength: 63
market_scopeMerkkijonoValinnainen

Koskeeko resurssi kaikkia vai valittuja markkina-alueita.

Rajoitukset
enum
["all", "selected"]
meta_descriptionMerkkijono nullValinnainen

Hakukonekuvaus valitulla kielellä.

Merkkijono:maxLength: 160
meta_keywordsTaulukko <Merkkijono> nullValinnainen

Hakukoneavainsanat valitulla kielellä.

Taulukko:maxItems: 20
Taulukko / Taulukko:maxLength: 60
meta_titleMerkkijono nullValinnainen

Hakukoneotsikko valitulla kielellä.

Merkkijono:maxLength: 70
publishedTotuusarvoValinnainen

Onko resurssi julkaistu.

Oletus: false
slugMerkkijono nullValinnainen

URL-polun osa valitulla kielellä.

Merkkijono:maxLength: 160
titleMerkkijonoPakollinen

Otsikko valitulla kielellä.

minLength: 1maxLength: 300
Esimerkki: "Example"

Lisäkentät: Ei

Hae — CMS-sivut — Vastaus

PageDetailData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.
body_htmlMerkkijono nullPakollinen

Sivun HTML-sisältö.

Esimerkki: "<p>Example</p>"
created_atMerkkijonoPakollinen

Luontiajankohta.

format: "date-time"
Esimerkki: "2026-01-01T12:00:00Z"
idMerkkijonoPakollinen

Resurssin tunniste; säilytä se palautetussa muodossa. (PageDetailData).

Esimerkki: "example"
is_availableTotuusarvoPakollinen

Onko kohde saatavilla tässä kontekstissa.

Esimerkki: true
market_scopeMerkkijonoPakollinen

Koskeeko resurssi kaikkia vai valittuja markkina-alueita.

Rajoitukset
enum
["all", "selected"]
Esimerkki: "all"
meta_descriptionMerkkijono nullPakollinen

Hakukonekuvaus valitulla kielellä.

Esimerkki: "example"
meta_keywordsTaulukko <Merkkijono> nullPakollinen

Hakukoneavainsanat valitulla kielellä.

Esimerkki: ["example"]
meta_titleMerkkijono nullPakollinen

Hakukoneotsikko valitulla kielellä.

Esimerkki: "example"
numberMerkkijonoPakollinen

Ihmiselle tarkoitettu tilaus- tai tapausnumero.

Esimerkki: "example"
publishedTotuusarvoPakollinen

Onko resurssi julkaistu.

Esimerkki: false
slugMerkkijono nullPakollinen

URL-polun osa valitulla kielellä.

Esimerkki: "example"
titleMerkkijono nullPakollinen

Otsikko valitulla kielellä.

Esimerkki: "example"
updated_atMerkkijonoPakollinen

Viimeisimmän päivityksen ajankohta.

format: "date-time"
Esimerkki: "2026-01-01T12:00:00Z"
versionKokonaislukuPakollinen

Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 1

Lisäkentät: Ei

Listaa — CMS-sivut — Vastaus

PageSummaryData · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.
created_atMerkkijonoPakollinen

Luontiajankohta.

format: "date-time"
Esimerkki: "2026-01-01T12:00:00Z"
idMerkkijonoPakollinen

Resurssin tunniste; säilytä se palautetussa muodossa. (PageSummaryData).

Esimerkki: "example"
is_availableTotuusarvoPakollinen

Onko kohde saatavilla tässä kontekstissa.

Esimerkki: true
market_scopeMerkkijonoPakollinen

Koskeeko resurssi kaikkia vai valittuja markkina-alueita.

Rajoitukset
enum
["all", "selected"]
Esimerkki: "all"
numberMerkkijonoPakollinen

Ihmiselle tarkoitettu tilaus- tai tapausnumero.

Esimerkki: "example"
publishedTotuusarvoPakollinen

Onko resurssi julkaistu.

Esimerkki: false
slugMerkkijono nullPakollinen

URL-polun osa valitulla kielellä.

Esimerkki: "example"
titleMerkkijono nullPakollinen

Otsikko valitulla kielellä.

Esimerkki: "example"
updated_atMerkkijonoPakollinen

Viimeisimmän päivityksen ajankohta.

format: "date-time"
Esimerkki: "2026-01-01T12:00:00Z"
versionKokonaislukuPakollinen

Samanaikaisuuden hallintaan käytetty resurssiversio.

Esimerkki: 1

Lisäkentät: Ei

Päivitä — CMS-sivut — Pyynnön sisältö

PageUpdate · API:n vastaanottamien tai palauttamien tietojen kentät, tyypit ja rajoitukset.
body_htmlMerkkijono nullValinnainen

Sivun HTML-sisältö.

Merkkijono:maxLength: 100000
expected_versionKokonaislukuPakollinen

Ennen kirjoitusta luettu versio; ristiriita hylkää päivityksen.

minimum: 1maximum: 2147483647
Esimerkki: 1
market_idsTaulukko <Merkkijono> Valinnainen

Valittujen markkina-alueiden tunnisteet.

maxItems: 1000
Taulukko:minLength: 1maxLength: 63
market_scopeMerkkijonoValinnainen

Koskeeko resurssi kaikkia vai valittuja markkina-alueita.

Rajoitukset
enum
["all", "selected"]
meta_descriptionMerkkijono nullValinnainen

Hakukonekuvaus valitulla kielellä.

Merkkijono:maxLength: 160
meta_keywordsTaulukko <Merkkijono> nullValinnainen

Hakukoneavainsanat valitulla kielellä.

Taulukko:maxItems: 20
Taulukko / Taulukko:maxLength: 60
meta_titleMerkkijono nullValinnainen

Hakukoneotsikko valitulla kielellä.

Merkkijono:maxLength: 70
publishedTotuusarvoValinnainen

Onko resurssi julkaistu.

slugMerkkijono nullValinnainen

URL-polun osa valitulla kielellä.

Merkkijono:maxLength: 160
titleMerkkijono nullValinnainen

Otsikko valitulla kielellä.

Merkkijono:maxLength: 300
Esimerkki: "Example"

Lisäkentät: Ei