gamification.shop.category.list

Scope: gamification

Кто может вызывать: Любой авторизованный пользователь. Подробнее: Права доступа

Постраничный список категорий (разделов) магазина бонусов.

HTTP: GET

Побочные эффекты: нет

Параметры метода

Параметр Тип Обяз. Описание
filter object нет Фильтр в Mongo-стиле
limit int нет Размер страницы, по умолчанию 50, максимум 500
offset int нет Смещение, по умолчанию 0
fetchAll bool нет Вернуть все записи одним ответом (защитный лимит 5000)

Возвращаемые данные

result.result — массив категорий. result.total — общее количество.

Ключ Описание
ID Идентификатор категории
NAME Название
ACTIVE Активность (Y/N)
SORT Порядок сортировки

Обработка ошибок

Справочник кодов ошибок.

Код Описание
UNAUTHORIZED Пользователь не авторизован

Пример запроса (GET)

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/gamification.shop.category.list.json" \
          -H "Accept: application/json"

Пример ответа:

{
          "result": {
            "result": [
              { "ID": "1", "NAME": "Кафе", "ACTIVE": "Y", "SORT": "100" }
            ],
            "total": 1,
            "next": null,
            "error": null
          }
        }
Предыдущая
gamification.shop.product.order
Следующая
gamification.shop.category.create