Информация
Для чтения визуальной составляющей схемы XSD, а также типами обязательных данных, ознакомьтесь с правилами использования.

Рекламные акции `<AdvertisingActions>`

AdvertisingActionAdvertisingActions

Коллекция рекламных акций

...

AdvertisingActions/AdvertisingAction

Заголовок Рекламной акции

Наименование атрибута

Размер

Тип данных

Описание

Обязательное

advertActGUID

Integer

Не требуется заполнение поля из ERP

Нет

name

255

String

Наименование РА

Да

active

Boolean

Для загрузки активных акций всегда передавать true

Да

mode

13

String

Тип условия применения РА.

automatic – – автоматическое срабатывание при срабатывании всех условий, описанных в блоке условий externalConditions
by-condition – с условиями – срабатывание при срабатывании одного любого из условий, описанных в блоке условий externalConditions
manual – ручная скидка
unconditional – безусловное срабатывание

Да

priority

15

Double

Приоритет (только для схемы работы акций по приоритету, акция с приоритетом 1 более приоритетная, чем акция с приоритетом 1000). По умолчанию 1000.

При загрузке значение должно быть равным 1 и более.

Нет

ignoreRestictions

Информация
В данном параметре отсутствует буква r для слова restrictions

Boolean

Признак игнорирования ограничений на применение скидки в данных товаров

true – акция игнорирует ограничения
false – акция учитывает ограничения

Нет

ignoreRestrictions

Начиная с версии

Статус

colour	Blue
title	10.2.75.8

Статус

colour	Blue
title	10.2.76.3

Статус

colour	Blue
title	10.2.77.0

можно использовать, как новый параметр, так и предыдущий ignoreRestictions

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SR-3219

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SR-3563

Boolean

Признак игнорирования ограничений на применение скидки в данных товаров

true – акция игнорирует ограничения
false – акция учитывает ограничения

Нет

worksAnyTime

Boolean

true – скидка по данной РА суммируется со всеми остальными акциями в случае конфликтов нескольких скидок на один товар.
false – скидка по данной РА не суммируется с другими скидками, скидка участвует в схеме взаимодействия акции, установленной в SetRetail10

Да

color

7

String

Цвет маркировки рекламной акции.

Используется для визуализации акции в SetRetail10,

Blue (по - умолчанию)
Yellow
Orange
Green
Red
Violet

Нет

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

Тип ценника, который должен печататься на товары этой акции.
NONE — на акцию не надо печатать никакие ценники
ACTION — акционный ценник
ADDITIONAL — дополнительный ценник
REPLACEMENT — замещающий ценник

Нет

template-format

255

String

Внешний код формата шаблонов ценников.

Нет

Блоки содержимого Рекламной акции

Блок

Описание

dependence

Блок позволяет управлять из ERP зависимостью загружаемых РА от других акций, ранее загруженных в систему. Необязательный блок данных

externalConditions

Условия применения данной РА, акция сработает только при соблюдении всех указанных в акции условий. Если условия не указаны, акция действует для всех покупателей. Необязательный блок данных, заполняется только при mode = automatic

actionResults

Применяемые скидки в рамках данной Рекламной акции. Обязательный блок данных

pricetag-template

Коды ценников, которые должны печататься по умолчанию на товары этой акции.

actionLablesactionLabels

Метки рекламной акции

Зависимости `<dependence>`

...

Таким образом могут быть построены классические схемы расчета скидок, например, дополнительные скидки действуют от цен по дисконтной карте (акции на применение второй цены) .

Примечание

title	Важно:

Данный блок не является обязательным, вы не обязаны использовать зависимости в ваших маркетинговых программах.

...

Наиманоение Наименование элемента	Размер	Тип данных	Описание	Обязательное
AdvertisingActions/AdvertisingAction/dependence

key	255	String	Всегда заполняется значением 'external-code'	Да
value	255	String	External-code уже существующей акции, от которой должна быть установлена зависимость.	Да

...

AdvertisingActions/AdvertisingAction/actionResults

Image RemovedImage Added

Блок

Описание

set

Скидки на наборы

catalog

Каталог фиксированных цен на товары

goodsDiscount

Процентные и суммовые скидки на товары, группы товаров и группы продаж

calculation

Скидки на чек целиком

bonus-discount

Бонусы в качестве скидки

