sw24loyaltyprogram.bonus.list
Назначение метода
Метод
Параметры
| Параметр | Описание | Применение |
| id |
Идентификатор записи в таблицу модуля. целое число |
Сортировка: order[id]=desc Фильтрация: filter[id]=10 |
| bonus_start |
Размер начисленных бонусов. дробное число |
Сортировка: order[bonus_start]=desc Фильтрация: filter[>bonus_start]=10 |
| bonus |
Размер остатков бонусов. дробное число |
Сортировка: order[bonus]=desc Фильтрация: filter[>bonus]=10 |
| user_id |
Идентификатор пользователя которому начислены бонусы. целое число |
Сортировка: order[user_id]=asc Фильтрация: filter[user_id]=10 |
| order_id |
Идентификатор заказа, за который начислены бонусы. целое число |
Сортировка: order[order_id]=asc Фильтрация: filter[order_id]=10 |
| user_bonus |
Идентификатор реферала, за действия которого были начислены бонусы. целое число |
Сортировка: order[user_bonus]=asc Фильтрация: filter[user_bonus]=10 |
| currency |
Код валюты бонусов. 1 строка |
Сортировка: order[currency]=asc Фильтрация: filter[currency]=RUB |
| date_add |
Дата начисления бонусов. дата в формате timestamp |
Сортировка: order[date_add]=asc Фильтрация: filter[date_add]=1651120449 |
| date_remove |
Дата списания бонусов. дата в формате timestamp |
Сортировка: order[date_remove]=asc Фильтрация: filter[date_remove]=1651120449 |
| status |
Тип бонусов.2 строка |
Сортировка: order[status]=asc Фильтрация: filter[status]=removed |
| profile_type |
Тип профиля начислившего бонусы.3 строка |
Сортировка: order[profile_type]=asc Фильтрация: filter[profile_type]=Registration |
| profile_id |
Идентификатор профиля начислившего бонусы.3 целое число |
Сортировка: order[profile_id]=asc Фильтрация: filter[profile_id]=1 |
| action_id |
Идентификатор действия профиля начислившего бонусы.3 целое число |
Сортировка: order[action_id]=asc Фильтрация: filter[action_id]=1 |
| limit |
Служебный параметр, указывает сколько записей необходимо вернуть (если не указан - то вернёт 50 записей) целое число |
limit=10 |
| offset |
Служебный параметр, указывает необходимый для пагинации если записей слишком много целое число |
offset=10 |
1 - Список валют и их кодов вы можете посмотреть в настройках магазина по адресу Магазин - Настройки Валюты - Список валют.
- active - Бонусы активированы
- inactive - Бонусы в очереди на активацию
- overdue - Бонусы просрочены
- used - Бонусы использованы
- removed - Бонусы удалены
3 - Список доступных профилей, их типов и действий вы можете посмотреть в помощью метода sw24loyaltyprogram.profile.list.
В параметрах фильтра можно указывать условия Больше, Меньше и т. п. в соответствии в правилами ORM битрикс. Например, параметр filter[>bonus] выведет все записи у которых размер бонусов более указанной величины
Результат
После успешного выполнения возвращает массив со следующими ключами:
| Ключ | Значение |
| result |
Массив записей полученный в соответствии в запрошенными параметрами фильтра и пагинации. массив |
| next |
Параметр для пагинации, указывающий какое значение нужно указать в параметре offset если все записи не вошли в текущий результирующий массив. целое число |
| total |
общее количество записей удовлетворяющее указанному запросу в соответствии с параметрами фильтра. целое число |
В случае неудачи метод вернёт массив со следующими ключами:
| Ключ | Значение |
| error |
Идентификатор ошибки (если есть) целое число |
| error_description |
Описание возникшей ошибки |
Пример вызова
https://