Схеми даних: Категорії

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

Схеми даних

Отримати — Категорії — Відповідь

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

dataCategoryDetailData Обов’язкове: Приклад відповіді · CategoryDetailData.

Приклад: {"created_at":"2026-01-01T12:00:00Z","description":"example","id":"example","introduction":"example","is_available":true,"is_visible":false,"meta_description":"example","meta_keywords":["example"],"meta_title":"example","name":"Example","number":"example","parent_id":null,"slug":"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"}

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

Отримати список — Категорії — Відповідь

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

dataМасив <CategorySummaryData > Обов’язкове: Приклад відповіді · ApiResponse_list_CategorySummaryData__.

Приклад: [{"created_at":"2026-01-01T12:00:00Z","id":"example","is_available":true,"is_visible":false,"name":"Example","number":"example","parent_id":null,"slug":"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"}

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

Створити — Категорії — Тіло запиту

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

descriptionРядок nullНеобов’язкове: Опис вибраною мовою.

Рядок:maxLength: 50000
introductionРядок nullНеобов’язкове: Вступний текст вибраною мовою.

Рядок:maxLength: 5000
is_visibleЛогічне значенняНеобов’язкове: Чи є ресурс видимим.

За замовчуванням: false
market_idsМасив <Рядок> Необов’язкове: Ідентифікатори вибраних ринків.

maxItems: 1000
Масив:minLength: 1maxLength: 63
meta_descriptionРядок nullНеобов’язкове: Опис для пошукових систем вибраною мовою.

Рядок:maxLength: 160
meta_keywordsМасив <Рядок> nullНеобов’язкове: Ключові слова для пошукових систем вибраною мовою.

Масив:maxItems: 20
Масив / Масив:maxLength: 50
meta_titleРядок nullНеобов’язкове: Заголовок для пошукових систем вибраною мовою.

Рядок:maxLength: 70
nameРядокОбов’язкове: Назва ресурсу у відповідному контексті.

minLength: 1maxLength: 200

Приклад: "Example"
parent_idРядок nullНеобов’язкове: Ідентифікатор батьківської категорії.

Рядок:minLength: 1maxLength: 63
slugРядок nullНеобов’язкове: Сегмент шляху URL вибраною мовою.

Рядок:maxLength: 160

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

Отримати — Категорії — Відповідь

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

created_atРядокОбов’язкове: Час створення.

format: "date-time"

Приклад: "2026-01-01T12:00:00Z"
descriptionРядок nullОбов’язкове: Опис вибраною мовою.

Приклад: "example"
idРядокОбов’язкове: Ідентифікатор ресурсу; зберігайте його в отриманому вигляді. (CategoryDetailData).

Приклад: "example"
introductionРядок nullОбов’язкове: Вступний текст вибраною мовою.

Приклад: "example"
is_availableЛогічне значенняОбов’язкове: Чи доступна позиція в цьому контексті.

Приклад: true
is_visibleЛогічне значенняОбов’язкове: Чи є ресурс видимим.

Приклад: false
meta_descriptionРядок nullОбов’язкове: Опис для пошукових систем вибраною мовою.

Приклад: "example"
meta_keywordsМасив <Рядок> nullОбов’язкове: Ключові слова для пошукових систем вибраною мовою.

Приклад: ["example"]
meta_titleРядок nullОбов’язкове: Заголовок для пошукових систем вибраною мовою.

Приклад: "example"
nameРядок nullОбов’язкове: Назва ресурсу у відповідному контексті.

Приклад: "Example"
numberРядокОбов’язкове: Зрозумілий користувачу номер замовлення або звернення.

Приклад: "example"
parent_idРядок nullОбов’язкове: Ідентифікатор батьківської категорії.

Приклад: null
slugРядок nullОбов’язкове: Сегмент шляху URL вибраною мовою.

Приклад: "example"
updated_atРядокОбов’язкове: Час останнього оновлення.

format: "date-time"

Приклад: "2026-01-01T12:00:00Z"
versionЦіле числоОбов’язкове: Версія ресурсу для контролю одночасних змін.

Приклад: 1

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

Отримати список — Категорії — Відповідь

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

created_atРядокОбов’язкове: Час створення.

format: "date-time"

Приклад: "2026-01-01T12:00:00Z"
idРядокОбов’язкове: Ідентифікатор ресурсу; зберігайте його в отриманому вигляді. (CategorySummaryData).

Приклад: "example"
is_availableЛогічне значенняОбов’язкове: Чи доступна позиція в цьому контексті.

Приклад: true
is_visibleЛогічне значенняОбов’язкове: Чи є ресурс видимим.

Приклад: false
nameРядок nullОбов’язкове: Назва ресурсу у відповідному контексті.

Приклад: "Example"
numberРядокОбов’язкове: Зрозумілий користувачу номер замовлення або звернення.

Приклад: "example"
parent_idРядок nullОбов’язкове: Ідентифікатор батьківської категорії.

Приклад: null
slugРядок nullОбов’язкове: Сегмент шляху URL вибраною мовою.

Приклад: "example"
updated_atРядокОбов’язкове: Час останнього оновлення.

format: "date-time"

Приклад: "2026-01-01T12:00:00Z"
versionЦіле числоОбов’язкове: Версія ресурсу для контролю одночасних змін.

Приклад: 1

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

Оновити — Категорії — Тіло запиту

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

descriptionРядок nullНеобов’язкове: Опис вибраною мовою.

Рядок:maxLength: 50000
expected_versionЦіле числоОбов’язкове: Версія, прочитана перед записом; невідповідність блокує оновлення.

minimum: 1maximum: 9223372036854775807

Приклад: 1
introductionРядок nullНеобов’язкове: Вступний текст вибраною мовою.

Рядок:maxLength: 5000
is_visibleЛогічне значенняНеобов’язкове: Чи є ресурс видимим.
market_idsМасив <Рядок> Необов’язкове: Ідентифікатори вибраних ринків.

maxItems: 1000
Масив:minLength: 1maxLength: 63
meta_descriptionРядок nullНеобов’язкове: Опис для пошукових систем вибраною мовою.

Рядок:maxLength: 160
meta_keywordsМасив <Рядок> nullНеобов’язкове: Ключові слова для пошукових систем вибраною мовою.

Масив:maxItems: 20
Масив / Масив:maxLength: 50
meta_titleРядок nullНеобов’язкове: Заголовок для пошукових систем вибраною мовою.

Рядок:maxLength: 70
nameРядок nullНеобов’язкове: Назва ресурсу у відповідному контексті.

Рядок:maxLength: 200

Приклад: "Example"
parent_idРядок nullНеобов’язкове: Ідентифікатор батьківської категорії.

Рядок:minLength: 1maxLength: 63
slugРядок nullНеобов’язкове: Сегмент шляху URL вибраною мовою.

Рядок:maxLength: 160

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