Категории каталога
Этот документ описывает работу с категориями каталога магазина в API Zenky.io.
Используемые структуры
Категория
Во всех ответах методов API, в которых так или иначе присутствует информация о категориях, используется
следующая структура (это относится не только к списку категорий и информации о конкретной категории, но
так же и к полю categories
в информации о товарах):
{
"id": "8ffdf356-faa8-4f3b-9279-5f948b90f62e",
"short_id": "8ffdf356faa80f62",
"parent_id": "",
"hidden": false,
"featured": false,
"slug": "smartfony",
"name": "Смартфоны",
"created_at": {
"timezone": "Asia\/Irkutsk",
"datetime_utc": "2020-03-01 03:00:00",
"datetime": "2020-03-01 11:00:00",
"datetime_at": "01.03.2020 в 11:00",
"date": "01.03.2020",
"diff": "2 года назад",
"timestamp": 1583031600,
"iso_utc": "2020-03-01T03:00:00+00:00",
"iso": "2020-03-01T11:00:00+08:00"
},
"updated_at": {
"timezone": "Asia\/Irkutsk",
"datetime_utc": "2022-03-21 16:07:10",
"datetime": "2022-03-22 00:07:10",
"datetime_at": "22.03.2022 в 00:07",
"date": "22.03.2022",
"diff": "2 дня назад",
"timestamp": 1647878830,
"iso_utc": "2022-03-21T16:07:10+00:00",
"iso": "2022-03-22T00:07:10+08:00"
}
}
Описание полей
Короткие идентификаторы
Категории и товары могут быть запрошены не только по обычным, но и по коротким идентификаторам. Такие короткие идентификаторы могут быть полезны для генерации семантических URL сайтов магазинов.
Поле short_id
является сокращённой версией оригинального идентификатора категории (поле id
), а поле slug
содержит в себе транслитерированное название категории, которое так же можно использовать в URL.
Короткие ID поддерживаются во всех методах API категорий, а так же во всех фильтрах других списков.
Методы
Список поддерживаемых методов для работы с категориями.
Список категорий
Возвращает список категорий магазина.
При передаче параметра treeview
возвращается список всех категорий
в виде дерева. В этом случае в каждую категорию добавляется поле children
, которое содержит список
вложенных категорий. Вложенность категорий неограничена.