Преминете към съдържанието
ShopentlyLearn

Схеми на данните: CMS страници

Схеми на данните: CMS страници. Полета, типове и ограничения на данните, приемани или връщани от API.

Схеми на данните

Метаданни на отговора

AnalyticsPageMeta · Схема · Схеми на данните: CMS страници
paginationPagination Задължително

Метаданни за страниране с cursor.

Пример: {"has_more":false,"limit":20,"next_cursor":null}
periodAnalyticsPeriodData Задължително

Отчетен период и неговите граници.

Пример: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}
request_idНизЗадължително

Идентификатор на искането; в метаданните на отговора идентифицира HTTP заявката.

minLength: 1maxLength: 100
Пример: "example"

Допълнителни полета: Не

Списък — CMS страници — Отговор

ApiResponse_list_PageSummaryData__ · Полета, типове и ограничения на данните, приемани или връщани от API.
dataМасив <PageSummaryData > Задължително

Примерен отговор · ApiResponse_list_PageSummaryData__.

Пример: [{"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 Задължително

Метаданни на отговора.

Пример: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Допълнителни полета: Не

Получаване — CMS страници — Отговор

ApiResponse_PageDetailData_ · Полета, типове и ограничения на данните, приемани или връщани от API.
dataPageDetailData Задължително

Примерен отговор · PageDetailData.

Пример: {"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 Задължително

Метаданни на отговора.

Пример: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

Допълнителни полета: Не

Създаване — CMS страници — Тяло на заявката

PageCreate · Полета, типове и ограничения на данните, приемани или връщани от API.
body_htmlНиз nullНезадължително

Съдържание на страницата в HTML.

Низ:maxLength: 100000
market_idsМасив <Низ> Незадължително

Идентификатори на избраните пазари.

maxItems: 1000
Масив:minLength: 1maxLength: 63
market_scopeНизНезадължително

Дали ресурсът се отнася за всички или за избрани пазари.

Ограничения
enum
["all", "selected"]
meta_descriptionНиз nullНезадължително

Описание за търсачки на избрания език.

Низ:maxLength: 160
meta_keywordsМасив <Низ> nullНезадължително

Ключови думи за търсачки на избрания език.

Масив:maxItems: 20
Масив / Масив:maxLength: 60
meta_titleНиз nullНезадължително

Заглавие за търсачки на избрания език.

Низ:maxLength: 70
publishedБулева стойностНезадължително

Дали ресурсът е публикуван.

По подразбиране: false
slugНиз nullНезадължително

Сегмент от URL пътя на избрания език.

Низ:maxLength: 160
titleНизЗадължително

Заглавие на избрания език.

minLength: 1maxLength: 300
Пример: "Example"

Допълнителни полета: Не

Получаване — CMS страници — Отговор

PageDetailData · Полета, типове и ограничения на данните, приемани или връщани от API.
body_htmlНиз nullЗадължително

Съдържание на страницата в HTML.

Пример: "<p>Example</p>"
created_atНизЗадължително

Време на създаване.

format: "date-time"
Пример: "2026-01-01T12:00:00Z"
idНизЗадължително

Идентификатор на ресурса; запазете го във върнатия вид. (PageDetailData).

Пример: "example"
is_availableБулева стойностЗадължително

Дали артикулът е наличен в този контекст.

Пример: true
market_scopeНизЗадължително

Дали ресурсът се отнася за всички или за избрани пазари.

Ограничения
enum
["all", "selected"]
Пример: "all"
meta_descriptionНиз nullЗадължително

Описание за търсачки на избрания език.

Пример: "example"
meta_keywordsМасив <Низ> nullЗадължително

Ключови думи за търсачки на избрания език.

Пример: ["example"]
meta_titleНиз nullЗадължително

Заглавие за търсачки на избрания език.

Пример: "example"
numberНизЗадължително

Номер на поръчката или искането, предназначен за потребителя.

Пример: "example"
publishedБулева стойностЗадължително

Дали ресурсът е публикуван.

Пример: false
slugНиз nullЗадължително

Сегмент от URL пътя на избрания език.

Пример: "example"
titleНиз nullЗадължително

Заглавие на избрания език.

Пример: "example"
updated_atНизЗадължително

Време на последната актуализация.

format: "date-time"
Пример: "2026-01-01T12:00:00Z"
versionЦяло числоЗадължително

Версия на ресурса за контрол на едновременни записи.

Пример: 1

Допълнителни полета: Не

Списък — CMS страници — Отговор

PageSummaryData · Полета, типове и ограничения на данните, приемани или връщани от API.
created_atНизЗадължително

Време на създаване.

format: "date-time"
Пример: "2026-01-01T12:00:00Z"
idНизЗадължително

Идентификатор на ресурса; запазете го във върнатия вид. (PageSummaryData).

Пример: "example"
is_availableБулева стойностЗадължително

Дали артикулът е наличен в този контекст.

Пример: true
market_scopeНизЗадължително

Дали ресурсът се отнася за всички или за избрани пазари.

Ограничения
enum
["all", "selected"]
Пример: "all"
numberНизЗадължително

Номер на поръчката или искането, предназначен за потребителя.

Пример: "example"
publishedБулева стойностЗадължително

Дали ресурсът е публикуван.

Пример: false
slugНиз nullЗадължително

Сегмент от URL пътя на избрания език.

Пример: "example"
titleНиз nullЗадължително

Заглавие на избрания език.

Пример: "example"
updated_atНизЗадължително

Време на последната актуализация.

format: "date-time"
Пример: "2026-01-01T12:00:00Z"
versionЦяло числоЗадължително

Версия на ресурса за контрол на едновременни записи.

Пример: 1

Допълнителни полета: Не

Промяна — CMS страници — Тяло на заявката

PageUpdate · Полета, типове и ограничения на данните, приемани или връщани от API.
body_htmlНиз nullНезадължително

Съдържание на страницата в HTML.

Низ:maxLength: 100000
expected_versionЦяло числоЗадължително

Версията, прочетена преди записа; несъответствие отхвърля актуализацията.

minimum: 1maximum: 2147483647
Пример: 1
market_idsМасив <Низ> Незадължително

Идентификатори на избраните пазари.

maxItems: 1000
Масив:minLength: 1maxLength: 63
market_scopeНизНезадължително

Дали ресурсът се отнася за всички или за избрани пазари.

Ограничения
enum
["all", "selected"]
meta_descriptionНиз nullНезадължително

Описание за търсачки на избрания език.

Низ:maxLength: 160
meta_keywordsМасив <Низ> nullНезадължително

Ключови думи за търсачки на избрания език.

Масив:maxItems: 20
Масив / Масив:maxLength: 60
meta_titleНиз nullНезадължително

Заглавие за търсачки на избрания език.

Низ:maxLength: 70
publishedБулева стойностНезадължително

Дали ресурсът е публикуван.

slugНиз nullНезадължително

Сегмент от URL пътя на избрания език.

Низ:maxLength: 160
titleНиз nullНезадължително

Заглавие на избрания език.

Низ:maxLength: 300
Пример: "Example"

Допълнителни полета: Не