Preskočiť na obsah
ShopentlyLearn

Dátové schémy: Stránky CMS

Dátové schémy: Stránky CMS. Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

Dátové schémy

Metaúdaje odpovede

AnalyticsPageMeta · Schéma · Dátové schémy: Stránky CMS
paginationPagination Povinné

Metaúdaje stránkovania pomocou kurzora.

Príklad: {"has_more":false,"limit":20,"next_cursor":null}
periodAnalyticsPeriodData Povinné

Obdobie prehľadu a jeho hranice.

Príklad: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idReťazecPovinné

Identifikátor požiadavky; v metaúdajoch odpovede označuje požiadavku HTTP.

minLength: 1maxLength: 100
Príklad: "example"

Ďalšie polia: Nie

Zobraziť zoznam — Stránky CMS — Odpoveď

ApiResponse_list_PageSummaryData__ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
dataPole <PageSummaryData > Povinné

Príklad odpovede · ApiResponse_list_PageSummaryData__.

Príklad: [{"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 Povinné

Metaúdaje odpovede.

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

Ďalšie polia: Nie

Načítať — Stránky CMS — Odpoveď

ApiResponse_PageDetailData_ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
dataPageDetailData Povinné

Príklad odpovede · PageDetailData.

Príklad: {"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 Povinné

Metaúdaje odpovede.

Príklad: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Ďalšie polia: Nie

Vytvoriť — Stránky CMS — Telo požiadavky

PageCreate · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
body_htmlReťazec nullVoliteľné

Obsah stránky vo formáte HTML.

Reťazec:maxLength: 100000
market_idsPole <Reťazec> Voliteľné

Identifikátory vybraných trhov.

maxItems: 1000
Pole:minLength: 1maxLength: 63
market_scopeReťazecVoliteľné

Či zdroj platí pre všetky alebo len vybrané trhy.

Obmedzenia
enum
["all", "selected"]
meta_descriptionReťazec nullVoliteľné

Opis pre vyhľadávače vo vybranom jazyku.

Reťazec:maxLength: 160
meta_keywordsPole <Reťazec> nullVoliteľné

Kľúčové slová pre vyhľadávače vo vybranom jazyku.

Pole:maxItems: 20
Pole / Pole:maxLength: 60
meta_titleReťazec nullVoliteľné

Titulok pre vyhľadávače vo vybranom jazyku.

Reťazec:maxLength: 70
publishedLogická hodnotaVoliteľné

Či je zdroj zverejnený.

Predvolená hodnota: false
slugReťazec nullVoliteľné

Úsek cesty URL vo vybranom jazyku.

Reťazec:maxLength: 160
titleReťazecPovinné

Názov vo vybranom jazyku.

minLength: 1maxLength: 300
Príklad: "Example"

Ďalšie polia: Nie

Načítať — Stránky CMS — Odpoveď

PageDetailData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
body_htmlReťazec nullPovinné

Obsah stránky vo formáte HTML.

Príklad: "<p>Example</p>"
created_atReťazecPovinné

Čas vytvorenia.

format: "date-time"
Príklad: "2026-01-01T12:00:00Z"
idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (PageDetailData).

Príklad: "example"
is_availableLogická hodnotaPovinné

Či je položka v tomto kontexte dostupná.

Príklad: true
market_scopeReťazecPovinné

Či zdroj platí pre všetky alebo len vybrané trhy.

Obmedzenia
enum
["all", "selected"]
Príklad: "all"
meta_descriptionReťazec nullPovinné

Opis pre vyhľadávače vo vybranom jazyku.

Príklad: "example"
meta_keywordsPole <Reťazec> nullPovinné

Kľúčové slová pre vyhľadávače vo vybranom jazyku.

Príklad: ["example"]
meta_titleReťazec nullPovinné

Titulok pre vyhľadávače vo vybranom jazyku.

Príklad: "example"
numberReťazecPovinné

Číslo objednávky alebo zákazníckej žiadosti určené pre používateľa.

Príklad: "example"
publishedLogická hodnotaPovinné

Či je zdroj zverejnený.

Príklad: false
slugReťazec nullPovinné

Úsek cesty URL vo vybranom jazyku.

Príklad: "example"
titleReťazec nullPovinné

Názov vo vybranom jazyku.

Príklad: "example"
updated_atReťazecPovinné

Čas poslednej aktualizácie.

format: "date-time"
Príklad: "2026-01-01T12:00:00Z"
versionCelé čísloPovinné

Verzia zdroja používaná na riadenie súbežných zmien.

Príklad: 1

Ďalšie polia: Nie

Zobraziť zoznam — Stránky CMS — Odpoveď

PageSummaryData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
created_atReťazecPovinné

Čas vytvorenia.

format: "date-time"
Príklad: "2026-01-01T12:00:00Z"
idReťazecPovinné

Identifikátor zdroja; zachovajte ho v podobe, v akej bol vrátený. (PageSummaryData).

Príklad: "example"
is_availableLogická hodnotaPovinné

Či je položka v tomto kontexte dostupná.

Príklad: true
market_scopeReťazecPovinné

Či zdroj platí pre všetky alebo len vybrané trhy.

Obmedzenia
enum
["all", "selected"]
Príklad: "all"
numberReťazecPovinné

Číslo objednávky alebo zákazníckej žiadosti určené pre používateľa.

Príklad: "example"
publishedLogická hodnotaPovinné

Či je zdroj zverejnený.

Príklad: false
slugReťazec nullPovinné

Úsek cesty URL vo vybranom jazyku.

Príklad: "example"
titleReťazec nullPovinné

Názov vo vybranom jazyku.

Príklad: "example"
updated_atReťazecPovinné

Čas poslednej aktualizácie.

format: "date-time"
Príklad: "2026-01-01T12:00:00Z"
versionCelé čísloPovinné

Verzia zdroja používaná na riadenie súbežných zmien.

Príklad: 1

Ďalšie polia: Nie

Upraviť — Stránky CMS — Telo požiadavky

PageUpdate · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
body_htmlReťazec nullVoliteľné

Obsah stránky vo formáte HTML.

Reťazec:maxLength: 100000
expected_versionCelé čísloPovinné

Verzia načítaná pred zápisom; pri nezhode sa aktualizácia odmietne.

minimum: 1maximum: 2147483647
Príklad: 1
market_idsPole <Reťazec> Voliteľné

Identifikátory vybraných trhov.

maxItems: 1000
Pole:minLength: 1maxLength: 63
market_scopeReťazecVoliteľné

Či zdroj platí pre všetky alebo len vybrané trhy.

Obmedzenia
enum
["all", "selected"]
meta_descriptionReťazec nullVoliteľné

Opis pre vyhľadávače vo vybranom jazyku.

Reťazec:maxLength: 160
meta_keywordsPole <Reťazec> nullVoliteľné

Kľúčové slová pre vyhľadávače vo vybranom jazyku.

Pole:maxItems: 20
Pole / Pole:maxLength: 60
meta_titleReťazec nullVoliteľné

Titulok pre vyhľadávače vo vybranom jazyku.

Reťazec:maxLength: 70
publishedLogická hodnotaVoliteľné

Či je zdroj zverejnený.

slugReťazec nullVoliteľné

Úsek cesty URL vo vybranom jazyku.

Reťazec:maxLength: 160
titleReťazec nullVoliteľné

Názov vo vybranom jazyku.

Reťazec:maxLength: 300
Príklad: "Example"

Ďalšie polia: Nie