Получить остаток бонусов клиента
GET /bonus/card#
GET /bonus/cardОписание#
Метод предназначен для получения состояния бонусных счетов для указанной карты. В ответ метод возвращает на кассу общий баланс бонусов и баланс бонусов, доступных для списания
Параметры#
| Тип | Имя | Описание | Схема |
|---|---|---|---|
| Query | apiKey обязательно | Апи ключ | string |
| Query | number обязательно | Номер карты | string |
| Query | retailer обязательно | Код торговой сети | string |
Ответы#
| HTTP код | Описание | Схема |
|---|---|---|
| 200 | successful operation | BuyerBonusInfoJSON |
| 801 | Неизвестный код торговой сети | Без содержимого |
| 810 | Дисконтная карта клиента не найдена по номеру | Без содержимого |
Возвращает#
application/json
Определения#
BuyerBonusInfoJSON#
| Имя | Описание | Схема |
|---|---|---|
| bonusList обязательно | Список бонусных счетов | < BonusJSON > array |
BonusJSON#
| Имя | Описание | Схема |
|---|---|---|
| balance обязательно | Обший остаток бонусов на счете клиента | number (float) |
| balanceAvailable обязательно | Баланс бонусов, доступный для списания со счета клиента | number (float) |
| bonusHistoryList необязательно | История начисления бонусов на счет клиента | < BonusHistoryJSON > array |
| code обязательно | Код типа бонуса | string |
| name необязательно | Наименование типа бонуса | string |
BonusHistoryJSON#
| Имя | Описание | Схема |
|---|---|---|
| bonusHistoryBalance обязательно | Баланс бонусов на указанную дату | number (float) |
| checkSum необязательно | Сумма чека | number (float) |
| count обязательно | Количество начисленных/списанных бонусов | number (float) |
| date обязательно | Дата начисления | string (date-time) |