Для чтения визуальной составляющей схемы XSD, а также типами обязательных данных, ознакомьтесь с правилами использования. |
<AdvertisingActions>
AdvertisingAction |
Коллекция рекламных акций |
В данных каждой рекламной акции содержится внешний код (external-code), который служит уникальным идентификатором для управления рекламными акциями в SetRetail10 из ERP. При получении из ERP акции с уже имеющимся в системе external-code, текущая акция с данным external-code безусловно перезаписывается полученной из ERP.
Для рекламных акций, создаваемых в модуле визуализации SetRetail10, также генерируется уникальный в рамках торговой сети магазинов external_code
с префиксом SR10_.
Атрибут external-code используется в качестве кода акции в отчете о рассчитанных скидках, выгружаемом в ERP с чеками.
Данные рекламных акций выгружаются из ERP в SR10 в формате, предоставляемом Set Retail 10 в виде единой целостной сущности.
На стороне SR10 происходит валидация данных полученных из ERP рекламных акций. Рекламная акция будет отклонена, если в данных РА:
Отклоненные акции выкладываются в папку отклоненных акций для обеспечения обратной связи по загрузке акций с ERP
<AdvertisingAction>
AdvertisingActions/AdvertisingAction | ||||||
Заголовок Рекламной акции | ||||||
Наименование атрибута | Размер | Тип данных | Описание | Обязательное | ||
---|---|---|---|---|---|---|
advertActGUID | Integer | Не требуется заполнение поля из ERP | Нет | |||
name | 255 | String | Наименование РА | Да | ||
active | Boolean | Для загрузки активных акций всегда передавать true | Да | |||
mode | 13 | String | Тип условия применения РА.
| Да | ||
priority | 15 | Double | Приоритет (только для схемы работы акций по приоритету, акция с приоритетом 1 более приоритетная, чем акция с приоритетом 1000). По умолчанию 1000. При загрузке значение должно быть равным 1 и более. | Нет | ||
ignoreRestictions
| Boolean | Признак игнорирования ограничений на применение скидки в данных товаров
| Нет | |||
ignoreRestrictions Начиная с версии можно использовать, как новый параметр, так и предыдущий ignoreRestictions | Boolean | Признак игнорирования ограничений на применение скидки в данных товаров
| Нет | |||
worksAnyTime | Boolean |
| Да | |||
color | 7 | String | Цвет маркировки рекламной акции. Используется для визуализации акции в SetRetail10,
| Нет | ||
external-code | 255 | String | Внешний идентификатор РА | Да | ||
ti | 255 | String | Идентификатор транспортного пакета, в котором пришла данная РА | Нет | ||
deleted | Boolean | Признак удаления рекламной акции. Акция останавливается сразу после загрузки признака остановки. | Нет | |||
discountType | 255 | String | Код типа скидки | Нет | ||
exempt-from-bonus-discounts | Boolean | Флаг-признак, указывающий на то, что на товары, на которые сработала данная РА, нельзя давать скидки типа "бонусы как скидка". Отсутствие атрибута - распознается как FALSE | Нет | |||
disableChargeOnBonuses | Boolean | Флаг-признак, запрещающий начисление бонусных баллов на товары, на которые сработала данная РА | Нет | |||
finalAction | Boolean | Флаг-признак, запрещающий новые скидки после срабатывания данной акции | Нет | |||
Наименование элемента | Размер | Тип данных | Описание | Обязательное | ||
shop-indices | 1024 | PositiveInteger (white space separated) | Список магазинов через пробел, в которых действует акция. По умолчанию – действует во всей торговой сети. | Нет | ||
begin-date | DateTime | Дата начала действия акции | Да | |||
end-date | DateTime | Дата окончания действия акции | Да | |||
pricetag-type | 255 | String | Тип ценника, который должен печататься на товары этой акции. | Нет | ||
Блоки содержимого Рекламной акции | ||||||
Блок | Описание | |||||
dependence | Блок позволяет управлять из ERP зависимостью загружаемых РА от других акций, ранее загруженных в систему. Необязательный блок данных | |||||
externalConditions | Условия применения данной РА, акция сработает только при соблюдении всех указанных в акции условий. Если условия не указаны, акция действует для всех покупателей. Необязательный блок данных, заполняется только при mode = automatic | |||||
actionResults | Применяемые скидки в рамках данной Рекламной акции. Обязательный блок данных | |||||
pricetag-template | Коды ценников, которые должны печататься по умолчанию на товары этой акции. | |||||
actionLables | Метки рекламной акции |
<dependence>
Данный блок служит для обеспечения возможности управления из ERP зависимостью акций. Использование зависимостей позволяет строить более сложные и гибкие двухуровневые схемы построения маркетинговых программ.
В случае использования зависимых скидок расчет скидок производится в два последовательных этапа расчета, сначала рассчитываются скидки первого уровня (без установленной зависимости), а затем скидки второго уровня (с установленной зависимостью от скидки первого уровня).
Скидка второго уровня может сработать на позицию, только если на эту позицию на первом этапе уже сработала скидка первого уровня, от которой построена зависимость. Скидки второго уровня действуют от цен, полученных в результате действия скидок первого уровня.
Таким образом могут быть построены классические схемы расчета скидок, например, дополнительные скидки действуют от цен по дисконтной карте (акции на применение второй цены)
Данный блок не является обязательным, вы не обязаны использовать зависимости в ваших маркетинговых программах. |
Принцип работы суммирующихся акций остается неизменным.
Все суммирующиеся акции worksAnyTime = true
всегда действуют после последовательного применения конкурирующих worksAnyTime = false
акций первого и второго уровня.
Возможно построение зависимостей сразу от нескольких акций, тогда скидка второго уровня будет работать, если на позицию сработала хотя бы одна из скидок, от которых построена зависимость.
AdvertisingActions/AdvertisingAction/dependence | ||||
Наиманоение элемента | Размер | Тип данных | Описание | Обязательное |
---|---|---|---|---|
key | 255 | String | Всегда заполняется значением 'external-code' | Да |
value | 255 | String | External-code уже существующей акции, от которой должна быть установлена зависимость. | Да |
<AdvertisingActions> <AdvertisingAction name=”Скидка на количество по карте (зависит от 2й цены)” active=”true” mode=”automatic” priority=”1” ignoreRestictions=”true” worksAnyTime=”false” color=”green” external-code=”SR10_001”> <dependence key=”external-code” value=”SR10_1363”/> <dependence key=”external-code” value=”SR10_1364”/> <begin-date>2012-10-21T00:00:00Z</begin-date> <end-date>2012-11-31T00:00:00Z</end-date> <actionResults> <catalog> <marking-of-the-good id = “3850114202480” discountStart = “2.000” fixedPrice = “1000.00” maxQuantity = “43534.00”/> </catalog> </actionResults> <externalConditions> <InternalCardsCondition guid=”1359”/> </externalConditions> </AdvertisingAction> </AdvertisingActions> |
<actionResults>
AdvertisingActions/AdvertisingAction/actionResults | |
Блок | Описание |
set | Скидки на наборы |
catalog | Каталог фиксированных цен на товары |
goodsDiscount | Процентные и суммовые скидки на товары, группы товаров и группы продаж |
calculation | Скидки на чек целиком |
bonus-discount | Бонусы в качестве скидки |
tokens-discount | Фишки в качестве скидки |
counter | Счётчик |
bonus | Бонусы на счёт |
notification | Вторичный результат срабатывания акции. Сообщение или информирование. |
productOffer | Тип результата применения РА: предложение по добавлению товара в чек |
В одной Рекламной акции можно использовать только один тип скидок, но в неограниченном количестве. То есть в одной акции, например, задать целиком целый каталог фиксированных цен на товары или сразу большое количество наборов. |
<set>
В рамках одной акции может быть задано любое количество различных наборов. В рамках одной акции нельзя комбинировать наборы с другими результатами применения скидки.
AdvertisingActions/AdvertisingAction/actionResults/set | ||||
Наименование атрибута | Размер | Тип данных | Описание | Обязательное |
---|---|---|---|---|
name | 64 | String | Название набора внутри акции | Да |
valueType | 64 | String | Тип скидки на строки набора:
| Да |
value | 15 | Double | Стоимость набора целиком | Нет |
wholesale-restriction | 4294967295 | Integer | Установленное оптовое ограничение (количество наборов со скидкой за сутки для одного покупателя) | Нет |
maxQuantity | 3 | Integer | Максимальное количество наборов в чеке со скидкой | Нет |
calcWeightProductCountAsOne | Boolean | Принцип учета количества весовых позиций в наборе
| Нет | |
isSpreadDiscounts | Boolean | Говорит о том, что скидки на подарочные позиции будут размазаны по всему набору равномерно с учетом цен компонентов | Нет |
Каждый набор должен содержать не менее одной строки набора, иначе акция с таким набором будет отклонена.
Для каждой строки набора нужно указать один элемент (товар, список товаров, группа товаров, производитель, страна), а также количество товара в строке, требуемое для составления набора в чеке. Набор считается сработавшим только при наличии всех нужных товаров (из строк) в нужном количестве в чеке.
Для всех строк внутри набора должен быть установлен одинаковый тип скидки (процентная скидки или фиксированная цена). Для строки можно не указывать скидку, эта строка в наборе продается без скидки.
Существует возможность задавать целиком цену всего набора, в таком случае указывать значения скидки для каждой строки набора нет необходимости |
Обязательно либо указание стоимости набора целиком, либо значения скидки для одной или нескольких строк набора.
Если для одной строки набора прислать больше одного товара, для этой строки в SetRetail будет создан список товаров. Для срабатывания набора нужно будет купить требуемое в строке количество любого товара из данного списка. Для такого списка товаров можно задать название в атрибутах строки.
Это очень важная особенность, позволяющая реализовать простые акции типа "3 по цене 2 любых соков НИКО" или акции из примера – в строке набора нужно просто перечислить коды товаров в ассортименте, при этом можно задать название созданного списка товаров. |
<AdvertisingAction guid=”12982” name=”Пивов подарок при покупке любых 2 упаковок чипсов” active=”true” mode=”unconditional” priority=”1” ignoreRestictions=”true” worksAnyTime=”false” color=”” external-code=”BBZB01RAZB” > <shop-indices>701</shop-indices> <begin-date>2012-02-21T00:00:00Z</begin-date> <end-date>2012-02-29T00:00:00Z</end-date> <actionResults> <set name="Пиво в подарок при покупке любых 2 упаковок чипсов"> <row requiedQuantity=”1.000” fixedPrice=”100.00”> <marking-of-the-good id=”4100000200”/> </row> <row groupName=”Чипсы Lays” requiedQuantity=”3.000” fixedPrice=”30.00”> <marking-of-the-good id=”4100000100”/> <marking-of-the-good id=”4100000110”/> <marking-of-the-good id=”4100000120”/> <marking-of-the-good id=”4100000130”/> <marking-of-the-good id=”4100000140”/> </row> </set> </actionResults> </AdvertisingAction> |
<row>
AdvertisingActions/AdvertisingAction/actionResults/set/row | ||||
Наименование атрибута | Размер | Тип данных | Описание | Обязательное |
---|---|---|---|---|
requiedQuantity | 4294967295 | integer | Определяет кол-во единиц товара в строке, которого достаточно чтобы набор сработал | Да |
discountPercent | 15 | Double | % скидки на товар в данной строке (не актуально при указании стоимости набора целиком) | Нет |
fixedPrice | 15 | Double | Фиксированная акционная цена товара в данной строке (не актуально при указании стоимости набора целиком) | Нет |
groupName | 32 | String | Название списка товаров (используется только при создании списка товаров в строке) | Нет |
<marking-of-the-good>
Можно указать любое количество элементов.
AdvertisingActions/AdvertisingAction/actionResults/set/row/marking-of-the-good | ||||
Наименование атрибута | Размер | Тип данных | Описание | Обязательное |
---|---|---|---|---|
id | 255 | String | код товара | Да |
maxQuantity | Double | определяет максимальное кол-во товара в чеке, которое будет продано по акции. По умолчанию любое кол-во. | Нет | |
fixedPrice | Double | Фиксированная акционная цена товара. | Да | |
discountStart | Double | определяет количество товара, начиная с которого на этот товар будет начисляться скидка. По умолчанию с первого же товара | Нет | |
conditionCount | Double | определяет количество товара, при покупке которого на все количество этого товара будет дана скидка. По умолчанию при любом количестве. | Нет | |
wholesale-restriction | Double | Установленное оптовое ограничение (количество товара со скидкой за сутки для одного покупателя) | Нет |
<group>
Можно указать только 1 элемент.
AdvertisingActions/AdvertisingAction/actionResults/set/row/group | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
---|---|---|---|
id | String | Код товарной группы | Да |
<manufacturer>
Можно указать только 1 элемент
AdvertisingActions/AdvertisingAction/actionResults/set/row/manufacturer | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
---|---|---|---|
id | String | Код производителя | Да |
<department>
Под это условие попадают товары, имеющие активные цены в указанном отделе. Можно указать только 1 элемент.
AdvertisingActions/AdvertisingAction/actionResults/set/row/department | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
---|---|---|---|
id | String | Номер отдела | Да |
<country>
Можно указать только 1 элемент
AdvertisingActions/AdvertisingAction/actionResults/set/row/country | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
---|---|---|---|
id | String | Код страны | Да |
<sale-group>
Можно указать только 1 элемент
AdvertisingActions/AdvertisingAction/actionResults/set/row/sale-group | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
---|---|---|---|
id | String | Код заранее загруженной или созданной в SR10 группы продаж | Да |
<groups-element>
Задает множество товарных групп (по их кодам), что ограничивают множество товаров, удовлетвояющих данному критерию. Можно указать любое количество элементов.
AdvertisingActions/AdvertisingAction/actionResults/set/row/groups-element | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
---|---|---|---|
id | String | Код товарной группы | Да |
<manufacturers-element>
Задает множество производителей (по их кодам), что ограничивают множество товаров, удовлетвояющих данному критерию. Можно указать любое количество элементов.
AdvertisingActions/AdvertisingAction/actionResults/set/row/manufacturers-element | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
---|---|---|---|
id | String | Код производителя | Да |
<departments-element>
Множество номеров отделов, что ограничивают множество товаров, удовлетворяющих данному критерию. Под это условие попадают товары, имеющие активные цены в указанных отделах.
Можно указать любое количество элементов.
AdvertisingActions/AdvertisingAction/actionResults/set/row/departments-element | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
---|---|---|---|
id | String | Номер отдела | Да |
<countries-element>
Множество стран (по их кодам), что ограничивают множество товаров, удовлетвояющих данному критерию.
Можно указать любое количество элементов.
AdvertisingActions/AdvertisingAction/actionResults/set/row/countries-element | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
---|---|---|---|
id | String | Код страны | Да |
<sale-groups-element>
Множество групп продаж (по их кодам), что ограничивают множество товаров, удовлетворяющих данному критерию. Можно указать любое количество элементов.
AdvertisingActions/AdvertisingAction/actionResults/set/row/sale-groups-element | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
---|---|---|---|
id | String | Код заранее загруженной или созданной в SetRetail10 группы продаж | Да |
<price-restriction>
Можно указать только 1 элемент.
AdvertisingActions/AdvertisingAction/actionResults/set/row/price-restriction | |||
---|---|---|---|
Наименование атрибута | Тип данных | Описание | Обязательное |
condition | InequationType | Условие сравнения цены: больше, меньше.
| Да |
value | Decimal | Пороговое значение цены для сравнения, в «рублях» | Да |
<catalog>
В рамках одной акции может быть задано любое количество фиксированных цен на товары. В рамках одной акции нельзя комбинировать фиксированные цены с другими результатами применения скидки.
AdvertisingActions/AdvertisingAction/actionResults/catalog | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
---|---|---|---|
id | String | Код товара | Да |
maxQuantity | Double | Определяет максимальное кол-во товара в чеке, которое будет продано по акции. По умолчанию любое кол-во. | Нет |
discountStart | Double | Определяет количество товара, начиная с которого на этот товар будет начисляться скидка. По умолчанию с первого же товара | Нет |
conditionCount | Double | Определяет количество товара, при покупке которого на все количество этого товара будет дана скидка. По умолчанию при любом количестве. | Нет |
fixedPrice | Double | Фиксированная акционная цена товара. | Нет |
Wholesale-restriction | Double | Установленное оптовое ограничение (количество товара со скидкой за сутки для одного покупателя) | Нет |
<AdvertisingAction guid=”1298” name=”BBZB01RAZB: Фиксированная цена на товар с ограничением количества” active=”true” mode=”unconditional” priority=”1” ignoreRestictions=”true” worksAnyTime=”false” color=”” external-code=” BBZB01RAZB” > <shop-indices>701</shop-indices> <begin-date>2012-02-21T00:00:00Z</begin-date> <end-date>2012-02-29T00:00:00Z</end-date> <actionResults> <catalog> <marking-of-the-good id=”4100000107” maxQuantity=”5” fixedPrice=”89”/> <!--maxQuantity определяет максимальное кол-во товара в чеке, которое будет продано по акции. 0=любое кол-во --> <marking-of-the-good id=”4100000108” maxQuantity=”5” discountStart=”4” fixedPrice=”100”/> <!--fixedPrice задаёт фиксированную цену на товар; discountStart определяет позицию, начиная с которой на этот товар будет начислять скидка --> <marking-of-the-good id=”4100000109” maxQuantity=”0” conditionCount=”10” fixedPrice=”299”/> <!--conditionCount определяет количество товара, при покупке которого на все количество этого товара будет дана скидка. --> <marking-of-the-good id=”4100000104” maxQuantity=”0” fixedPrice=”199” wholesale-restriction=”3” /> <!--wholesale-restriction определяет количество товара, которое можно купить со скидкой одному покупателю за сутки. --> </catalog> </actionResults> </AdvertisingAction> |
<goodsDiscount>
AdvertisingActions/AdvertisingAction/actionResults/goodsDiscount | ||||
Наименование атрибута | Тип данных | Описание | Обязательное | |
---|---|---|---|---|
name | String | Название скидки | Нет | |
calcWeightProductCountAsOne | Boolean | Принцип учета количества весовых позиций в скидках с количественными ограничениями
| Нет | |
maxQuantity | Double | Определяет максимальное кол-во товара в чеке, которое будет продано по акции. | Нет | |
discountPercent | Double | Процент скидки на товар | Нет | |
discountSum | Double | Сумма скидки на товар | Нет | |
fixPrice | Double | Фиксированная цена каждой единицы товара из этой группы | Нет | |
goodsSum | Double | Сумма скидки при покупке товаров из этой группы. Распределяется пропорционально стоимости товаров этой группы. | Нет | |
discountStart | Double | Определяет позицию, начиная с которой на этот товар будет начисляться скидка | Нет | |
conditionCount | Double | Определяет количество товара, при покупке которого на все количество этого товара будет дана скидка | Нет | |
wholesale-restriction | Double | Установленное оптовое ограничение (количество товара, групп товаров, групп продаж и пр. со скидкой за сутки для одного покупателя) | Нет | |
allowOffline | Boolean | Разрешать расчет без получения данных об ограничениях из внешней системы | Нет | |
for-gifts-only | Boolean | Предоставлять скидку только для подарков | Нет | |
Наименование элемента | Тип данных | Описание | Обязательное | |
goods-filter-includeAndExcludeGroup Данный атрибут не указывается в XML-сообщении. Он определяет группу элементов на схеме. | Группа элементов, описывающая фильтр, по которому отбираются товары, на которые должна сработать скидка. Только одна из двух опций валидна: либо элемент-галочка "весь товарный справочник", либо группа фильтров "goods-filterGroup". | Нет | ||
for-all-goods | Boolean | Флаг-признак, указывающий на то, что данная скидка действует на ВЕСЬ ТОВАРНЫЙ СПРАВОЧНИК (за исключением товаров, что удовлетворяют фильтру exclude) | Нет | |
goods-filterGroup | Комплексный | Группа элементов, описывающая некий товарный фильтр | Нет | |
exclude | Комплексный | Фильтр, определяющий множество товаров, на которые данная скидка НЕ должна сработать. Данный фильтр имеет приоритет перед группой фильтров "goods-filterGroup" и флагом "for-all-goods": если товар удовлетворяет фильтру "exclude", то скидка на него не будет дана - не зависимо от значения флага "for-all-goods", либо значений фильтров группы "goods-filterGroup" | Нет | |
client-restriction | Комплексный | Ограничение по сумме скидки РА по клиенту | Нет | |
storage-time-condition | Комплексный | Импорт скидки на товары со сроком годности, близким к истечению Условие "до истечения срока годности" | Нет | |
action-label-exclude | String | Признак (метка рекламной акции), по которому товары, участвующие в акции с данной меткой, исключаются из текущей акции | Нет |
<?xml version="1.0" encoding="UTF-8"?> <AdvertisingActions> <AdvertisingAction name="Test sync with TI # 1" mode="automatic" active="true" priority="1.0" ignoreRestictions="true" worksAnyTime="true" external-code="092" shop-indices="7"> <begin-date>2020-01-19T12:23:00</begin-date> <end-date>2020-01-31T12:21:00</end-date> <actionResults> <goodsDiscount discountPercent="10.0"> <exclude> <marking-of-the-good id="00001" /> <marking-of-the-good id="00002" /> </exclude> <marking-of-the-good id="00003"/> <marking-of-the-good id="00004"/> </goodsDiscount> </actionResults> </AdvertisingAction> </AdvertisingActions> |
<goods-filterIncludeAndExcludeGroup>
AdvertisingActions/AdvertisingAction/actionResults/goodsDiscount/goods-filterIncludeAndExcludeGroup | ||||
Наименование элемента | Тип данных | Описание | Обязательное | |
---|---|---|---|---|
for-all-goods | Boolean | Флаг-признак, указывающий на то, что данная скидка действует на ВЕСЬ ТОВАРНЫЙ СПРАВОЧНИК (за исключением товаров, что удовлетворяют фильтру exclude) | Нет | |
goods-filterGroup Данный атрибут не указывается в XML-сообщении. Он определяет группу элементов на схеме. | Группа элементов, описывающая товарный фильтр | Нет | ||
marking-of-the-good | Комплексный | Артикулы (коды товаров), на которые будут установлены скидки | Нет | |
goodsGroup | Комплексный | Список товаров | Нет | |
group | Комплексный | Идентификатор товарной группы | Нет | |
sale-group | String | Список идентификаторов (кодов) групп продаж, товары из которых удовлетворяют данному фильтру | Нет | |
exclude | Boolean | Фильтр, определяющий множество товаров, на которые данная скидка НЕ должна сработать. Данный фильтр имеет приоритет перед группой фильтров "goods-filterGroup" и флагом "for-all-goods": если товар удовлетворяет фильтру "exclude", то скидка на него не будет дана - не зависимо от значения флаг "for-all-goods", либо значений фильтров группы "goods-filterGroup | Нет |
<goods-filterGroup>
Должен быть указан один из параметров
С использованием данной секции возможно использовать список товаров внутри скидки. Это позволяет создавать акции, в которых ограничение количества (на понижение или повышение) устанавливается на ассортимент товаров, а не один товар. Например, скидка при покупке более
5 любых соков или скидка дается не более чем 10 упаковок любых чипсов.
Пример акции со скидкой 10% на список товаров и ограничением минимального и максимального количества по акции
AdvertisingActions/AdvertisingAction/actionResults/goodsDiscount/goods-filter-includeGroup/goods-filterGroup | |||
Наименование элемента | Тип данных | Описание | Обязательное |
---|---|---|---|
marking-of-the-good | Комплексный | Артикулы (коды товаров), на которые будут установлены скидки | Нет |
goodsGroup | Комплексный | Определяет "плоский" список товаров внутри акции | Нет |
group | Комплексный | Идентификатор товарной группы | Нет |
sale-group | String | Список идентификаторов (кодов) групп продаж, товары из которых удовлетворяют данному фильтру | Нет |
<marking-of-the-good>
AdvertisingActions/AdvertisingAction/actionResults/goodsDiscount/goods-filter-includeGroup/goods-filterGroup/marking-of-the-good | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
---|---|---|---|
id | String | Код товара | Да |
maxQuantity | Double | Определяет максимальное кол-во товара в чеке, которое будет продано по акции. По умолчанию любое количество. Если отсутствует - без ограничений. | Нет |
discountStart | Double | Определяет количество товара, начиная с которого на этот товар будет начисляться скидка. По умолчанию с первого же товара | Нет |
conditionCount | Double | Определяет количество товара, при покупке которого на все количество этого товара будет дана скидка. По умолчанию при любом количестве. | Нет |
fixedPrice | Double | Фиксированная акционная цена товара. | Нет |
wholesale-restriction | Double | Установленное оптовое ограничение (количество товара со скидкой за сутки для одного покупателя) | Нет |
<goodsGroup>
AdvertisingActions/AdvertisingAction/actionResults/goodsDiscount/goods-filter-includeGroup/goods-filterGroup/goodsGroup | ||||
Наименование элемента | Тип данных | Описание | Обязательное | |
---|---|---|---|---|
name | String | Наименование списка товаров | Да | |
marking-of-the-good | Комплексный | Товары, на которые будем устанавливать скидки | Нет | |
Наименование атрибута | Тип данных | Описание | Обязательное | |
id | String | Код товара | Да | |
maxQuantity | Double | Определяет максимальное кол-во товара в чеке, которое будет продано по акции. По умолчанию любое количество. Если отсутствует - без ограничений. | Нет | |
discountStart | Double | Определяет количество товара, начиная с которого на этот товар будет начисляться скидка. По умолчанию с первого же товара | Нет | |
conditionCount | Double | Определяет количество товара, при покупке которого на все количество этого товара будет дана скидка. По умолчанию при любом количестве. | Нет | |
fixedPrice | Double | Фиксированная акционная цена товара. | Нет | |
wholesale-restriction | Double | Установленное оптовое ограничение (количество товара со скидкой за сутки для одного покупателя) | Нет |
<group>
AdvertisingActions/AdvertisingAction/actionResults/goodsDiscount/goods-filter-includeGroup/goods-filterGroup/group | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
---|---|---|---|
id | String | Код группы товаров | Да |
<sale-group>
AdvertisingActions/AdvertisingAction/actionResults/goodsDiscount/goods-filter-includeGroup/goods-filterGroup/sale-group | |||
Наименование элемента | Тип данных | Описание | Обязательное |
---|---|---|---|
sale-group | String | Список идентификаторов (кодов) групп продаж, товары из которых удовлетворяют данному фильтру | Нет |
<exclude>
AdvertisingActions/AdvertisingAction/actionResults/goodsDiscount/exclude | ||||
Наименование элемента | Типа данных | Описание | Обязательное | |
---|---|---|---|---|
exclude | Комплексный | Группа элементов, описывающая некий товарный фильтр | Нет | |
goods-filterGroup Данный атрибут не указывается в XML-сообщении. Он определяет группу элементов на схеме. | Группа элементов, описывающая товарный фильтр | Нет | ||
marking-of-the-good | Комплексный | Артикулы (коды товаров), на которые будут установлены скидки | Нет | |
goodsGroup | Комплексный | Список товаров | Нет | |
group | Комплексный | Идентификатор отварной группы | Нет | |
sale-group | String | Список идентификаторов (кодов) групп продаж, товары из которых удовлетворяют данному фильтру | Нет |
<goods-filterGroup>
<marking-of-the-good>
AdvertisingActions/AdvertisingAction/actionResults/goodsDiscount/exclude/goods-filterGroup/marking-of-the-good | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
---|---|---|---|
id | String | Код товара | Да |
maxQuantity | Double | Определяет максимальное кол-во товара в чеке, которое будет продано по акции. По умолчанию любое количество. Если отсутствует - без ограничений. | Нет |
discountStart | Double | Определяет количество товара, начиная с которого на этот товар будет начисляться скидка. По умолчанию с первого же товара | Нет |
conditionCount | Double | Определяет количество товара, при покупке которого на все количество этого товара будет дана скидка. По умолчанию при любом количестве. | Нет |
fixedPrice | Double | Фиксированная акционная цена товара. | Нет |
wholesale-restriction | Double | Установленное оптовое ограничение (количество товара со скидкой за сутки для одного покупателя) | Нет |
<goodsGroup>
AdvertisingActions/AdvertisingAction/actionResults/goodsDiscount/exclude/goods-filterGroup/goodsGroup | ||||
Наименование элемента | Тип данных | Описание | Обязательное | |
---|---|---|---|---|
name | String | Наименование списка товаров | Да | |
marking-of-the-good | Комплексный | Товары, на которые будем устанавливать скидки | Нет | |
Наименование атрибута | Тип данных | Описание | Обязательное | |
id | String | Код товара | Да | |
maxQuantity | Double | Определяет максимальное кол-во товара в чеке, которое будет продано по акции. По умолчанию любое количество. Если отсутствует - без ограничений. | Нет | |
discountStart | Double | Определяет количество товара, начиная с которого на этот товар будет начисляться скидка. По умолчанию с первого же товара | Нет | |
conditionCount | Double | Определяет количество товара, при покупке которого на все количество этого товара будет дана скидка. По умолчанию при любом количестве. | Нет | |
fixedPrice | Double | Фиксированная акционная цена товара. | Нет | |
wholesale-restriction | Double | Установленное оптовое ограничение (количество товара со скидкой за сутки для одного покупателя) | Нет |
<group>
AdvertisingActions/AdvertisingAction/actionResults/goodsDiscount/exclude/goods-filterGroup/group | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
---|---|---|---|
id | String | Код группы товаров | Да |
<sale-group>
AdvertisingActions/AdvertisingAction/actionResults/goodsDiscount/exclude/goods-filterGroup/sale-group | |||
Наименование элемента | Тип данных | Описание | Обязательное |
---|---|---|---|
sale-group | String | Список идентификаторов (кодов) групп продаж, товары из которых удовлетворяют данному фильтру | Нет |
<client-restriction>
<storage-time-condition>
<calculation>
В рамках одной рекламной акции можно использовать только одну скидку на чек в акции, сочетать этот тип скидки с остальными нельзя
AdvertisingActions/AdvertisingAction/actionResults/calculation | |||
Наименование атрибута | Тип данных | Описание | Обяазтельное |
value-type | String | Тип скидки на чек из списка ниже
| Да |
value | Decimal | Значение, дополняющее тип скидки
| Да |
secondary-value | String | Дополнительное значение для плагинов скидок: Только для принципа вычисления = PAYMENT_TYPE_PERCENT и содержит название типа оплаты, от размера которого и считать скидку. Например, если значение этого атрибута BankCardPaymentEntity, и при покупке использовали 50 рублей оплаты по банковской карте и еще 800 - другие типы оплат, то скидка будет считаться только от 50 рублей) Типы оплат:
Ещё используется для хранения значения флага "Учитывать оптовое ограничение": также применяется только если принцип вычисления = EXTERNAL_LOYALTY и Список процессингов /standalone/configuration/modules/external-systems-manager/service-providers.xml | Нет |
<bonus-discount>
AdvertisingActions/AdvertisingAction/actionResults/bonus-discount | |||
Поле | Тип данных | Описание | Обязательное |
max-percent | Double | Максимальный процент оплаты баллами от суммы чека | Да |
type | String | Тип (CRM, спасибо от сбербанка, внутренние бонусы, ...). Если отсутствует, то по умолчанию == "CRM". | Нет |
<tokens-discount>
AdvertisingActions/AdvertisingAction/actionResults/tokens-discount | ||||
Наименование элемента | Тип данных | Описание | Обязательное | |
productTokensApplyRules | Комплексный | Правила списания за фишки на товар | Нет | |
Наименование атрибута | Тип данных | Описание | Обязательное | |
marking | String | Код товара | Нет | |
Наименование элемента | Тип данных | Описание | Обязательное | |
rules | Комплексный | Правила списания за фишки на товар | Нет | |
Наименование атрибута | Тип данных | Описание | Обязательное | |
tokenCount | Long | Количество фишек | Да | |
price | Double | Цена товара | Да |
<counter>
AdvertisingActions/AdvertisingAction/actionResults/counter | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
metric | Комплексный | Метрика счётчика Возможные значения:
| Да |
indicator | Комплексный | Показатель счётчика Возможные значения:
| Да |
period-value | Integer | Значение периода действия | Да |
period-type | Комплексный | Тип периода действия ограничения Возможные значения:
| Да |
Наименование элемента | Тип данных | Описание | Обязательное |
markings | Список | Коды товаров | Нет |
<?xml version="1.0" encoding="UTF-8"?> <AdvertisingActions> <AdvertisingAction name="Счетчик по сумме чека. Обнуляется раз в 13 недель" active="true" mode="automatic" priority="10" ignoreRestictions="false" worksAnyTime="false" color="red" external-code="SUM_CHEQUE"> <begin-date>2012-12-01T18:00:00</begin-date> <end-date>2050-12-01T18:00:00</end-date> <actionResults> <counter metric="CHEQUES" indicator="SUMM" period-value="13" period-type="WEEKS" /> </actionResults> </AdvertisingAction> <AdvertisingAction name="Счетчик по количеству товаров. Обнуляется раз в 13 недель" active="true" mode="automatic" priority="10" ignoreRestictions="false" worksAnyTime="false" color="red" external-code="ITEMS_COUNT"> <begin-date>2012-12-01T18:00:00</begin-date> <end-date>2050-12-01T18:00:00</end-date> <actionResults> <counter metric="PRODUCTS" indicator="COUNT" period-value="13" period-type="MONTHS"> <markings>777 666 555</markings> </counter> </actionResults> </AdvertisingAction> </AdvertisingActions> |
<bonus>
AdvertisingActions/AdvertisingAction/actionResults/bonus | |||
Наиманование атрибута | Тип данных | Описание | Обязательное |
type | String | Принцип вычисления бонуса. (Поддерживается только "DiscountFromCheck" - процент от суммы чека) | Да |
sponsor | String | Спонсор бонусной программы (CRM, спасибо от сбербанка, внутренние бонусы (SET10), ...). Если отсутствует, то по умолчанию = "BONUS_SR10" (бонусы SET10). | Нет |
accountTypeId | Long | Указатель на тип счёта | Нет |
bonusValue | Long | Число, количественно характеризующее размер начисляемых бонусов. Смысл этого числа зависит от принцина начисления.
| Нет |
summa | Long | Процент от кратной величины(будет два поля для ввода - % и сумма) | Нет |
bin-prefix | String | Префикс BIN (Bank Identification Number) - номера банковской карты, по которой была проведена оплата, на основании которой надо начислить бонусы. Используется, только при принципе начисления бонусов "BANKPERCENT" | Нет |
multiplier | String | Коэффициент умножения баллов | Да |
accountType | String | название типа бонусного счета, на который будут начисляться бонусы | Да |
startAfter | String | время начала действия бонусов - задержка после совершения покупки - в формате: (\\d+)[d|w|m|y] - например, 34w - через 34 недели, 11d - через 11 дней и проч. | Да |
timeToLive | String | Время действия бонусов после активации - в формате: (\\d+)[d|w|m|y] - например, 12m - 12 месяцев, 11d - 11 дней и проч. | Да |
beginDate | dateTime | Дата начала действия бонусов
При отсутствии атрибутов beginDate и endDate интервал дат действия бонусов будет определен как "Действует всегда". | Нет |
endDate | dateTime | Дата окончания действия бонусов
При отсутствии атрибутов beginDate и endDate интервал дат действия бонусов будет определен как "Действует всегда". | Нет |
Наиманование элемента | Тип данных | Описание | Обязательное |
bonus-accrual-rule | Комплексный | Правила начисления бонусов в зависимости от размера оплаты по банковской карте | Нет |
tokens-accrual-rule | Комплексный | Правило начисления фишек | Нет |
product-row | Комплексный | Набор строк определяющий товары/группы продаж/товарные группы с которых не будут начислены ББ | Нет |
<?xml version="1.0" encoding="UTF-8"?> <AdvertisingActions> <AdvertisingAction name="SR-2221: Тип - AMOUNTPERCENT" active="true" mode="automatic" priority="10" ignoreRestictions="false" worksAnyTime="false" color="red" AdvertActGUID = "210620181" external-code="SR-2221-AMOUNTPERCENT"> <begin-date>2012-12-01T18:00:00</begin-date> <end-date>2050-12-01T18:00:00</end-date> <!-- Результат РА: AMOUNTPERCENT=процент от суммы --> <actionResults> <bonus type="AMOUNTPERCENT" bonusValue="1000" accountType="SR-2221" accountTypeId="1234" multiplier="1" startAfter="1d" timeToLive="2y"/> </actionResults> </AdvertisingAction> <AdvertisingAction name="SR-2221: Тип - MULTIPLEPERCENT" active="true" mode="automatic" priority="10" ignoreRestictions="false" worksAnyTime="false" color="red" AdvertActGUID = "210620182" external-code="SR-2221-MULTIPLEPERCENT"> <begin-date>2012-12-01T18:00:00</begin-date> <end-date>2050-12-01T18:00:00</end-date> <!-- Результат РА: MULTIPLEPERCENT=процент от кратной величины --> <actionResults> <bonus type="MULTIPLEPERCENT" bonusValue="1000" summa="3000" accountType="SR-2221" accountTypeId="1234" multiplier="1" startAfter="1d" timeToLive="2y"/> </actionResults> </AdvertisingAction> <AdvertisingAction name="SR-2221: Тип - FIXBONUS" active="true" mode="automatic" priority="10" ignoreRestictions="false" worksAnyTime="false" color="red" AdvertActGUID = "210620183" external-code="SR-2221-FIXBONUS"> <begin-date>2012-12-01T18:00:00</begin-date> <end-date>2050-12-01T18:00:00</end-date> <!-- Результат РА: FIXBONUS=фиксированная величина --> <actionResults> <bonus type="FIXBONUS" bonusValue="3000" accountType="SR-2221" accountTypeId="1234" multiplier="1" startAfter="1d" timeToLive="2y"/> </actionResults> </AdvertisingAction> </AdvertisingActions> |
AdvertisingActions/AdvertisingAction/actionResults/bonus/bonus-accrual-rule | ||||
Наиманование атрибута | Тип данных | Описание | Обязательное | |
percent | Decimal | Процент от суммы оплаты по банковской карте, что надо вернуть покупателю в виде начисления бонусов По умолчанию = 0 | Нет | |
Наименование элемента | Тип данных | Описание | Обязательное | |
condition | Комплексный | Условие срабатывания данного правила начисления бонусов | Нет | |
min | Long | Начальная граница интервала включительно. NULL распознается как "минус бесконечность" | Нет | |
max | Long | Конечная граница интервала исключительно (интервал справа - открыт). NULL распознается как "плюс бесконечность" | Нет |
AdvertisingActions/AdvertisingAction/actionResults/bonus/tokens-accrual-rule | |||||
Наиманование атрибута | Тип данных | Описание | Обязательное | ||
valueType | Список | Тип значения, на которое смотрим в чеке:
| Нет | ||
value | Decimal | Проверяемое правилом значение в шт, кг или руб | Нет | ||
accrualTokens | Long | Количество фишек к начислению за выполнение правила | Нет | ||
maxTokens | Long | Максимальное количество фишек к начислению за выполнение правила | Нет | ||
forAllGoods | Boolean | Флаг-признак, что данная скидка действует на весь товарный справочник. | Нет | ||
excludeNotDiscountable | Boolean | Флаг-признак, что данная скидка не действует на товары с запретом применения скидок. | |||
Наименование элемента | Тип данных | Описание | Обязательное | ||
products | Комплексный | Набор строк определяющий товары/группы продаж/товарные группы с которых начисляем фишки | Нет | ||
Наименование атрибута | Тип данных | Описание | Обязательное | ||
description | String | Название списка товаров | Нет | ||
Наиманование атрибута | Тип данных | Описание | Обязательное | ||
group | String | Идентификатор (код) товарной группы | Нет | ||
sale-group | String | Идентификатор (код) группы продаж | Нет | ||
marking | String | Список идентификаторов (артикулов) товаров | Нет | ||
Наименование атрибута | Тип данных | Описание | Обязательное | ||
excluded | String | Набор строк определяющий товары/группы продаж/товарные группы с которых не начисляем фишки | Нет | ||
Наименование элемента | Тип данных | Описание | Обязательное | ||
group | String | Идентификатор (код) товарной группы | Нет | ||
sale-group | String | Идентификатор (код) группы продаж | Нет | ||
marking | String | Список идентификаторов (артикулов) товаров | Нет |
<product-row>
AdvertisingActions/AdvertisingAction/actionResults/bonus/product-row | ||||
Наиманование атрибута | Тип данных | Описание | Обязательное | |
description | String | Название списка товаров | Нет | |
Наименование элемента | Тип данны | Описание | Обязательное | |
group | String | Идентификатор (код) ТОВАРНОЙ группы | Нет | |
sale-group | String | Идентификатор (код) группы продаж | Нет | |
marking | String | Список идентификаторов (артикулов) товаров | Нет |
<notification>
AdvertisingActions/AdvertisingAction/actionResults/notification | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
limit | integer | Максимальное количество "сообщений"/"наклеек", что можно получить в рамках ДАННОГО УСЛОВИЯ (данного вычислителя) данной РА. Отсутствие данного атрибута распознается как отсутствие лимита. | Нет |
allowOffline | Boolean | Нет | |
Наименование элемента | Тип данных | Описание | Обязательное |
online-notification | Комплексный | online-информирование о результате срабатывания РА | Нет |
slip-content | String | offline-информирование: сообщение на чеке | Нет |
printSlipInsideReceipt | Boolean | Флаг, определяющий, следует ли печатать слип отдельно или в составе чека | Нет |
calculator | Комплексный | "Вычислитель" количества "преференций" (наклеек), что получит покупатель.
| Нет |
validation | Комплексный | Необходимо ли сканирование на кассе ШК и какие именно ШК | Нет |
action-restriction | Комплексный | Ограничение выдачи подарков по клиенту | Нет |
client-restrictrion | Комплексный | Ограничение выдачи подарков по акции | Нет |
<online-notification>
AdvertisingActions/AdvertisingAction/actionResults/notification/online-notification | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
time | String/Комлексный | Момент времени (этап техпроцесса), когда это сообщение показать. По умолчанию: после "подытога" возможные значения:
| Нет |
Наименование элемента | Тип данных | Описание | Обязательное |
message-for-customer | String | Сообщение на дисплей покупателя | Нет |
message-for-cashier | String | Сообщение на экран кассира | Нет |
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <AdvertisingActions> <AdvertisingAction AdvertActGUID="1052744" name="TESTRA1" active="true" mode="automatic" priority="1010.0" ignoreRestictions="false" worksAnyTime="true" color="yellow" external-code="TEST_A014" deleted="false" discountType="38"> <begin-date>2018-06-19T00:00:00.000</begin-date> <end-date>2018-09-25T23:59:59.999</end-date> <actionResults> <set name="Набор-условие"> <row groupName="CD-ROMS" requiedQuantity="1.0" discountPercent="0.0"> <marking-of-the-good id="1"/> <marking-of-the-good id="2"/> <marking-of-the-good id="3"/> <marking-of-the-good id="4"/> </row> </set> <notification> <slip-content>##double_height####center##Test Message! TEST_A014 Left text ##right##Right text </slip-content> <calculator xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="receipt-sum-preferences-calculatorType" id="" divider="1" multiplier="1"/> </notification> </actionResults> <externalConditions> <purchaseAmount greater-than="1000.0"/> </externalConditions> </AdvertisingAction> </AdvertisingActions> |
<calculator>
AdvertisingActions/AdvertisingAction/actionResults/notification/calculator | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
type | String | Тип калькулятора: receipt-sum-preferences-calculatorType - Данный механизм "вычислитель" определяет количество "преференций" на основе суммы чека sum-based-preferences-calculatorType - Данный "вычислитель" определяет количество "преференций" на основе суммы стоимостей позиций, удовлетворяющих определенным условиям (условиям выборки): по принадлежности товарной группе, группе продаж, имеющих определенные артикулы quantity-based-preferences-calculatorType - Данный "вычислитель" определяет количество "преференций" на основе количества позиций | Да |
id | String | Идентификатор данного "вычислятора"/"условия" предоставления подарков/"преференций". Должен быть уникален в рамках РА. | Нет |
divider | Integer | Делимое при вычислении | Да |
multiplier | Integer | множитель при вычислении | Нет |
limit | Integer | Максимальное количество "сообщений"/"наклеек", что можно получить в рамках ДАННОГО УСЛОВИЯ (данного вычислителя) данной РА. Отсутствие данного атрибута распознается как отсутствие лимита. | Нет |
checkDiscountableFlag | Boolean | Проверять или нет товарное свойство "Расчет скидок на товар запрещен" при расчете количества преференций данного типа. | Нет |
Все "вычислители" определяют количество "преференций" по одному и тому же правилу
|
(receipt-sum-preferences-calculatorType)
AdvertisingActions/AdvertisingAction/actionResults/notification/calculator | |||
Наиманование атрибута | Тип данных | Описание | Обязательное |
xsi:type | String | receipt-sum-preferences-calculatorType | Да |
id | String | Идентификатор данного "вычислителя"/"условия" предоставления подарков/"преференций". Должен быть уникален в рамках РА. | Нет |
divider | Integer | Делимое при вычислении | Да |
multiplier | Integer | множитель при вычислении | Нет |
limit | Integer | Максимальное количество "сообщений"/"наклеек", что можно получить в рамках ДАННОГО УСЛОВИЯ (данного вычислителя) данной РА. Отсутствие данного атрибута распознается как отсутствие лимита. | Нет |
checkDiscountableFlag | Boolean | Проверять или нет товарное свойство "Расчет скидок на товар запрещен" при расчете количества преференций данного типа. | Нет |
Калькулятор по сумме позиций (sum-based-preferences-calculatorType)
AdvertisingActions/AdvertisingAction/actionResults/notification/calculator | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
xsi:type | String | sum-based-preferences-calculatorType | Да |
id | String | Идентификатор данного "вычислителя"/"условия" предоставления подарков/"преференций". Должен быть уникален в рамках РА. | Нет |
divider | Integer | Делимое при вычислении | Да |
multiplier | Integer | Множитель при вычислении | Нет |
limit | Integer | Максимальное количество "сообщений"/"наклеек", что можно получить в рамках ДАННОГО УСЛОВИЯ (данного вычислителя) данной РА. Отсутствие данного атрибута распознается как отсутствие лимита. | Нет |
checkDiscountableFlag | Boolean | Проверять или нет товарное свойство "Расчет скидок на товар запрещен" при расчете количества преференций данного типа. | Нет |
Наименование элемента | Тип данных | Описание | Обязательное |
goods-filter | Комплексный | Группа элементов, описывающая товарный фильтр | Нет |
group | String | Идентификатор товарной группы | Нет |
sale-group | String | Список идентификаторов (кодов) групп продаж, товары из которых удовлетворяют данному фильтру | Нет |
marking | String | Список идентификаторов (артикулов) товаров, что участвуют при вычислении количества "преференций". | Нет |
<!-- 1 наклейка за каждые 100 руб. печенья (арт.: 026441_ST), но не более 4 --> <calculator xsi:type="sum-based-preferences-calculatorType" divider="10000" multiplier="1" limit="4"> <marking>026441_ST</marking> </calculator> |
Калькулятор по количеству товаров в позициях (quantity-based-preferences-calculatorType)
AdvertisingActions/AdvertisingAction/actionResults/notification/calculator | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
xsi:type | String | quantity-based-preferences-calculatorType | Да |
id | String | Идентификатор данного "вычислителя"/"условия" предоставления подарков/"преференций". Должен быть уникален в рамках РА. | Нет |
divider | Integer | Делимое при вычислении | Да |
multiplier | Integer | Множитель при вычислении | Нет |
limit | Integer | Максимальное количество "сообщений"/"наклеек", что можно получить в рамках ДАННОГО УСЛОВИЯ (данного вычислителя) данной РА. Отсутствие данного атрибута распознается как отсутствие лимита. | Нет |
checkDiscountableFlag | Boolean | Проверять или нет товарное свойство "Расчет скидок на товар запрещен" при расчете количества преференций данного типа. | Нет |
Наименование элемента | Тип данных | Описание | Обязательное |
goods-filter | Комплексный | Группа элементов, описывающая товарный фильтр | Нет |
group | String | Идентификатор товарной группы | Нет |
sale-group | String | Список идентификаторов (кодов) групп продаж, товары из которых удовлетворяют данному фильтру | Нет |
marking | String | Список идентификаторов (артикулов) товаров, что участвуют при вычислении количества "преференций". | Нет |
<!-- 1 наклейка за каждые 8 тульских пряников (арт.: 184196_ST), но не более 3 --------------------------------------------------------------------> <calculator xsi:type="quantity-based-preferences-calculatorType" divider="8000" multiplier="1" limit="3"> <marking>184196_ST</marking> </calculator> |
<validation>
AdvertisingActions/AdvertisingAction/actionResults/notification/validation | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
enable | Boolean | Включена или выключена валидация | Нет |
adds-as-products | Boolean | Добавлять подарки в чек как товары | Нет |
Наименование элемента | Тип данных | Описание | Обязательное |
barcode | String | Штрихкод подарка (используется только при выключенной опции "Добавлять подарки в чек как товары") | Нет |
marking | String | Код (артикул) товара-подарка (используется только при включенной опции "Добавлять подарки в чек как товары") | Нет |
<?xml version="1.0" encoding="UTF-8"?> <AdvertisingActions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <AdvertisingAction name="Подарок SR-4020" active="true" mode="unconditional" priority="1001" ignoreRestictions="true" worksAnyTime="true" color="violet" external-code="EXTERNAL_CODE_0001-3"> <begin-date>2013-03-13T00:00:00</begin-date> <end-date>2071-04-13T00:00:00</end-date> <actionResults> <notification limit="2"> <online-notification time="SUBTOTAL"> <message-for-customer><![CDATA[CUSTOMER_MESSAGE]]></message-for-customer> <message-for-cashier><![CDATA[CASHIER_MESSAGE]]></message-for-cashier> </online-notification> <calculator xsi:type="quantity-based-preferences-calculatorType" divider="3000" multiplier="1" limit="2"> <marking>145902</marking> </calculator> <validation enable="true" add-as-products="true"> <marking>00998</marking> </validation> </notification> <goodsDiscount name="Скидка на подарок" discountPercent="50" for-gifts-only="true"> <marking-of-the-good id="00998"/> </goodsDiscount> </actionResults> </AdvertisingAction> </AdvertisingActions> |
<action-restriction>
AdvertisingActions/AdvertisingAction/actionResults/notification/action-restriction | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
max-value | Integer | Значение ограничения | Да |
<client-restriction>
AdvertisingActions/AdvertisingAction/actionResults/notification/client-restriction | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
max-value | Integer | Значение ограничения | Да |
restriction-period-type | String | Тип периода действия ограничения
| Нет |
period | Integer | Значение периода действия | Нет |
<productOffer>
AdvertisingActions/AdvertisingAction/actionResults/notification/client-restriction | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
marking | String | Артикул товара | Да |
quantity | Long | Количество товара в позиции, в "граммах" (т.е., 1000 = 1 кг. (для весового товара) и 1000 = 1 шт. (для штучного товара)) | Нет |
<externalConditions>
В одной рекламной акции может быть сразу несколько условий срабатывания, такая акция срабатывает в случае соблюдения всех заданных условий. Если условия не заданы – акция будет безусловной и работать для всех покупателей.
AdvertisingActions/AdvertisingAction/externalConditions | |||
Наименование элемента | Тип данных | Описание | Обязательное |
---|---|---|---|
InternalCardsCondition | Комплексный | Наличие внутренней карты Условия объединяются по логическому "ИЛИ": | Нет |
ExternalCardsCondition | Комплексный | Наличие внешней карты Условия объединяются по логическому "ИЛИ": | Нет |
HoursActionCondition | Комплексный | Часы действи | Нет |
DaysActionCondition | Комплексный | Дни недели | Нет |
CouponsCondition | Комплексный | Наличие купона | Нет |
purchaseAmount | Комплексный | Сумма чека | Нет |
birthday-condition | Комплексный | День рождения | Нет |
age-condition | Комплексный | Возраст покупателя | Нет |
completed-profile-condition | Комплексный | Статус заполненности анкеты | Нет |
choose-external-system | Комплексный | Решает внешняя система | Нет |
payment-type | Комплексный | По типу оплаты | Нет |
cash-nums | Комплексный | Тип "номер кассы" [на которой пробивают чек] | Нет |
segment-condition | Комплексный | Срабатывание рекламной акции по вхождению дисконтной карты в сегмент | Нет |
client-guid-condition | Комплексный | Тип "Клиентские", подтип "Код клиента". | Нет |
country-condition | Комплексный | Тип "Товарные", подтип "Страна производитель" | Нет |
manufacturer-condition | Комплексный | Тип "Товарные", подтип "Производитель" | Нет |
depart-condition | Комплексный | Тип "Товарные", подтип "Отдел" | Нет |
goods-count-condition | Комплексный | Тип "Товарные", подтип "Количество товаров" | Нет |
group-condition | Комплексный | Тип "Товарные", подтип "Товарная группа" | Нет |
sale-group-condition | Комплексный | Тип "Товарные", подтип "Группа продаж" | Нет |
action-results-quantity-condition | Комплексный | Количество раз срабатывания | Нет |
cash-template-condition | Комплексный | Условие срабатывания типа "Шаблоны касс" | Нет |
counter-condition | Комплексный | Условие срабатывания РА "Счётчик срабатывания" | Нет |
external-system-resolution-condition | Комплексный | Условие срабатывания РА: "определяет внешняя система". | Нет |
discount-sum-condition | Комплексный | Условие срабатывания РА: "Сумма скидки по РА" | Нет |
bank-loyalty-code-condition | Комлексный | Код (или коды через запятую) программы лояльности, передаваемый в свойствах оплаты через терминал. | Нет |
external-coupon-condition | Комплексный | Условие срабатывания РА: "Наличие внешнего купона" |
<externalConditions> <country-condition> <condition country-code="GER" count-condition-type="LESS" count="44.879"/> <condition country-code="SWE"/> </country-condition> <manufacturer-condition> <condition manufacturer-code="31" /> <condition manufacturer-code="21" count-condition-type="EQUAL" count="138.63"/> </manufacturer-condition> <depart-condition> <condition depart-number="84"/> <condition depart-number="46" count-condition-type="LESS" count="66.6"/> </depart-condition> <goods-count-condition count-condition-type="MORE" count="13.49" rang="2.0"/> <group-condition with-or="false"> <condition group-code="5555" count-condition-type="EQUAL" count="1235.082" unique-goods="true" sum-condition-type="LESS" sum="14.66"/> <condition group-code="444" /> </group-condition> <sale-group-condition with-or="true"> <condition group-code="5"/> <condition group-code="4" count-condition-type="LESS" count="1.1" unique-goods="true" sum-condition-type="LESS" sum="876.68"/> </sale-group-condition> </externalConditions> |
<InternalCardsCondition>
AdvertisingActions/AdvertisingAction/externalConditions/InternalCardsCondition | ||||
Наименование атрибута | Размер | Тип данных | Описание | Обязательное |
guid | 128 | String | Guid категории карт в SR10 | Да |
anyCard | Boolean | Флаг-признак: сойдет ли любая внутренняя карта для срабатывания этой РА | ||
without-card | Boolean | Флаг-признак: «без карты» — то есть, данное условие срабатывания рекламной акции будет выполнено/удовлетворено если в чеке не была применена никакая внутренняя карта. Cамо значение атрибута не анализируется: достаточно самого факта, что этот атрибут есть |
<ExternalCardsCondition>
AdvertisingActions/AdvertisingAction/externalConditions/ExternalCardsCondition | ||||
Наименование атрибута | Размер | Тип данных | Описание | Обязательное |
guid | 128 | String | guid категории карт в SetRetail10 | Да |
providerName | 128 | String | Идентификатор внешней системы для загрузки рекламных акций с условием "Наличие внешней плагинной карты" Уникальный идентификатор конкретного плагина необходимо получить у разработчика этого плагина. На момент загрузки РА плагин должен быть уже подключен на сервере. | Нет |
without-card | Boolean | Флаг-признак: «без карты» — то есть, данное условие срабатывания рекламной акции будет выполнено/удовлетворено если в чеке не была применена никакая внутренняя карта. Cамо значение атрибута не анализируется: достаточно самого факта, что этот атрибут есть | Нет |
<?xml version="1.0" encoding="UTF-8"?> <AdvertisingActions> <AdvertisingAction AdvertActGUID = "444" name="Условие - внешняя карта плагин" active="true" mode="automatic" priority="10.0" ignoreRestrictions="false" worksAnyTime="false" color="red" external-code="666" deleted="false"> <begin-date>2012-12-01T18:00:00.000</begin-date> <end-date>2050-12-01T18:00:00.000</end-date> <actionResults> <calculation value-type = "CATALOG_PRICE" value = "4.0" secondary-value=""/> </actionResults> <externalConditions> <ExternalCardsCondition providerName="ru.crystals.plugins.card.loymax"/> </externalConditions> </AdvertisingAction> </AdvertisingActions> |
<HoursActionCondition>
AdvertisingActions/AdvertisingAction/externalConditions/HoursActionCondition | ||||
Наименование атрибута | Размер | Тип данных | Описание | Обязательное |
timeStart | 5 | String | Начало периода действия в формате: | Да |
timeEnd | 5 | String | Окончание периода действия в формате: | Да |
<DaysActionCondition>
AdvertisingActions/AdvertisingAction/externalConditions/DaysActionCondition | ||||
Наименование атрибута | Размер | Тип данных | Описание | Обязательное |
value | 20 | String | Указываются дни списком через пробел "MO TU WE TH FR SA SU» | Да |
<couponsCondition>
AdvertisingActions/AdvertisingAction/externalConditions/couponsCondition | ||||
Наименование атрибута | Размер | Тип данных | Описание | Обязательное |
guid | 128 | String | guid категории купонов в SetRetail10 | Да |
number | 32 | String | Номер купона, который нужно применить для работы акции | Да |
<PurchaseAmount>
AdvertisingActions/AdvertisingAction/externalConditions/PurchaseAmount | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
greater-than | Double | Сумма чека, которую должен превышать чек для срабатывания условия | Нет |
less-than | Double | Сумма чека, меньше которой должен быть чек для срабатывания условия | Нет |
equal-to | Double | Определяет сумму чека, при которой РА может сработать | Нет |
useNominalSum | Boolean | Использовать номинальную сумму чека при расчете условия, в противном случае сумма чека будет расчитываться как сумма позиций участвующих в расчете скидок.
| Нет |
<birthday-condition>
AdvertisingActions/AdvertisingAction/externalConditions/birthday-condition | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
days-before | nonNegativeInteger | Количество дней до дня рождения клиента. По умолчанию — 0 | Нет |
days-after | nonNegativeInteger | Количество дней после дня рождения клиента. По умолчанию – 0 | Нет Если не указаны оба параметра, или оба = 0, акция работает только в день рождения клиента |
<age-condition>
AdvertisingActions/AdvertisingAction/externalConditions/age-condition | ||||
Наименоване элемента | Тип данных | Описание | Обязательное | |
age-conditionи | Комплексный | Список условий возрастный ограничений | Нет | |
age-interval | Комплексный | Интервалы возрастов | Да | |
Наименование атрибута | Тип данных | Описание | Обязательное | |
left | Integer | Начало интервала. Если отсутствует, то интервал открыт слева (т.е., распознается как интервал начинающийся в минус бесконечности) | Нет | |
right | Integer | Окончание интервала. Если отсутствует, то интервал открыт справа (т.е., распознается как интервал заканчивающийся в плюс бесконечности) | Нет |
<choose-external-system>
AdvertisingActions/AdvertisingAction/externalConditions/choose-external-system | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
enabled | Boolean | Флаг-признак включения. Если присутствует тег, то включено даже без параметра. | Нет |
Условие заполненности анкеты покупателя <completed-profile-condition>
AdvertisingActions/AdvertisingAction/externalConditions/completed-profile-condition | |||
Наименование атрибута | Тип данных | Описание | Обязательное |
expected-profile-status | Boolean | Ожидаемый статус заполненности анкеты для работы акции. True – анкета должна быть заполнена, False – анкета не заполнена | Да |
<payment-type>
AdvertisingActions/AdvertisingAction/externalConditions/payment-type | |||
Наименование элемента | Тип данных | Описание | Обязательное |
value | String | Указывается тип оплаты применении которого будет рассчитываться результат скидки. Начиная с версии 10.2.95.0 можно указывать несолько типов оплат. Типы оплат:
| Нет Должен быть указан один из параметров |
<cash-nums>
AdvertisingActions/AdvertisingAction/externalConditions/cash-nums | |||
Наименование элемента | Тип данных | Описание | Обязательное |
includes | String | Номера касс, на которых должна работать акция (перечисление через, или) | Нет |
excludes | String | Номера касс, на которых не должна работать акция (перечисление через, или). На остальных кассах акция будет работать | Нет Должен быть указан один из параметров |
<segment-condition>
AdvertisingActions/AdvertisingAction/externalConditions/segment-condition | |||||
segment-orand-only-filterGroup Группа позволяет использование только одного условия фильтрации типа "И" или "ИЛИ" в элементе | |||||
Наименование элемента | Тип данных | Описание | Обязательное | ||
or | Комплексный | Условие добавления сегментов по «или», т.е. для срабатывания клиент должен находится в любом из указанных сегментов | Да | ||
internal-segment-conditionfilterGroup Способ описания "внутренних" ("вложенных" во внешний элемент типа ИЛИ, И, или КРОМЕ) множеств сегментов | |||||
Наименование элемента | Тип данных | Описание | Обязательное | ||
segment | Комплексный | Самый простой и базовый способ определения множества сегментов: перечислением их по GUID'ам. Сам список будет определять объединение сегментов (логическое ИЛИ). | Да | ||
guid | String | GUID сегмента | Да | ||
internal-segment-non-flat-condition-filterGroup Группа элементов, описавыющая "сегментное множество", в которое должен попадать картоносец для удовлетворения условию срабатывания рекламных акций Разрешается заполнять только один из нижеперечисленных элементов | |||||
or | Комплексный | Сегменты, вложенные в этот элемент, взаимодействуют по логическому "ИЛИ" (объединение сегментов)
| Нет | ||
and | Комплексный | Сегменты, вложенные в этот элемент, взаимодействуют по логическому "И" (пересечение сегментов)
| Нет | ||
not | Комплексный | Данный элемент добавляет логическое отрицание множества сегментов в него "вложенного".
| Нет | ||
and | Комплексный | Условие добавления сегментов по «и», т.е. для срабатывания клиент должен находиться во всех указанных сегментах. | Да | ||
internal-segment-conditionfilterGroup Способ описания "внутренних" ("вложенных" во внешний элемент типа ИЛИ, И, или КРОМЕ) множеств сегментов | |||||
Наименование элемента | Тип данных | Описание | Обязательное | ||
segment | Комплексный | Самый простой и базовый способ определения множества сегментов: перечислением их по GUID'ам. Сам список будет определять объединение сегментов (логическое ИЛИ). | Да | ||
guid | String | GUID сегмента | Да | ||
internal-segment-non-flat-condition-filterGroup Группа элементов, описывающая "сегментное множество", в которое должен попадать картоносец для удовлетворения условию срабатывания рекламных акций Разрешается заполнять только один из ниже-перечисленных элементов | |||||
or | Комплексный | Сегменты, вложенные в этот элемент, взаимодействуют по логическому "ИЛИ" (объединение сегментов)
| Нет | ||
and | Комплексный | Сегменты, вложенные в этот элемент, взаимодействуют по логическому "И" (пересечение сегментов)
| Нет | ||
not | Комплексный | Данный элемент добавляет логическое отрицание множества сегментов в него "вложенного".
| Нет |
<segment-condition> <or> <and> <segment guid=”A” /> <segment guid=”B” /> </and> <not> <and> <segment guid=”C” /> <segment guid=”D” /> </and> </not> </or> </segment-condition> |
<client-guid-condition>
AdvertisingActions/AdvertisingAction/externalConditions/client-guid-condition | ||||
Наименование элемента | Тип данных | Описание | Обязательное | |
suffixes | Комплексный | Список окончаний кодов клиентов | Нет | |
condition | Комплексный | Тип условия:
| Нет | |
suffix | Комплексный | Окончание | Нет |
<action-results-quantity-condition>
<cash-template-condition>
AdvertisingActions/AdvertisingAction/externalConditions/cash-template-condition | ||||
Наименование элемента | Тип данных | Описание | Обязательное | |
template-guid | long | GUID шаблонов | Нет |
<counter-condition>
AdvertisingActions/AdvertisingAction/externalConditions/counter-condition | ||||
Наименование атрибута | Тип данных | Описание | Обязательное | |
counter-id | String | Идентификатор счётчика
| Да | |
main-value | Integer | Целевое значение, с которым будет проводиться сравнение текущего значения счётчика для клиента | Да | |
second-value | Integer | Второе значение для условия BETWEEN | Если comparison-type = "BETWEEN" | |
comparison-type | Комплексный | Оператор сравнения. Возможные значения:
| Да | |
include-current-purchase | Boolean | Флаг: С учётом текущей покупки. Работает только для счётчиков с метриками Чеки, Товары и показателем Количество.
| Нет |
Последовательность импорта
Рекомендуется использовать вариант 1, только так гарантируется прозрачная и чёткая последовательность.
<?xml version="1.0" encoding="UTF-8"?> <AdvertisingActions> <AdvertisingAction name="Скидка. Счетчики в условиях" active="true" mode="automatic" priority="10" ignoreRestictions="false" worksAnyTime="false" color="red"> <begin-date>2012-12-01T18:00:00</begin-date> <end-date>2050-12-01T18:00:00</end-date> <externalConditions> <counter-condition counter-id="SUM_CHEQUE" main-value="20000" comparison-type="MORE"/> <counter-condition counter-id="ITEMS_COUNT" main-value="2000" second-value="5000" comparison-type="BETWEEN"/> </externalConditions> <actionResults> <calculation value-type="PERCENT" value="33"/> </actionResults> </AdvertisingAction> </AdvertisingActions> |
<external-system-resolution-condition>
AdvertisingActions/AdvertisingAction/externalConditions/external-system-resolution-condition | |||
Наименование элемента | Тип данных | Описание | Обязательное |
external-system-resolution-condition | Integer | Условие срабатывания РА: "определяет внешняя система". | Нет |
Наименование элемента | Тип данных | Описание | Обязательное |
providerName | String | Идентификатор внешней системы | Да |
<?xml version="1.0" encoding="utf-8"?> <AdvertisingActions> <AdvertisingAction name="SR-3206" active="true" mode="automatic" priority="10000" ignoreRestictions="true" worksAnyTime="false" сolor="Red"> <begin-date>2012-02-21T00:00:00Z</begin-date> <end-date>2025-02-20T00:00:00Z</end-date> <externalConditions> <external-system-resolution-condition> <providerName>ru.crystals.globus.sap.condition.plugin</providerName> </external-system-resolution-condition> </externalConditions> <actionResults> <goodsDiscount name = "10% скидки на бородинский" discountPercent = "10.0"> <!-- Хлеб КАРАВАЙ Бородинский 350 г --> <marking-of-the-good id = "055666_ST" /> </goodsDiscount> <bonus type="DiscountFromCheck" accountType="Глобус"/> </actionResults> </AdvertisingAction> </AdvertisingActions> |
<discount-sum-condition>
<bank-loyalty-code-condition>
<external-coupon-condition>
<pricetag-type>
AdvertisingActions/AdvertisingAction/pricetag-type | ||||
Наименование элемента | Тип данных | Описание | Обязательное | |
pricetag-type | list | Типы ценников, что надо распечатать на данную акцию Допускается только одно повторение элемента в рекламной акции. Если требуется указать два типа ценника: Акционный и Скидочный (дополнительный/замещающий), тогда они должы быть перечислены через пробел:
| Нет |
<pricetag-template>
AdvertisingActions/AdvertisingAction/pricetag-template | ||||
Наименование атрибута | Тип данных | Описание | Обязательное | |
count | PositiveInteger | Количество ценников данного шаблона, что надо распечатать в автоматическом режиме | Нет |
<template-format>
<actionLabels>
AdvertisingActions/AdvertisingAction/actionLables | |||
Поле | Тип данных | Описание | Обязательное |
label | String | Наименование метки рекламной акции | Нет |
В одной рекламной акции может быть до 5 меток.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <AdvertisingActions> <AdvertisingAction name="SR2823 Акция с метками" active="true" mode="automatic" priority="4236.0" ignoreRestictions="false" worksAnyTime="false" color="violet" external-code="SR10_763893" deleted="false" discountType="9"> <begin-date>2019-04-04T12:10:45.498</begin-date> <end-date>2200-12-31T16:02:34.482</end-date> <actionResults> <calculation value-type="PERCENT" value="10" secondary-value=""/> </actionResults> <actionLabels> <label>Скидки поставщиков</label> </actionLabels> </AdvertisingAction> </AdvertisingActions> |
Загруженная из ERP Рекламная акция может быть остановлена из ERP двумя способами:
При использовании тега deleted достаточно загрузить только признак удаления и код акции без остального содержимого |
<AdvertisingActions> <AdvertisingAction name=”Скидка на количество по карте (зависит от 2й цены)” active=”true” mode=”automatic” priority=”1” ignoreRestictions=”true” worksAnyTime=”false” color=”green” external-code=”SR10_001”> <dependence key=”external-code” value=”SR10_1363”/> <dependence key=”external-code” value=”SR10_1364”/> <begin-date>2012-10-21T00:00:00Z</begin-date> <end-date>2012-11-31T00:00:00Z</end-date> <actionResults> <catalog> <marking-of-the-good id = “3850114202480” discountStart = “2.000” fixedPrice = “1000.00” maxQuantity = “43534.00”/> </catalog> </actionResults> <externalConditions> <InternalCardsCondition guid=”1359”/> </externalConditions> </AdvertisingAction> </AdvertisingActions> |