Методы для работы с Аккаунтом
| GET /account |
Возвращает информацию об аккаунте БонусПлюс |
| GET /account/filter |
Возвращает информацию, которую можно использовать для фильтрации |
Методы для работы с Клиентами
| GET /customer?id={id}&ean={ean}&phone={phone} |
Возвращает клиента по идентификатору, номеру карты или номеру телефона. Параметры задаются в адресной строке (URI parameters). Должен быть задан хотя бы один параметр |
| POST /customer |
Создание нового Клиента |
| PUT /customer/{phoneNumber} |
Редактирование существующего клиента. |
| PATCH /customer/{phoneNumber} |
Редактирование существующего клиента. |
| DELETE /customer/{phoneNumber} |
Удаление Клиента |
| PUT /customer/{phone}/sendCode |
Отправляет проверочный код на номер телефона клиента посредством смс-сообщения |
| PUT /customer/sendCode |
Отправляет проверочный код на номер телефона клиента посредством смс-сообщения |
| PUT /customer/{phoneNumber}/checkCode/{code} |
Проверяет код, отправленный на номер телефона клиента |
| POST /customer/list |
Возвращает список клиентов по заданному фильтру. Максимальное количество возвращаемых клиентов за один запрос - 1000 (задается в параметрах фильтра) |
| POST /customer/{phoneNumber}/sendMessage |
Отправляет сообщение клиенту |
| POST /customer/search |
Возвращает список клиентов по заданной строке поиска. Используется полнотекстовый поиск. Максимальное количество возвращаемых клиентов за один запрос - 10 |
| GET /customer/stat |
Возвращает статистику по клиентской базе |
| PATCH /customer/{phoneNumber}/balance |
Изменение бонусного баланса Клиента. Начисление и списание бонусов. |
| PATCH /customer/{phoneNumber}/balance/reserve |
Резервирование бонусов на счету клиента. С помощью вызова данного метода можно как зарезервировать бонусы на счета, так и отменить резерв полностью или частично. |
| DELETE /customer/balance/reserve |
Отмена резервирование бонусов на счету клиента. |
| GET /customer/{phoneNumber}/balance/reserve/{id} |
Возвращает информацию о резерве бонусов на счету клиента. |
| POST /customer/login |
Вход в личный кабинет для Клиента. При удачном входе возвращает информацию о клиенте |
| GET /customer/{phone}/setPassword |
Генерирует новый пароль для входа в личный кабинет Клиента. Отправляет пароль Клиенту в виде смс-сообщения. |
Методы для работы с электронными картами
| GET /ecard/{phoneNumber}/{validMinutes} |
Возвращает ссылку на скачивание электронной карты |
Методы для работы с Продажами
| PUT /retail/calc |
Расчет скидок/бонусов для чека. Возвращает информацию о скидках/бонусах которые будут применены для каждой позиции чека |
| POST /retail |
Проведение продажи в БонусПлюс |
| PUT /retail/back |
Осуществляет операцию возврата для позиции чека |
| POST /retail/transactions |
Возвращает список транзакций по заданному фильтру. Максимальное количество возвращаемых транзакций за один запрос - 1000 (задается в параметрах фильтра) |
| POST /retail/bonusActivities |
Возвращает транзакции по бонусным счетам Клиентов |
| GET /retail/{id} |
Возвращает информацию о продаже (чек) |
Методы для работы с Сообщениями
| POST /messaging/price |
Возвращает информацию о стоимости сообщения (sms, push, email) |
Методы для работы с Товарами
| POST /product/list |
Возвращает список товаров по фильтру Максимальное количество возвращаемых товаров за один запрос - 1000 (задается в параметрах фильтра) |
| POST /product/search |
Поиск товара по заданной строке. |
| POST /product/import |
Импорт товаров |