Skip to main content

Обмен данными об акциях

Файл 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