Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Рекламные акции <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

Info

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




Boolean

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

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

ignoreRestrictions

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

Status
colourBlue
title10.2.75.8
 
Status
colourBlue
title10.2.76.3
 
Status
colourBlue
title10.2.77.0
 можно использовать, как новый параметр, так и предыдущий ignoreRestictions

Jira
serverSystem JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverIdbc8d3685-f9c0-329d-9054-b12aabbcb834
keySR-3219

Jira
serverSystem JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverIdbc8d3685-f9c0-329d-9054-b12aabbcb834
keySR-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Признак удаления рекламной акции. Акция останавливается сразу после загрузки признака остановки.Нет
discountType255StringКод типа скидкиНет
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-format255StringВнешний код формата шаблонов ценников.Нет

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

Блок

Описание

dependence

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

externalConditions

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

actionResults

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

pricetag-template

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

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

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

...

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

Note
titleВажно:

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

...

AdvertisingActions/AdvertisingAction/dependence

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

Размер

Тип данных

Описание

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

key

255

String

Всегда заполняется значением 'external-code'

Да

value

255

String

External-code уже существующей акции, от которой должна быть установлена зависимость.

Да

...

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

...

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

...

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

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

...

AdvertisingActions/AdvertisingAction/actionResults/goodsDiscount

Image RemovedImage Added

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

Тип данных

Описание

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

name

String

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

Нет

calcWeightProductCountAsOne

Boolean

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

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

maxQuantity

Double

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

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

discountSum

Double

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

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

goodsSum

Double

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

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

Jira
serverSystem JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverIdbc8d3685-f9c0-329d-9054-b12aabbcb834
keyCR-3655

Jira
serverSystem JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverIdbc8d3685-f9c0-329d-9054-b12aabbcb834
keySR-3702

Status
colourBlue
title10.2.82.0

Нет

discountStart

Double

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

Нет
conditionCountDoubleОпределяет количество товара, при покупке которого на все количество этого товара будет дана скидкаНет
wholesale-restrictionDoubleУстановленное оптовое ограничение (количество товара, групп товаров, групп продаж и пр. со скидкой за сутки для одного покупателя)Нет
allowOfflineBooleanРазрешать расчет без получения данных об ограничениях из внешней системыНет
for-gifts-onlyBoolean

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

Status
colourBlue
title10.2.89.0

Jira
serverSystem JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverIdbc8d3685-f9c0-329d-9054-b12aabbcb834
keySR-4019

Jira
serverSystem JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverIdbc8d3685-f9c0-329d-9054-b12aabbcb834
keySR-4020

Нет
for-soft-check-onlyBooleanПредоставлять скидку только для товаров из МЧНет
plugin-idStringИдентификатор плагина в рамках РАНет
Наименование элементаТип данныхОписаниеОбязательное

goods-filter-includeAndExcludeGroup

Данный атрибут не указывается в XML-сообщении. Он определяет группу элементов на схеме.

Группа элементов, описывающая фильтр, по которому отбираются товары, на которые должна сработать скидка. Только одна из двух опций валидна: либо элемент-галочка "весь товарный справочник", либо группа фильтров "goods-filterGroup".Нет

for-all-goodsBooleanФлаг-признак, указывающий на то, что данная скидка действует на ВЕСЬ ТОВАРНЫЙ СПРАВОЧНИК (за исключением товаров, что удовлетворяют фильтру exclude)Нет
goods-filterGroupКомплексныйГруппа элементов, описывающая некий товарный фильтрНет
excludeКомплексный

Фильтр, определяющий множество товаров, на которые данная скидка НЕ должна сработать.

Данный фильтр имеет приоритет перед группой фильтров "goods-filterGroup" и флагом "for-all-goods": если товар удовлетворяет фильтру "exclude", то скидка на него не будет дана - не зависимо от значения флага "for-all-goods", либо значений фильтров группы "goods-filterGroup"

Нет
client-restrictionКомплексный

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