tokens-discount

Фишки в качестве скидки

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	CR-2932

Статус

colour	Blue
title	10.2.83.0

Статус

colour	Blue
title	10.2.84.0

counter

Счётчик

.84.0

counter

Счётчик

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SLS-261

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SLS-256

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SLS-261259

Статус

colour	Blue
title	10.2.75.0

coupon

Печать купона

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SLSSR-2565169

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SLSCR-2596133

Статус

colour	Blue
title	10.23.755.0

bonus

Бонусы на счёт

notification

Вторичный результат срабатывания акции. Сообщение или информирование.

productOffer

Тип результата применения РА: предложение по добавлению товара в чек

...

Наименование атрибута	Размер	Тип данных	Описание	Обязательное
AdvertisingActions/AdvertisingAction/actionResults/set

name	64	String	Название набора внутри акции	Да
valueType	64	String	Тип скидки на строки набора: percent – процент скидки fixedPrice – фиксированная цена	Да
value	15	Double	Стоимость набора целиком	Нет
wholesale-restriction	4294967295	Integer	Установленное оптовое ограничение (количество наборов со скидкой за сутки для одного покупателя)	Нет
maxQuantity	3	Integer	Максимальное количество наборов в чеке со скидкой	Нет
calcWeightProductCountAsOne		Boolean	Принцип учета количества весовых позиций в наборе false – количество весового товара = равно его суммарному весу true – количество весового товара = равно количеству позиций вне зависимости от их веса По умолчанию false	Нет
isSpreadDiscounts		Boolean	Говорит о том, что скидки на подарочные позиции будут размазаны по всему набору равномерно с учетом цен компонентов	Нет

...

Наименование атрибута	Размер	Тип данных	Описание	Обязательное
AdvertisingActions/AdvertisingAction/actionResults/set/row

requiedQuantity	4294967295	integer	Определяет кол-во единиц товара в строке, которого достаточно чтобы набор сработал	Да
discountPercent	15	Double	% скидки на товар в данной строке (не актуально при указании стоимости набора целиком)	Нет
fixedPrice	15	Double	Фиксированная акционная цена товара в данной строке (не актуально при указании стоимости набора целиком)	Нет
groupName	32	String	Название списка товаров (используется только при создании списка товаров в строке)	Нет

...

Задает множество товарных групп (по их кодам), что ограничивают множество товаров, удовлетвояющих удовлетворяющих данному критерию. Можно указать любое количество элементов.

...

Задает множество производителей (по их кодам), что ограничивают множество товаров, удовлетвояющих удовлетворяющих данному критерию. Можно указать любое количество элементов.

...

Множество стран (по их кодам), что ограничивают множество товаров, удовлетвояющих удовлетворяющих данному критерию.

Можно указать любое количество элементов.

...

AdvertisingActions/AdvertisingAction/actionResults/goodsDiscount

Image RemovedImage Added

Наименование атрибута

Тип данных

Описание

Обязательное

name

String

Название скидки

Нет

calcWeightProductCountAsOne

Boolean

Принцип учета количества весовых позиций в скидках с количественными ограничениями

false – количество весового товара = равно его суммарному весу
true – количество весового товара = равно количеству позиций вне зависимости от их веса По умолчанию false|

Нет

maxQuantity

Double

Определяет максимальное кол-во товара в чеке, которое будет продано по акции.

Нет

discountPercent

Double

Процент скидки на товар

Нет

discountSum

Double

Сумма скидки на товар

Нет

fixPrice

Double

Фиксированная цена каждой единицы товара из этой группы

Нет

goodsSum

Double

Сумма скидки при покупке товаров из этой группы.

Распределяется пропорционально стоимости товаров этой группы.

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	CR-3655

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SR-3702

Статус

colour	Blue
title	10.2.82.0

Нет

discountStart

Double

Определяет позицию, начиная с которой на этот товар будет начисляться скидка

Нет

conditionCount

Double

Определяет количество товара, при покупке которого на все количество этого товара будет дана скидка

Нет

wholesale-restriction

Double

Установленное оптовое ограничение (количество товара, групп товаров, групп продаж и пр. со скидкой за сутки для одного покупателя)

Нет

allowOffline

Boolean

Разрешать расчет без получения данных об ограничениях из внешней системы

Нет

for-gifts-only

