Pāriet uz saturu
ShopentlyLearn

Datu shēmas: CMS lapas

Datu shēmas: CMS lapas. API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.

Datu shēmas

Atbildes metadati

AnalyticsPageMeta · Shēma · Datu shēmas: CMS lapas
paginationPagination Obligāts

Kursora lapošanas metadati.

Piemērs: {"has_more":false,"limit":20,"next_cursor":null}
periodAnalyticsPeriodData Obligāts

Pārskata periods un tā robežas.

Piemērs: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idVirkneObligāts

Pieteikuma identifikators; atbildes metadatos tas identificē HTTP pieprasījumu.

minLength: 1maxLength: 100
Piemērs: "example"

Papildu lauki: Nē

Saraksts — CMS lapas — Atbilde

ApiResponse_list_PageSummaryData__ · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
dataMasīvs <PageSummaryData > Obligāts

Atbildes piemērs · ApiResponse_list_PageSummaryData__.

Piemērs: [{"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 Obligāts

Atbildes metadati.

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

Papildu lauki: Nē

Iegūt — CMS lapas — Atbilde

ApiResponse_PageDetailData_ · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
dataPageDetailData Obligāts

Atbildes piemērs · PageDetailData.

Piemērs: {"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 Obligāts

Atbildes metadati.

Piemērs: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Papildu lauki: Nē

Izveidot — CMS lapas — Pieprasījuma saturs

PageCreate · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
body_htmlVirkne nullNeobligāts

Lapas saturs HTML formātā.

Virkne:maxLength: 100000
market_idsMasīvs <Virkne> Neobligāts

Izvēlēto tirgu identifikatori.

maxItems: 1000
Masīvs:minLength: 1maxLength: 63
market_scopeVirkneNeobligāts

Vai resurss attiecas uz visiem vai izvēlētiem tirgiem.

Ierobežojumi
enum
["all", "selected"]
meta_descriptionVirkne nullNeobligāts

Meklētājprogrammas apraksts izvēlētajā valodā.

Virkne:maxLength: 160
meta_keywordsMasīvs <Virkne> nullNeobligāts

Meklētājprogrammas atslēgvārdi izvēlētajā valodā.

Masīvs:maxItems: 20
Masīvs / Masīvs:maxLength: 60
meta_titleVirkne nullNeobligāts

Meklētājprogrammas virsraksts izvēlētajā valodā.

Virkne:maxLength: 70
publishedLoģiska vērtībaNeobligāts

Vai resurss ir publicēts.

Noklusējums: false
slugVirkne nullNeobligāts

URL ceļa segments izvēlētajā valodā.

Virkne:maxLength: 160
titleVirkneObligāts

Virsraksts izvēlētajā valodā.

minLength: 1maxLength: 300
Piemērs: "Example"

Papildu lauki: Nē

Iegūt — CMS lapas — Atbilde

PageDetailData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
body_htmlVirkne nullObligāts

Lapas saturs HTML formātā.

Piemērs: "<p>Example</p>"
created_atVirkneObligāts

Izveides laiks.

format: "date-time"
Piemērs: "2026-01-01T12:00:00Z"
idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā. (PageDetailData).

Piemērs: "example"
is_availableLoģiska vērtībaObligāts

Vai vienums ir pieejams šajā kontekstā.

Piemērs: true
market_scopeVirkneObligāts

Vai resurss attiecas uz visiem vai izvēlētiem tirgiem.

Ierobežojumi
enum
["all", "selected"]
Piemērs: "all"
meta_descriptionVirkne nullObligāts

Meklētājprogrammas apraksts izvēlētajā valodā.

Piemērs: "example"
meta_keywordsMasīvs <Virkne> nullObligāts

Meklētājprogrammas atslēgvārdi izvēlētajā valodā.

Piemērs: ["example"]
meta_titleVirkne nullObligāts

Meklētājprogrammas virsraksts izvēlētajā valodā.

Piemērs: "example"
numberVirkneObligāts

Lietotājam paredzēts pasūtījuma vai pieteikuma numurs.

Piemērs: "example"
publishedLoģiska vērtībaObligāts

Vai resurss ir publicēts.

Piemērs: false
slugVirkne nullObligāts

URL ceļa segments izvēlētajā valodā.

Piemērs: "example"
titleVirkne nullObligāts

Virsraksts izvēlētajā valodā.

Piemērs: "example"
updated_atVirkneObligāts

Pēdējās atjaunināšanas laiks.

format: "date-time"
Piemērs: "2026-01-01T12:00:00Z"
versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 1

Papildu lauki: Nē

Saraksts — CMS lapas — Atbilde

PageSummaryData · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
created_atVirkneObligāts

Izveides laiks.

format: "date-time"
Piemērs: "2026-01-01T12:00:00Z"
idVirkneObligāts

Resursa identifikators; saglabājiet to atgrieztajā formā. (PageSummaryData).

Piemērs: "example"
is_availableLoģiska vērtībaObligāts

Vai vienums ir pieejams šajā kontekstā.

Piemērs: true
market_scopeVirkneObligāts

Vai resurss attiecas uz visiem vai izvēlētiem tirgiem.

Ierobežojumi
enum
["all", "selected"]
Piemērs: "all"
numberVirkneObligāts

Lietotājam paredzēts pasūtījuma vai pieteikuma numurs.

Piemērs: "example"
publishedLoģiska vērtībaObligāts

Vai resurss ir publicēts.

Piemērs: false
slugVirkne nullObligāts

URL ceļa segments izvēlētajā valodā.

Piemērs: "example"
titleVirkne nullObligāts

Virsraksts izvēlētajā valodā.

Piemērs: "example"
updated_atVirkneObligāts

Pēdējās atjaunināšanas laiks.

format: "date-time"
Piemērs: "2026-01-01T12:00:00Z"
versionVesels skaitlisObligāts

Resursa versija vienlaicīgu izmaiņu kontrolei.

Piemērs: 1

Papildu lauki: Nē

Atjaunināt — CMS lapas — Pieprasījuma saturs

PageUpdate · API pieņemto vai atgriezto datu lauki, tipi un ierobežojumi.
body_htmlVirkne nullNeobligāts

Lapas saturs HTML formātā.

Virkne:maxLength: 100000
expected_versionVesels skaitlisObligāts

Pirms rakstīšanas nolasītā versija; neatbilstības gadījumā izmaiņa tiek noraidīta.

minimum: 1maximum: 2147483647
Piemērs: 1
market_idsMasīvs <Virkne> Neobligāts

Izvēlēto tirgu identifikatori.

maxItems: 1000
Masīvs:minLength: 1maxLength: 63
market_scopeVirkneNeobligāts

Vai resurss attiecas uz visiem vai izvēlētiem tirgiem.

Ierobežojumi
enum
["all", "selected"]
meta_descriptionVirkne nullNeobligāts

Meklētājprogrammas apraksts izvēlētajā valodā.

Virkne:maxLength: 160
meta_keywordsMasīvs <Virkne> nullNeobligāts

Meklētājprogrammas atslēgvārdi izvēlētajā valodā.

Masīvs:maxItems: 20
Masīvs / Masīvs:maxLength: 60
meta_titleVirkne nullNeobligāts

Meklētājprogrammas virsraksts izvēlētajā valodā.

Virkne:maxLength: 70
publishedLoģiska vērtībaNeobligāts

Vai resurss ir publicēts.

slugVirkne nullNeobligāts

URL ceļa segments izvēlētajā valodā.

Virkne:maxLength: 160
titleVirkne nullNeobligāts

Virsraksts izvēlētajā valodā.

Virkne:maxLength: 300
Piemērs: "Example"

Papildu lauki: Nē