Jira
serverSystem JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverIdbc8d3685-f9c0-329d-9054-b12aabbcb834
keySLS-382

Status
colourBlue
title10.2.80.0

Нет
storage-time-conditionКомплексныйИмпорт скидки на товары со сроком годности, близким к истечению

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

Jira
serverSystem JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverIdbc8d3685-f9c0-329d-9054-b12aabbcb834
keySR-3610

Jira
serverSystem JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverIdbc8d3685-f9c0-329d-9054-b12aabbcb834
keySR-3671

Status
colourBlue
title10.2.80.0

Нет
action-label-excludeString

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

Jira
serverSystem JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverIdbc8d3685-f9c0-329d-9054-b12aabbcb834
keySR-4928

Status
colourBlue
title10.3.0.0

Нет

...

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 - Скидка на налог с продаж
    • Status
      colourBlue
      title10.2.95.0
    • Jira
      serverSystem JIRA
      columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
      serverIdbc8d3685-f9c0-329d-9054-b12aabbcb834
      keySR-4535
    • Jira
      serverSystem JIRA
      columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
      serverIdbc8d3685-f9c0-329d-9054-b12aabbcb834
      keyCR-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-valueString

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

Только для принципа вычисления = 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

Нет

...

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
serverSystem JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverIdbc8d3685-f9c0-329d-9054-b12aabbcb834
keySLS-270

Status
colourBlue
title10.2.75.0

Нет
external-system-resolution-conditionКомплексный

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

Jira
serverSystem JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverIdbc8d3685-f9c0-329d-9054-b12aabbcb834
keySR-3206

Status
colourBlue
title10.2.72.0

Нет
discount-sum-conditionКомплексный

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

Jira
serverSystem JIRA
serverIdbc8d3685-f9c0-329d-9054-b12aabbcb834
keySLS-369

Status
colourBlue
title10.2.78.0

Нет
bank-loyalty-code-conditionКомлексныйКомплексный

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

Jira
serverSystem JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverIdbc8d3685-f9c0-329d-9054-b12aabbcb834
keySR-2891

Jira
serverSystem JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverIdbc8d3685-f9c0-329d-9054-b12aabbcb834
keyCR-2003

Jira
serverSystem JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverIdbc8d3685-f9c0-329d-9054-b12aabbcb834
keyCR-2850

Status
colourGreen
title10.2.97.0

Нет
external-coupon-conditionКомплексный

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

Jira
serverSystem JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverIdbc8d3685-f9c0-329d-9054-b12aabbcb834
keySR-4758

Jira
serverSystem JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverIdbc8d3685-f9c0-329d-9054-b12aabbcb834
keyCR-5557

Status
colourBlue
title10.2.98.0





...

AdvertisingActions/AdvertisingAction/externalConditions/PurchaseAmount

Image Added

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

Тип данных

Описание

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

greater-than

Double

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

Нет

less-than

Double

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

Нет

equal-to

Double

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

Нет
useNominalSumBoolean

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

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

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

  • true - учитывать 
  • false - не учитывать
Нет
plugin-idStringИдентификатор плагина в рамках РАНет

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

...

AdvertisingActions/AdvertisingAction/pricetag-type

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

Тип данных

Описание

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

pricetag-type

list

Типы ценников, что надо распечатать на данную акцию

Допускается только одно повторение элемента в рекламной акции. Если требуется указать два типа ценника: Акционный и Скидочный (дополнительный/замещающий), тогда они должы быть перечислены через пробел:

  • ACTION - акционный ценник.
  • ADDITIONAL - скидочный (Дополнительный/замещающий)

<pricetag-type>ACTION ADDITIONAL</pricetag-type>

Нет

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

...

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

AdvertisingActions/AdvertisingAction/pricetag-template

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

Тип данных

Описание

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

count

PositiveInteger

Количество ценников данного шаблона, что надо распечатать в автоматическом режиме

Нет

...