Boolean

Предоставлять скидку только для подарков

Статус

colour	Blue
title	10.2.89.0

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SR-4019

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SR-4020

Нет

for-soft-check-only

Boolean

Предоставлять скидку только для товаров из мягкого чека.

Статус

colour	Blue
title	10.3.4.0

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SR-40205161

Нет

plugin-id

String

Идентификатор плагина в рамках РА

Нет

Наименование элемента

Тип данных

Описание

Обязательное

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

Комплексный

Ограничение по сумме скидки РА по клиенту

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SLS-382

Статус

colour	Blue
title	10.2.80.0

Нет

storage-time-condition

Комплексный

Импорт скидки на товары со сроком годности, близким к истечению

Условие "до истечения срока годности"

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SR-3610

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SR-3671

Статус

colour	Blue
title	10.2.80.0

Нет

action-label-exclude

String

Признак (метка рекламной акции), по которому товары, участвующие в акции с данной меткой, исключаются из текущей акции

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SR-4928

Статус

colour	Blue
title	10.3.0.0

Нет

...

Наименование элемента		Тип данных	Описание	Обязательное
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/exclude

exclude		Комплексный	Группа элементов, описывающая некий товарный фильтр	Нет
goods-filterGroup Данный атрибут не указывается в XML-сообщении. Он определяет группу элементов на схеме.			Группа элементов, описывающая товарный фильтр	Нет
	marking-of-the-good	Комплексный	Артикулы (коды товаров), на которые будут установлены скидки	Нет
	goodsGroup	Комплексный	Список товаров	Нет
	group	Комплексный	Идентификатор отварной группы	Нет
	sale-group	String	Список идентификаторов (кодов) групп продаж, товары из которых удовлетворяют данному фильтру	Нет

Группа элементов, описывающая товарный фильтр `<goods-filterGroup>`

...

Наименование элемента		Тип данных	Описание	Обязательное
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/calculation

Наименование атрибута

Тип данных

Описание

ОбяазтельноеОбязательное

value-type

String

Тип скидки на чек из списка ниже

CATALOG_PRICE - Дать цену на товары в чеке из справочника товаров (вторые, третьи и четвертые цены). Value определяет номер цены из справочника.
COUPON - Взять скидку из примененного на кассе скидочного купона, ранее распечатанного на кассе как результат рекламной акции. Value подразумевает максимальной процент оплаты купоном в чеке.
DISCCARD - Дать скидку по дисконтной карте, процент скидки берется из данных категории карты, предъявленной клиентом. Value не заполняется.
EXTERNAL_LOYALTY - Результаты рекламной акции определяются сторонним поставщиком лояльности
FIXSUMM - Суммовая скидка на чек, value определяет значение скидки
PAYMENT_TYPE_PERCENT - Размер скидки определяется возвратным/чековым купоном
PERCENT - Процент скидки на чек, value определяет значение скидки.
PERSONAL_OFFER - Размер скидки определяется на основе персональных предложений (от внешних поставщиков лояльности)
ROUND - Скидка на округление, value определяет масштаб округления (например, 0.1 означает округление до 10 коп)
ROUND_BY_POSITIONS - Попозиционное округление
SALES_TAX_DISCOUNT - Скидка на налог с продаж
- Статус
  colour Blue
  title 10.2.95.0
- Устаревшая версия Jira
  server System JIRA
  columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
  serverId bc8d3685-f9c0-329d-9054-b12aabbcb834
  key SR-4535
- Устаревшая версия Jira
  server System JIRA
  columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
  serverId bc8d3685-f9c0-329d-9054-b12aabbcb834
  key CR-4589
- Полное описание интеграции и примеры работы Киргизия ◾️ Налог с продаж (НСП).
WHOLESALE_DISCOUNT - Оптовые скидки. Значение скидки зависит от количество товара. secondary-value = true или false.

Да

value

Decimal

Значение, дополняющее тип скидки

