Přejít na obsah
ShopentlyLearn

Datová schémata: Stránky CMS

Datová schémata: Stránky CMS. Pole, typy a omezení dat přijímaných nebo vracených API.

Datová schémata

Metadata odpovědi

AnalyticsPageMeta · Schéma · Datová schémata: Stránky CMS
paginationPagination Povinné

Metadata stránkování pomocí kurzoru.

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

Období přehledu a jeho hranice.

Příklad: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idŘetězecPovinné

Identifikátor požadavku; v metadatech odpovědi označuje požadavek HTTP.

minLength: 1maxLength: 100
Příklad: "example"

Další pole: Ne

Vypsat — Stránky CMS — Odpověď

ApiResponse_list_PageSummaryData__ · Pole, typy a omezení dat přijímaných nebo vracených API.
dataPole <PageSummaryData > Povinné

Příklad odpovědi · ApiResponse_list_PageSummaryData__.

Pří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é

Metadata odpovědi.

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

Další pole: Ne

Načíst — Stránky CMS — Odpověď

ApiResponse_PageDetailData_ · Pole, typy a omezení dat přijímaných nebo vracených API.
dataPageDetailData Povinné

Příklad odpovědi · PageDetailData.

Pří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é

Metadata odpovědi.

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

Další pole: Ne

Vytvořit — Stránky CMS — Tělo požadavku

PageCreate · Pole, typy a omezení dat přijímaných nebo vracených API.
body_htmlŘetězec nullVolitelné

Obsah stránky ve formátu HTML.

Řetězec:maxLength: 100000
market_idsPole <Řetězec> Volitelné

Identifikátory vybraných trhů.

maxItems: 1000
Pole:minLength: 1maxLength: 63
market_scopeŘetězecVolitelné

Zda zdroj platí pro všechny, nebo jen vybrané trhy.

Omezení
enum
["all", "selected"]
meta_descriptionŘetězec nullVolitelné

Popis pro vyhledávače ve vybraném jazyce.

Řetězec:maxLength: 160
meta_keywordsPole <Řetězec> nullVolitelné

Klíčová slova pro vyhledávače ve vybraném jazyce.

Pole:maxItems: 20
Pole / Pole:maxLength: 60
meta_titleŘetězec nullVolitelné

Titulek pro vyhledávače ve vybraném jazyce.

Řetězec:maxLength: 70
publishedLogická hodnotaVolitelné

Zda je zdroj zveřejněn.

Výchozí hodnota: false
slugŘetězec nullVolitelné

Úsek cesty URL ve vybraném jazyce.

Řetězec:maxLength: 160
titleŘetězecPovinné

Název ve vybraném jazyce.

minLength: 1maxLength: 300
Příklad: "Example"

Další pole: Ne

Načíst — Stránky CMS — Odpověď

PageDetailData · Pole, typy a omezení dat přijímaných nebo vracených API.
body_htmlŘetězec nullPovinné

Obsah stránky ve formátu HTML.

Příklad: "<p>Example</p>"
created_atŘetězecPovinné

Čas vytvoření.

format: "date-time"
Příklad: "2026-01-01T12:00:00Z"
idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (PageDetailData).

Příklad: "example"
is_availableLogická hodnotaPovinné

Zda je položka v tomto kontextu dostupná.

Příklad: true
market_scopeŘetězecPovinné

Zda zdroj platí pro všechny, nebo jen vybrané trhy.

Omezení
enum
["all", "selected"]
Příklad: "all"
meta_descriptionŘetězec nullPovinné

Popis pro vyhledávače ve vybraném jazyce.

Příklad: "example"
meta_keywordsPole <Řetězec> nullPovinné

Klíčová slova pro vyhledávače ve vybraném jazyce.

Příklad: ["example"]
meta_titleŘetězec nullPovinné

Titulek pro vyhledávače ve vybraném jazyce.

Příklad: "example"
numberŘetězecPovinné

Číslo objednávky nebo zákaznického požadavku určené pro uživatele.

Příklad: "example"
publishedLogická hodnotaPovinné

Zda je zdroj zveřejněn.

Příklad: false
slugŘetězec nullPovinné

Úsek cesty URL ve vybraném jazyce.

Příklad: "example"
titleŘetězec nullPovinné

Název ve vybraném jazyce.

Příklad: "example"
updated_atŘetězecPovinné

Čas poslední aktualizace.

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

Verze zdroje používaná k řízení souběžných změn.

Příklad: 1

Další pole: Ne

Vypsat — Stránky CMS — Odpověď

PageSummaryData · Pole, typy a omezení dat přijímaných nebo vracených API.
created_atŘetězecPovinné

Čas vytvoření.

format: "date-time"
Příklad: "2026-01-01T12:00:00Z"
idŘetězecPovinné

Identifikátor zdroje; zachovejte jej v podobě, v jaké byl vrácen. (PageSummaryData).

Příklad: "example"
is_availableLogická hodnotaPovinné

Zda je položka v tomto kontextu dostupná.

Příklad: true
market_scopeŘetězecPovinné

Zda zdroj platí pro všechny, nebo jen vybrané trhy.

Omezení
enum
["all", "selected"]
Příklad: "all"
numberŘetězecPovinné

Číslo objednávky nebo zákaznického požadavku určené pro uživatele.

Příklad: "example"
publishedLogická hodnotaPovinné

Zda je zdroj zveřejněn.

Příklad: false
slugŘetězec nullPovinné

Úsek cesty URL ve vybraném jazyce.

Příklad: "example"
titleŘetězec nullPovinné

Název ve vybraném jazyce.

Příklad: "example"
updated_atŘetězecPovinné

Čas poslední aktualizace.

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

Verze zdroje používaná k řízení souběžných změn.

Příklad: 1

Další pole: Ne

Upravit — Stránky CMS — Tělo požadavku

PageUpdate · Pole, typy a omezení dat přijímaných nebo vracených API.
body_htmlŘetězec nullVolitelné

Obsah stránky ve formátu HTML.

Řetězec:maxLength: 100000
expected_versionCelé čísloPovinné

Verze načtená před zápisem; při neshodě se aktualizace odmítne.

minimum: 1maximum: 2147483647
Příklad: 1
market_idsPole <Řetězec> Volitelné

Identifikátory vybraných trhů.

maxItems: 1000
Pole:minLength: 1maxLength: 63
market_scopeŘetězecVolitelné

Zda zdroj platí pro všechny, nebo jen vybrané trhy.

Omezení
enum
["all", "selected"]
meta_descriptionŘetězec nullVolitelné

Popis pro vyhledávače ve vybraném jazyce.

Řetězec:maxLength: 160
meta_keywordsPole <Řetězec> nullVolitelné

Klíčová slova pro vyhledávače ve vybraném jazyce.

Pole:maxItems: 20
Pole / Pole:maxLength: 60
meta_titleŘetězec nullVolitelné

Titulek pro vyhledávače ve vybraném jazyce.

Řetězec:maxLength: 70
publishedLogická hodnotaVolitelné

Zda je zdroj zveřejněn.

slugŘetězec nullVolitelné

Úsek cesty URL ve vybraném jazyce.

Řetězec:maxLength: 160
titleŘetězec nullVolitelné

Název ve vybraném jazyce.

Řetězec:maxLength: 300
Příklad: "Example"

Další pole: Ne