Перейти до вмісту
ShopentlyLearn

Схеми даних: Сторінки CMS

Схеми даних: Сторінки CMS. Поля, типи й обмеження даних, які API приймає або повертає.

Схеми даних

Метадані відповіді

AnalyticsPageMeta · Схема · Схеми даних: Сторінки CMS
paginationPagination Обов’язкове

Метадані пагінації за курсором.

Приклад: {"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"

Додаткові поля: Ні