Является обязательным только для тех типов скидок, для которых определен в value-type
Размер процента скидки (например, "7.5" = 7.5%), если Принцип вычисления = PERCENT;
Размер скидки, в "рублях", если Принцип вычисления = FIXSUMM;
"Кратность" округления, в "рублях", если Принцип вычисления = ROUND:
- если, "0.1" - округление с точностью до 10 "копеек";
- "1.57" - округление с точностью до 1 "рубля" и 57 "копеек" - т.е., с клиента потребуют наибольшую сумму, кратную 1.57, но меньшую суммы покупки)
Номер цены ("2", "3", "4"), что использольвать использовать при расчете, если Принцип вычисления = CATALOG_PRICE;
Максимальный процент скидки от суммы чека, если Принцип вычисления = COUPON;
Процент от суммы отплаты (указанного типа - см. атрибут "secondary-value"), если Принцип вычисления = PAYMENT_TYPE_PERCENT;
Этот атрибут игнорируется, если Принцип вычисления = DISCCARD;

Да

secondary-value

String

Дополнительное значение для плагинов скидок:

Только для принципа вычисления = PAYMENT_TYPE_PERCENT и содержит название типа оплаты, от размера которого и считать скидку.

Например, если значение этого атрибута BankCardPaymentEntity, и при покупке использовали 50 рублей оплаты по банковской карте и еще 800 - другие типы оплат, то скидка будет считаться только от 50 рублей)

Типы оплат:

CashPaymentEntity - оплата наличными
CashMachinePaymentEntity - Оплата наличными (купюроприемник)
BankCardPaymentEntity - Оплата по банковской карте
BonusCardPaymentEntity - Оплата по бонусной карте
GiftCardPaymentEntity - Оплата по подарочной карте
ExternalBankTerminalPaymentEntity - Внешний банковский терминал
ConsumerCreditPaymentEntity - Потребительский кредит
CFTGiftCardPaymentEntity - Оплата по подарочной карте ЦФТ
SiebelBonusCardPaymentEntity - Оплата по бонусной карте Siebel
ChildrenCardPaymentEntity - Оплата по Детской карте
CFTEGCPaymentEntity - Оплата по ЭПС ЦФТ
SupraPaymentEntity - Оплата по карте Супра
PrepaymentEntity - Зачет предоплаты
SiebelBonusesForGiftPaymentEntity - Бонусы на подарок
SiebelGiftCardPaymentEntity - Оплата по подарочной карте Siebel
KopilkaPaymentEntity - Оплата по бонусной карте Копилка

Ещё используется для хранения значения флага "Учитывать оптовое ограничение": также применяется только если принцип вычисления = EXTERNAL_LOYALTY и
содержит имя внешнего процессинга лояльности, определяющего результат рекламной акции. Соответствующая рекламная акция создается, чтобы включить работу процессинга.

Список процессингов /standalone/configuration/modules/external-systems-manager/service-providers.xml

Нет

...

Блок кода

language	xml
title	Пример XML:

<?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>

Печать купона `<coupon>`

Включить страницу

	Загрузка рекламной акции с результатом Печать купона
	Загрузка рекламной акции с результатом Печать купона

Бонусы на счёт `<bonus>`

AdvertisingActions/AdvertisingAction/actionResults/bonus

Наиманование Наименование атрибута

Тип данных

Описание

Обязательное

type

String

Принцип вычисления бонуса. (Поддерживается только "DiscountFromCheck" - процент от суммы чека)

Да

sponsor

String

Спонсор бонусной программы (CRM, спасибо от сбербанка, внутренние бонусы (SET10), ...).
Если отсутствует, то по умолчанию = "BONUS_SR10" (бонусы SET10).

Нет

accountTypeId

Long

Указатель на тип счёта

Нет

bonusValue

Long

Число, количественно характеризующее размер начисляемых бонусов. Смысл этого числа зависит от принцина принципа начисления.

для "AMOUNTPERCENT" это количество сотых долей процента от суммы чека. т.е. 1000 = 10%;
для "MULTIPLEPERCENT" - аналогично: это количество сотых долей процента от суммы чека. т.е. 1000 = 10%;
для "FIXBONUS" это конкретное количество "бонусо-копеек", что надо начислить;
для остальных принципов начисления данное поле не имеет смысла.

Нет

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

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SR-3717

Статус

colour	Blue
title	10.2.91.0

dateTime

Дата начала действия бонусов

Атрибут beginDate является обязательным, при наличии атрибута endDate

При отсутствии атрибутов beginDate и endDate интервал дат действия бонусов будет определен как "Действует всегда".

Пример загрузки акции.

Нет

endDate

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SR-3717

Статус

