gamification.shop.product.list

Scope: gamification

Кто может вызывать: Только admin или manager. Подробнее: Права доступа

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

HTTP: GET

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

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

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

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

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

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

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

Код Описание
UNAUTHORIZED Пользователь не авторизован
ACCESS_DENIED Вызывающий не является admin/manager

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

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/gamification.shop.product.list.json" \
          -H "Accept: application/json" \
          --data-urlencode "limit=10"
        

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

{
          "result": {
            "result": [
              {
                "ID": "1",
                "NAME": "Кофе",
                "PRICE": "100",
                "ACTIVE": "Y",
                "QUANTITY": null,
                "ENABLE_SELLING": "Y"
              }
            ],
            "total": 1,
            "next": null,
            "error": null
          }
        }