Обмен данными о бонусах
Файл bonuses содержит информацию о движении бонусных регистров.
Цель обмена: управление списанием/начислением бонусов, промо-бонусами, отображение бонусов в боте и мобильном приложении.
Частота обмена данными: максимально быстро по мере появления новых записей или изменения старых. Максимально допустимая задержка – 5 минут. Акции со статусом «Черновик» не передаются в ERP.
Направление: в зависимости от того, какая система управляет бонусными регистрами.
Структура#
BonusJson#
| Имя | Описание | Схема |
|---|---|---|
| bonusesCatalog обязательно | Список бонусных счетов | BonusesCatalogType |
BonusesCatalogType#
| Имя | Описание | Схема |
|---|---|---|
| bonusRegister обязательно | Бонусные счета | < BonusRegisterType > array |
| count обязательно | Количество бонусных счетов в документе | integer (int64) |
BonusRegisterType#
| Имя | Описание | Схема |
|---|---|---|
| bonusType необязательно | Бонусный счёт | BonusTypeType |
| card необязательно | Номер карты клиента | string |
BonusTypeType#
| Имя | Описание | Схема |
|---|---|---|
| balance обязательно | Общий баланс бонусов на счёте клиента | number (double) |
| balanceAvailable обязательно | Баланс бонусов, доступный для списания | number (double) |
| bonusHistory обязательно | История начисления/списания бонусов | < BonusHistoryType > array |
| internalCode обязательно | Внутренний код бонусного счёта | string |
BonusHistoryType#
| Имя | Описание | Схема |
|---|---|---|
| balance обязательно | Баланс бонусов на счёте после совершения транзакции | number (double) |
| checkCode необязательно | Внутренний код чека. Указывается, если бонусная транзакция привязана к чеку | string |
| checkData необязательно | Номер чека. Указывается, если бонусная транзакция привязана к чеку | string |
| checkDate необязательно | Дата чека. Указывается, если бонусная транзакция привязана к чеку | string (date-time) |
| checkSum необязательно | Сумма чека. Указывается, если бонусная транзакция привязана к чеку | number (double) |
| count обязательно | Количество бонусов | number (double) |
| date обязательно | Дата бонусной транзакции | string (date-time) |
| finishDate необязательно | Дата окончания действия бонусов | string (date-time) |
| internal-code обязательно | Внутренний код бонусной транзакции | string |
| payment-code необязательно | Код платежа. Указывается, если бонусная транзакция привязана к чеку и к конкретному платежу бонусами | string |
| startDate обязательно | Дата начала действия бонусов | string (date-time) |