colour	Blue
title	10.2.91.0

dateTime

Дата окончания действия бонусов

Атрибут endDate является обязательным, при наличии атрибута beginDate

При отсутствии атрибутов beginDate и endDate интервал дат действия бонусов будет определен как "Действует всегда".

Пример загрузки акции.

Нет

Наиманование Наименование элемента

Тип данных

Описание

Обязательное

bonus-accrual-rule

Комплексный

Правила начисления бонусов в зависимости от размера оплаты по банковской карте

Нет

tokens-accrual-rule

Комплексный

Правило начисления фишек

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	CR-2932

Статус

colour	Blue
title	10.2.83.0

Статус

colour	Blue
title	10.2.84.0

Нет

product-row

Комплексный

Набор строк определяющий товары/группы продаж/товарные группы с которых не будут начислены ББ

Нет

...

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			Список	Тип значения, на которое смотрим в чеке: SUM - сумма товаров COUNT - количество товаротоваров	Нет
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	Список идентификаторов (артикулов) товаров	Нет

...

AdvertisingActions/AdvertisingAction/actionResults/bonus/product-row

Наиманование Наименование атрибута	Тип данных	Описание	Обязательное
description	String	Название списка товаров	Нет
Наименование элемента	Тип данныданных	Описание	Обязательное
group	String	Идентификатор (код) ТОВАРНОЙ группы	Нет
sale-group	String	Идентификатор (код) группы продаж	Нет
marking	String	Список идентификаторов (артикулов) товаров	Нет

...

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	Список идентификаторов (артикулов) товаров, что участвуют при вычислении количества "преференций".	Нет

...

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	Список идентификаторов (артикулов) товаров, что участвуют при вычислении количества "преференций".	Нет

...

AdvertisingActions/AdvertisingAction/actionResults/notification/validation

Наименование атрибута

Тип данных

Описание

Обязательное

enable

Boolean

Включена или выключена валидация

Нет

adds-as-products

Boolean

Добавлять подарки в чек как товары

Статус

colour	Blue
title	10.2.89.0

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SR-4019

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SR-4020

Нет

Наименование элемента

Тип данных

Описание

Обязательное

barcode

String

Штрихкод подарка (используется только при выключенной опции "Добавлять подарки в чек как товары")

Нет

marking

String

Код (артикул) товара-подарка (используется только при включенной опции "Добавлять подарки в чек как товары")

Статус

colour	Blue
title	10.2.89.0

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SR-4019

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SR-4020

Нет

Блок кода

language	xml
title	Пример импорта рекламной акции с товаром-подарком

<?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>

...

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

Комплексный

Условие срабатывания РА "Счётчик срабатывания"

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SLS-270

Статус

colour	Blue
title	10.2.75.0

Нет

external-system-resolution-condition

Комплексный

Условие срабатывания РА: "определяет внешняя система".

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SR-3206

Статус

colour	Blue
title	10.2.72.0

Нет

discount-sum-condition

Комплексный

Условие срабатывания РА: "Сумма скидки по РА"

Устаревшая версия Jira

server	System JIRA
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SLS-369

Статус

colour	Blue
title	10.2.78.0

Нет

bank-loyalty-code-condition

КомлексныйКомплексный

Код (или коды через запятую) программы лояльности, передаваемый в свойствах оплаты через терминал.

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SR-2891

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	CR-2003

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	CR-2850

Статус

colour	Green
title	10.2.97.0

Нет

external-coupon-condition

Комплексный

Условие срабатывания РА: "Наличие внешнего купона"

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SR-4758

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	CR-5557

Статус

colour	Blue
title	10.2.98.0

...

AdvertisingActions/AdvertisingAction/externalConditions/ExternalCardsCondition

Наименование атрибута

Размер

Тип данных

Описание

Обязательное

guid

128

String

guid категории карт в SetRetail10

Да

providerName

128

String

Идентификатор внешней системы для загрузки рекламных акций с условием "Наличие внешней плагинной карты"

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SR-3359

Статус

colour	Blue
title	10.2.75.0

Уникальный идентификатор конкретного плагина необходимо получить у разработчика этого плагина. На момент загрузки РА плагин должен быть уже подключен на сервере.

Нет

without-card

Boolean

