Pereiti prie turinio
ShopentlyLearn

Duomenų schemos: CMS puslapiai

Duomenų schemos: CMS puslapiai. API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.

Duomenų schemos

Atsakymo metaduomenys

AnalyticsPageMeta · Schema · Duomenų schemos: CMS puslapiai
paginationPagination Privalomas

Skaidymo į puslapius pagal žymeklį metaduomenys.

Pavyzdys: {"has_more":false,"limit":20,"next_cursor":null}
periodAnalyticsPeriodData Privalomas

Ataskaitos laikotarpis ir jo ribos.

Pavyzdys: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idEilutėPrivalomas

Prašymo identifikatorius; atsakymo metaduomenyse nurodo HTTP užklausą.

minLength: 1maxLength: 100
Pavyzdys: "example"

Papildomi laukai: Ne

Sąrašas — CMS puslapiai — Atsakymas

ApiResponse_list_PageSummaryData__ · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
dataMasyvas <PageSummaryData > Privalomas

Atsakymo pavyzdys · ApiResponse_list_PageSummaryData__.

Pavyzdys: [{"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 Privalomas

Atsakymo metaduomenys.

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

Papildomi laukai: Ne

Gauti — CMS puslapiai — Atsakymas

ApiResponse_PageDetailData_ · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
dataPageDetailData Privalomas

Atsakymo pavyzdys · PageDetailData.

Pavyzdys: {"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 Privalomas

Atsakymo metaduomenys.

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

Papildomi laukai: Ne

Sukurti — CMS puslapiai — Užklausos turinys

PageCreate · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
body_htmlEilutė nullNeprivalomas

Puslapio turinys HTML formatu.

Eilutė:maxLength: 100000
market_idsMasyvas <Eilutė> Neprivalomas

Pasirinktų rinkų identifikatoriai.

maxItems: 1000
Masyvas:minLength: 1maxLength: 63
market_scopeEilutėNeprivalomas

Ar išteklius taikomas visoms, ar pasirinktoms rinkoms.

Apribojimai
enum
["all", "selected"]
meta_descriptionEilutė nullNeprivalomas

Aprašymas paieškos sistemoms pasirinkta kalba.

Eilutė:maxLength: 160
meta_keywordsMasyvas <Eilutė> nullNeprivalomas

Raktažodžiai paieškos sistemoms pasirinkta kalba.

Masyvas:maxItems: 20
Masyvas / Masyvas:maxLength: 60
meta_titleEilutė nullNeprivalomas

Antraštė paieškos sistemoms pasirinkta kalba.

Eilutė:maxLength: 70
publishedLoginė reikšmėNeprivalomas

Ar išteklius paskelbtas.

Numatytoji reikšmė: false
slugEilutė nullNeprivalomas

URL kelio segmentas pasirinkta kalba.

Eilutė:maxLength: 160
titleEilutėPrivalomas

Pavadinimas pasirinkta kalba.

minLength: 1maxLength: 300
Pavyzdys: "Example"

Papildomi laukai: Ne

Gauti — CMS puslapiai — Atsakymas

PageDetailData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
body_htmlEilutė nullPrivalomas

Puslapio turinys HTML formatu.

Pavyzdys: "<p>Example</p>"
created_atEilutėPrivalomas

Sukūrimo laikas.

format: "date-time"
Pavyzdys: "2026-01-01T12:00:00Z"
idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. (PageDetailData).

Pavyzdys: "example"
is_availableLoginė reikšmėPrivalomas

Ar elementas prieinamas šiame kontekste.

Pavyzdys: true
market_scopeEilutėPrivalomas

Ar išteklius taikomas visoms, ar pasirinktoms rinkoms.

Apribojimai
enum
["all", "selected"]
Pavyzdys: "all"
meta_descriptionEilutė nullPrivalomas

Aprašymas paieškos sistemoms pasirinkta kalba.

Pavyzdys: "example"
meta_keywordsMasyvas <Eilutė> nullPrivalomas

Raktažodžiai paieškos sistemoms pasirinkta kalba.

Pavyzdys: ["example"]
meta_titleEilutė nullPrivalomas

Antraštė paieškos sistemoms pasirinkta kalba.

Pavyzdys: "example"
numberEilutėPrivalomas

Žmogui rodomas užsakymo arba prašymo numeris.

Pavyzdys: "example"
publishedLoginė reikšmėPrivalomas

Ar išteklius paskelbtas.

Pavyzdys: false
slugEilutė nullPrivalomas

URL kelio segmentas pasirinkta kalba.

Pavyzdys: "example"
titleEilutė nullPrivalomas

Pavadinimas pasirinkta kalba.

Pavyzdys: "example"
updated_atEilutėPrivalomas

Paskutinio atnaujinimo laikas.

format: "date-time"
Pavyzdys: "2026-01-01T12:00:00Z"
versionSveikasis skaičiusPrivalomas

Ištekliaus versija lygiagrečių pakeitimų kontrolei.

Pavyzdys: 1

Papildomi laukai: Ne

Sąrašas — CMS puslapiai — Atsakymas

PageSummaryData · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
created_atEilutėPrivalomas

Sukūrimo laikas.

format: "date-time"
Pavyzdys: "2026-01-01T12:00:00Z"
idEilutėPrivalomas

Ištekliaus identifikatorius; išsaugokite grąžintą išraišką. (PageSummaryData).

Pavyzdys: "example"
is_availableLoginė reikšmėPrivalomas

Ar elementas prieinamas šiame kontekste.

Pavyzdys: true
market_scopeEilutėPrivalomas

Ar išteklius taikomas visoms, ar pasirinktoms rinkoms.

Apribojimai
enum
["all", "selected"]
Pavyzdys: "all"
numberEilutėPrivalomas

Žmogui rodomas užsakymo arba prašymo numeris.

Pavyzdys: "example"
publishedLoginė reikšmėPrivalomas

Ar išteklius paskelbtas.

Pavyzdys: false
slugEilutė nullPrivalomas

URL kelio segmentas pasirinkta kalba.

Pavyzdys: "example"
titleEilutė nullPrivalomas

Pavadinimas pasirinkta kalba.

Pavyzdys: "example"
updated_atEilutėPrivalomas

Paskutinio atnaujinimo laikas.

format: "date-time"
Pavyzdys: "2026-01-01T12:00:00Z"
versionSveikasis skaičiusPrivalomas

Ištekliaus versija lygiagrečių pakeitimų kontrolei.

Pavyzdys: 1

Papildomi laukai: Ne

Atnaujinti — CMS puslapiai — Užklausos turinys

PageUpdate · API priimamų arba grąžinamų duomenų laukai, tipai ir apribojimai.
body_htmlEilutė nullNeprivalomas

Puslapio turinys HTML formatu.

Eilutė:maxLength: 100000
expected_versionSveikasis skaičiusPrivalomas

Prieš įrašant perskaityta versija; neatitikimas atmeta pakeitimą.

minimum: 1maximum: 2147483647
Pavyzdys: 1
market_idsMasyvas <Eilutė> Neprivalomas

Pasirinktų rinkų identifikatoriai.

maxItems: 1000
Masyvas:minLength: 1maxLength: 63
market_scopeEilutėNeprivalomas

Ar išteklius taikomas visoms, ar pasirinktoms rinkoms.

Apribojimai
enum
["all", "selected"]
meta_descriptionEilutė nullNeprivalomas

Aprašymas paieškos sistemoms pasirinkta kalba.

Eilutė:maxLength: 160
meta_keywordsMasyvas <Eilutė> nullNeprivalomas

Raktažodžiai paieškos sistemoms pasirinkta kalba.

Masyvas:maxItems: 20
Masyvas / Masyvas:maxLength: 60
meta_titleEilutė nullNeprivalomas

Antraštė paieškos sistemoms pasirinkta kalba.

Eilutė:maxLength: 70
publishedLoginė reikšmėNeprivalomas

Ar išteklius paskelbtas.

slugEilutė nullNeprivalomas

URL kelio segmentas pasirinkta kalba.

Eilutė:maxLength: 160
titleEilutė nullNeprivalomas

Pavadinimas pasirinkta kalba.

Eilutė:maxLength: 300
Pavyzdys: "Example"

Papildomi laukai: Ne