Категории каталога


Этот документ описывает работу с категориями каталога магазина в 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 00:00:00",
        "datetime": "2020-03-01 08:00:00",
        "datetime_at": "01.03.2020 в 08:00",
        "date": "01.03.2020",
        "diff": "1 год назад",
        "timestamp": 1583020800,
        "iso_utc": "2020-03-01T00:00:00+00:00",
        "iso": "2020-03-01T08:00:00+08:00"
    },
    "updated_at": {
        "timezone": "Asia\/Irkutsk",
        "datetime_utc": "2021-04-30 09:27:59",
        "datetime": "2021-04-30 17:27:59",
        "datetime_at": "30.04.2021 в 17:27",
        "date": "30.04.2021",
        "diff": "2 дня назад",
        "timestamp": 1619774879,
        "iso_utc": "2021-04-30T09:27:59+00:00",
        "iso": "2021-04-30T17:27:59+08:00"
    }
}

Описание полей

Короткие идентификаторы

Категории и товары могут быть запрошены не только по обычным, но и по коротким идентификаторам. Такие короткие идентификаторы могут быть полезны для генерации семантических URL сайтов магазинов.

Поле short_id является сокращённой версией оригинального идентификатора категории (поле id), а поле slug содержит в себе транслитерированное название категории, которое так же можно использовать в URL.

Короткие ID поддерживаются во всех методах API категорий, а так же во всех фильтрах других списков.

Методы

Список поддерживаемых методов для работы с категориями.

Список категорий

Возвращает список категорий магазина.

При передаче параметра treeview возвращается список всех категорий в виде дерева. В этом случае в каждую категорию добавляется поле children, которое содержит список вложенных категорий. Вложенность категорий неограничена.

Создание категории

Просмотр категории

Редактирование категории

Удаление категории

Массовое удаление категорий