Обмен данными об акциях
Файл offers содержит информацию о запущенных или остановленных акциях.
Цель обмена: акции создаются только на стороне LC, т.к. в рамках акции проводятся маркетинговые мероприятия, акция визуально оформляется для отображения в боте и мобильных приложениях. Если процессинг находится на стороне ERP, то параметры акции надо выгружать в ERP для правильного обсчета чеков.
Частота обмена данными: максимально быстро по мере появления новых записей или изменения старых. Максимально допустимая задержка 5 минут. Акции со статусом «Черновик» не передаются в ERP.
Направление: LC —> ERP, если процессинг на стороне ERP. Не требуется, если процессинг на стороне LC
Структура#
StockJson#
| Имя | Описание | Схема |
|---|---|---|
| advertisingActionsType обязательно | Акция | AdvertisingActionsType |
AdvertisingActionsType#
| Имя | Описание | Схема |
|---|---|---|
| advertisingAction обязательно | Описание акции | AdvertisingActionType |
AdvertisingActionType#
| Имя | Описание | Схема |
|---|---|---|
| absoluteDiscount необязательно | Абсолютная скидка по акции | string |
| actionResults обязательно | Номенклатура товаров | ActionResultsType |
| active обязательно | Признак активности акции | boolean |
| additionalConditions необязательно | Дополнительные условия акции | string |
| beginDate обязательно< | Дата начала действия акции | string (date-time) |
| benefitModel необязательно | Модель применения поощрений | string |
| bonusCode необязательно | Код типа бонуса. Указывается, если тип акции 'Бонусная' | string |
| bonusValue необязательно | Значение бонуса. Указывается, если акция действует на все товары | number (double) |
| brand необязательно | Торговая марка. Указывается, если акция действует только в магазинах определенной торговой марки | BrandType |
| cardsCatalog необязательно | Список получателей акции. Может отсутствовать. Если отсутствует, значит акция действует для всех покупателей | CardsCatalog |
| checkRequirements необязательно | Требования к чеку | CheckRequirementsRootType |
| criteria необязательно | Критерий отбора участников акции | Criteria |
| description необязательно | Описание акции | string |
| distributionToGoods необязательно | Объект акции (товары или категории товаров) | enum (certificate, goodsSet, category, goods, all) |
| endDate необязательно | Дата окончания действия акции | string (date-time) |
| externalCode обязательно | Уникальный идентификатор акции | string |
| imageUrl необязательно | URL картинки акции | string |
| locations обязательно | Места проведения акции | LocationType |
| mechanic необязательно | Механика акции | MechanicType |
| name обязательно | Наименование акции | string |
| notificationText необязательно | Текст оповещения | string |
| publishDate необязательно | Дата экспорта акции | string (date-time) |
| type обязательно | Тип акции | enum (bonus, discount) |
ActionResultsType#
| Имя | Описание | Схема |
|---|---|---|
| catalog обязательно | Тип номенклатуры товаров | CatalogType |
| certificate необязательно | Описание сертификата акции. Только для механики 'Автосертификат' | CertificateType |
CatalogType#
| Имя | Описание | Схема |
|---|---|---|
| discountForSetsOfGoods обязательно | Указывается, если акция действует на товарные наборы | < DiscountForSetsOfGoodsType > array |
| goodsCategories обязательно | Указывается, если акция действует на категории товаров | < GoodsCategoriesType > array |
| markingOfTheGood обязательно | Указывается, если акция действует на товары | < MarkingOfTheGoodType > array |
DiscountForSetsOfGoodsType#
| Имя | Описание | Схема |
|---|---|---|
| defaultConditions необязательно | Требования к товару в чеке | DefaultSetConditionsType |
| goods обязательно | Каталог товаров, входящий в товарный набор | < StockSetGoodType > array |
| setName обязательно | Наименование товарного набора | string |
DefaultSetConditionsType#
| Имя | Схема |
|---|---|
| discountPercent необязательно | string |
| maxNumberDiscountedGoods необязательно | string |
| requiredQuantity необязательно | string |
StockSetGoodType#
| Имя | Описание | Схема |
|---|---|---|
| brand необязательно | Торговая марка | BrandType |
| id обязательно | Уникальный код товара | string |
| name обязательно | Наименование товара | string |
BrandType#
| Имя | Описание | Схема |
|---|---|---|
| name обязательно | Наименование бренда | string |
| retailerBrandId обязательно | Идентификатор бренда в системе (внутренний код) | string |
GoodsCategoriesType#
| Имя | Описание | Схема |
|---|---|---|
| bonusAccountingType необязательно | Способ начисления бонусов. Используется в бонусных акциях | enum (Percent, Fixed) |
| bonusValue необязательно | Абсолютное количество бонусов, начисляемых за покупку товара. Используется в бонусных акциях | number (double) |
| brand необязательно | Торговая марка | BrandType |
| code обязательно | Код категории товаров | string |
| discountPercent необязательно | Процент скидки | number (double) |
| displayName обязательно | Наименование категории | string |
MarkingOfTheGoodType#
| Имя | Описание | Схема |
|---|---|---|
| bonusAccountingType необязательно | Способ начисления бонусов. Используется в бонусных акциях | enum (Percent, Fixed) |
| bonusValue необязательно | Абсолютное количество бонусов, начисляемых за покупку товара. Используется в бонусных акциях | number (double) |
| brand необязательно | Торговая марка | BrandType |
| checkGoodRequirements необязательно | Требования к товару в чеке | CheckGoodRequirementsType |
| discountPercent необязательно | Сумма скидки в процентах | number (double) |
| fixedPrice необязательно | Фиксированная акционная цена товара | number (double) |
| id обязательно | Код товара | string |
| oldPrice необязательно | Исходная цена товара (без скидки) | number (double) |
| tags необязательно | Теги товаров на которые распространяется акция | < TagType > array |
CheckGoodRequirementsType#
| Имя | Схема |
|---|---|
| items необязательно | CheckGoodRequirementsItemsType |
| operation необязательно | string |
CheckGoodRequirementsItemsType#
| Имя | Схема |
|---|---|
| checkSumCriterion необязательно | CheckSumCriterionType |
| goodCountCriterion необязательно | GoodCountCriterionType |
CheckSumCriterionType#
| Имя | Схема |
|---|---|
| checkSumCriterionValue необязательно | CheckSumCriterionValueType |
| operation необязательно | string |
CheckSumCriterionValueType#
| Имя | Схема |
|---|---|
| finish необязательно | string |
| interval необязательно | string |
| start необязательно | string |
GoodCountCriterionType#
| Имя | Схема |
|---|---|
| goodCountCriterionValue необязательно | GoodCountCriterionValueType |
| operation необязательно | string |
GoodCountCriterionValueType#
| Имя | Схема |
|---|---|
| finish необязательно | string |
| interval необязательно | string |
| start необязательно | string |
TagType#
| Имя | Описание | Схема |
|---|---|---|
| group обязательно | Наименование группы тегов | string |
| groupCode обязательно | Код группы тегов | string |
| name обязательно | Наименование тега | string |
| tagCode обязательно | Внутренний код тега | string |