Обмен данными о картах лояльности
Файл cards содержит информацию о картах лояльности и их держателях.
Цель обмена: отображать информацию о картах лояльности покупателя, с возможностью анализа различных показателей в разрезе карт.
Частота обмена данными: максимально быстро по мере появления новых записей или изменения старых. Максимально допустимая задержка – 5 минут.
Направление: ERP <—> LC
Структура#
CardJson#
| Имя | Описание | Схема |
|---|---|---|
| cardsCatalog обязательно | Каталог карт лояльности с клиентами | CardsCatalog |
CardsCatalog#
| Имя | Описание | Схема |
|---|---|---|
| internalCard необязательно | Каталог карт лояльности | < InternalCardType > array |
InternalCardType#
| Имя | Описание | Схема |
|---|---|---|
| brand необязательно | Торговая марка. Если не указно, то карта принадлежит торговой сети | BrandType |
| cardTypeCode обязательно | Код типа карты | string |
| cardTypeName обязательно | Наименование типа карты | string |
| cardsGroupTypes необязательно | Группа карт | < CardsGroupType > array |
| client необязательно | Информация о клиенте | < ClientType > array |
| number обязательно | Номер карты | string |
| status обязательно | Статус карты | enum (CREATE, ACTIVE, BLOCKED, DISABLED, NONEMITTED, INACTIVE, USED, PRE_ACTIVE, PRE_USED, PRE_DEACTIVE) |
BrandType#
| Имя | Описание | Схема |
|---|---|---|
| name обязательно | Наименование бренда | string |
| retailerBrandId обязательно | Идентификатор бренда в системе (внутренний код) | string |
CardsGroupType#
| Имя | Описание | Схема |
|---|---|---|
| internalCode обязательно | Внутренний код группы карт | string |
| name необязательно | Наименование группы карт | string |
ClientType#
| Имя | Описание | Схема |
|---|---|---|
| additionalEmails необязательно | Дополнительные email адреса | < string > array |
| birth-date необязательно | Дата рождения | string (date-time) |
| city необязательно | Город | string |
| email необязательно | Адрес электронной почты | string |
| emailVerifiedDate необязательно | Дата подтверждения email адреса | string (date-time) |
| first-name необязательно | Имя | string |
| guid обязательно | Внутренний код клиента (guid) | string |
| hasTelegramBot необязательно | Признак наличия ТГ бота | boolean |
| last-name необязательно | Фамилия | string |
| lcguid необязательно | Внутренний код клиента в системе LC | string |
| middle-name необязательно | Отчество | string |
| phone обязательно | Номер телефона | string |
| phoneVerifiedDate необязательно | Дата подтверждения номера телефона | string (date-time) |
| referral-code необязательно | Реферальный код | string |
| sex необязательно | Пол | enum (MALE, FEMALE, FORMER_MALE, FORMER_FEMALE, UNSPECIFIED) |
| status обязательно | Статус клиента | enum (Active, Closed, Blocked) |
| telegramBotInstallationDate необязательно | Дата установки Telegram-бота | string (date-time) |
| telegramBotShutdownDate необязательно | Дата удаления Telegram-бота | string (date-time) |