Флаг-признак: «без карты» — то есть, данное условие срабатывания рекламной акции будет выполнено/удовлетворено если в чеке не была применена никакая внутренняя карта.

Cамо значение атрибута не анализируется: достаточно самого факта, что этот атрибут есть

Нет

...

AdvertisingActions/AdvertisingAction/externalConditions/PurchaseAmount

Image RemovedImage Added

Наименование атрибута

Тип данных

Описание

Обязательное

greater-than

Double

Сумма чека, которую должен превышать чек для срабатывания условия

Нет

less-than

Double

Сумма чека, меньше которой должен быть чек для срабатывания условия

Нет

equal-to

Double

Определяет сумму чека, при которой РА может сработать

Нет

useNominalSum

Boolean

Использовать номинальную сумму чека при расчете условия, в противном случае сумма чека будет расчитываться рассчитываться как сумма позиций участвующих в расчете скидок.

true - использовать
false - не использовать

Нет

useSoftCheckSum

Boolean

Учитывать только стоимость товаров из мягкого чека

true - учитывать
false - не учитывать

Статус

colour	Blue
title	10.3.4.0

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SR-5162

Нет

plugin-id

String

Идентификатор плагина в рамках РА

Нет

Условие на день рождения `<birthday-condition>`

...

Счетчик `<counter-condition>`

Устаревшая версия Jira

server	System JIRA
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SLS-270

Статус

colour	Blue
title	10.2.75.0

...

Определяет внешняя система `<external-system-resolution-condition>`

Устаревшая версия Jira

server	System JIRA
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	bc8d3685-f9c0-329d-9054-b12aabbcb834
key	SR-3206

Статус

colour	Blue
title	10.2.72.0

...

AdvertisingActions/AdvertisingAction/pricetag-type

Наименование элемента	Тип данных	Описание	Обязательное
pricetag-type	list	Типы ценников, что надо распечатать на данную акцию Допускается только одно повторение элемента в рекламной акции. Если требуется указать два типа ценника: Акционный и Скидочный (дополнительный/замещающий), тогда они должы быть перечислены через пробел: ACTION - акционный ценник. ADDITIONAL - скидочный (Дополнительный/замещающий) `<pricetag-type>ACTION ADDITIONAL</pricetag-type>`	Нет

Cписок внешних кодов шаблонов

...

ценников `<pricetag-template>`

AdvertisingActions/AdvertisingAction/pricetag-template

Наименование атрибута	Тип данных	Описание	Обязательное
count	PositiveInteger	Количество ценников данного шаблона, что надо распечатать в автоматическом режиме	Нет

...

Сравнение версий

Старая версия 106

Новая версия 115

Ключ

Рекламные акции `<AdvertisingActions>`

Зависимости `<dependence>`

Идентификатор товарной группы со скидкой `<group>`

Группа элементов, описывающая товарный фильтр `<goods-filterGroup>`

Идентификатор товарной группы со скидкой `<group>`

Печать купона `<coupon>`

Бонусы на счёт `<bonus>`

Условие на день рождения `<birthday-condition>`

Счетчик `<counter-condition>`

Определяет внешняя система `<external-system-resolution-condition>`

Cписок внешних кодов шаблонов

ценников `<pricetag-template>`

Сравнение страниц

Сравнение версий

Старая версия 106

Новая версия 115

Ключ

Рекламные акции <AdvertisingActions>

Зависимости <dependence>

Идентификатор товарной группы со скидкой <group>

Группа элементов, описывающая товарный фильтр <goods-filterGroup>

Идентификатор товарной группы со скидкой <group>

Печать купона <coupon>

Бонусы на счёт <bonus>

Условие на день рождения <birthday-condition>

Счетчик <counter-condition>

Определяет внешняя система <external-system-resolution-condition>

Cписок внешних кодов шаблонов

ценников <pricetag-template>

Рекламные акции `<AdvertisingActions>`

Зависимости `<dependence>`

Идентификатор товарной группы со скидкой `<group>`

Группа элементов, описывающая товарный фильтр `<goods-filterGroup>`

Идентификатор товарной группы со скидкой `<group>`

Печать купона `<coupon>`

Бонусы на счёт `<bonus>`

Условие на день рождения `<birthday-condition>`

Счетчик `<counter-condition>`

Определяет внешняя система `<external-system-resolution-condition>`

ценников `<pricetag-template>`