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

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

Схеми на данните: Категории. Полета, типове и ограничения на данните, приемани или връщани от 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

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