Сервер лояльности

Сервер лояльности 3.0.7

  • Общая схема работы сервера лояльности
  • Методы сервер лояльности поставщик данных
    • ping
    • Получить бонусы клиента
    • Разблокировать бонусы клиента
    • Списать бонусы клиента
    • Выдать карту покупателю
    • Получить данные подарочного сертификата
    • Разблокировать подарочный сертификат
    • Списание подарочный сертификат
    • Использовать автоматические скидки
    • Рассчитать автоматические скидки
    • Проверить подарочный сертификат
    • Получить список управляемых скидок
    • Разблокировать промокод
    • Получить данные промокода
    • Получить остатки
    • Найти карту клиента
    • Получить обороты продаж
    • Получить виды карт
    • Получить список продавцов
    • Получить список серий по отбору
    • Получить данные серии
    • Получить актуальную цену
    • Получить список скидок по видам оплаты

Общая схема работы сервера лояльности


 

Методы сервер лояльности поставщик данных

ping

Процедура проверяет соединение с сервером лояльности
Шаблон: ping
HTTP – метод: GET
Обработчик: pingGET
Код состояния 200 – Ответ «ok»- Тип String

Получить бонусы клиента

Процедура получает данные о бонусах клиента и производит блокировку бонусных баллов карты клиента в управляющей базе.
Шаблон: getclientbonuses
HTTP – метод: GET
Обработчик: ПолучитьБонусыКлиентаGET
Параметры:

Имя параметраТипОписание
ClientCardIDStringНомер карты лояльности
PhoneStringНомер телефона владельца карты лояльности
EmailStringЭлектронная почта владельца карты лояльности
ClientStringУникальный идентификатор владельца карты лояльности
StoreStringУникальный идентификатор магазина/склада
GiftCardNumberStringНомер подарочного сертификата
GiftCardUIDStringУникальный идентификатор подарочного сертификата
PromocodeStringНомер промокода
DiscountToActivateUIDStringУникальный идентификатор скидки следующей покупки
BonusesCountNumberКоличество бонусных баллов
GiftCardWriteOffAmountStringСумма списания бонусов
DateOfBirthDateДата рождения
ClientCardTypeUIDStringУникальный идентификатор вида дисконтной карты
BatchUIDStringУникальный идентификатор серии
CharacteristicStringУникальный идентификатор характеристики
ProductStringУникальный идентификатор номенклатуры
TypeProductStringУникальный идентификатор вида номенклатуры
TypePriceUIDStringУникальный идентификатор вида цены
MaxSaleNumberМаксимальный процент ручной скидки
MaxMarkupNumberМаксимальный процент ручной наценки
TypePriceUIDStringУникальный идентификатор вида цены
UseSelectionBooleanПризнак использования отборов
TypeOperationSaleBooleanПризнак вида операции продажа
GenerateNumberBooleanПризнак необходимости генерации номера

Ответ, тип json, преобразуется в тип Структура
Код состояния 200

Имя параметраТипОписание
ErrorBooleanПризнак ошибки
ErrorMessageStringОписание ошибки
VersionStringНомер версии сервера лояльности
BonusCountNumberКоличество бонусных баллов
BonusRateNumberЗначение конвертации бонусных баллов к валюте расчета
BonusCurrencyStringКод валюты расчета
PaymentPercentNumberЗначение максимального процента оплаты
CardRefStringУникальный идентификатор карты клиента
BarcodeStringШтрихкод карты лояльности
MagneticCodeStringМагнитный код карты лояльности
EndDateStringДата окончания действия запрета продаж
ClientNotFoundBooleanПризнак результата поиска карты лояльности

Разблокировать бонусы клиента

Процедура разблокирует данные бонусной карты лояльности в управляющей базе
Шаблон: unlockclientbonuses
HTTP – метод: POST
Обработчик: РазблокироватьБонусыКлиентаPOST
Параметры:

Имя параметраТипОписание
ClientCardIDStringНомер карты лояльности
PhoneStringНомер телефона владельца карты лояльности
EmailStringЭлектронная почта владельца карты лояльности
ClientStringУникальный идентификатор владельца карты лояльности
StoreStringУникальный идентификатор магазина/склада
GiftCardNumberStringНомер подарочного сертификата
GiftCardUIDStringУникальный идентификатор подарочного сертификата
PromocodeStringНомер промокода
DiscountToActivateUIDStringУникальный идентификатор скидки следующей покупки
BonusesCountNumberКоличество бонусных баллов
GiftCardWriteOffAmountStringСумма списания бонусов
DateOfBirthDateДата рождения
ClientCardTypeUIDStringУникальный идентификатор вида дисконтной карты
BatchUIDStringУникальный идентификатор серии
CharacteristicStringУникальный идентификатор характеристики
ProductStrigУникальный идентификатор номенклатуры
TypeProductStringУникальный идентификатор вида номенклатуры
TypePriceUIDStringУникальный идентификатор вида цены
MaxSaleNumberМаксимальный процент ручной скидки
MaxMarkupNumberМаксимальный процент ручной наценки
UseSelectionBooleanПризнак использования отборов
TypeOperationSaleBooleanПризнак вида операции продажа
GenerateNumberBooleanПризнак необходимости генерации номера

Ответ: Текст сообщения – Тип String

Списать бонусы клиента

Процедура списывает указанное количество бонусных баллов с баланса карты лояльности
Шаблон: writeoffclientbonuses
HTTP – метод: POST
Обработчик: СписатьБонусыКлиентаPOST
Параметры:

Имя параметраТипОписание
ClientCardIDStringНомер карты лояльности
PhoneStringНомер телефона владельца карты лояльности
EmailStringЭлектронная почта владельца карты лояльности
ClientStringУникальный идентификатор владельца карты лояльности
StoreStringУникальный идентификатор магазина/склада
GiftCardNumberStringНомер подарочного сертификата
GiftCardUIDStringУникальный идентификатор подарочного сертификата
PromocodeStringНомер промокода
DiscountToActivateUIDStringУникальный идентификатор скидки следующей покупки
BonusesCountNumberКоличество бонусных баллов
GiftCardWriteOffAmountStringСумма списания бонусов
DateOfBirthDateДата рождения
ClientCardTypeUIDStringУникальный идентификатор вида дисконтной карты
BatchUIDStringУникальный идентификатор серии
CharacteristicStringУникальный идентификатор характеристики
ProductStringУникальный идентификатор номенклатуры
TypeProductStringУникальный идентификатор вида номенклатуры
TypePriceUIDStringУникальный идентификатор вида цены
MaxSaleNumberМаксимальный процент ручной скидки
MaxMarkupNumberМаксимальный процент ручной наценки
UseSelectionBooleanПризнак использования отборов
TypeOperationSaleBooleanПризнак вида операции продажа
GenerateNumberBooleanПризнак необходимости генерации номера

Ответ: Текст сообщения – Тип String

Выдать карту покупателю

Процедура производит регистрацию новой карты лояльности клиента
Шаблон:issueclientcard
HTTP – метод: POST
Обработчик: ВыдатьКартуКлиентуPOST
Параметры:

Имя параметраТипОписание
ClientCardIDStringНомер карты лояльности
PhoneStringНомер телефона владельца карты лояльности
EmailStringЭлектронная почта владельца карты лояльности
ClientStringУникальный идентификатор владельца карты лояльности
StoreStringУникальный идентификатор магазина/склада
GiftCardNumberStringНомер подарочного сертификата
GiftCardUIDStringУникальный идентификатор подарочного сертификата
PromocodeStringНомер промокода
DiscountToActivateUIDStringУникальный идентификатор скидки следующей покупки
BonusesCountNumberКоличество бонусных баллов
GiftCardWriteOffAmountStringСумма списания бонусов
DateOfBirthDateДата рождения
ClientCardTypeUIDStringУникальный идентификатор вида дисконтной карты
BatchUIDStringУникальный идентификатор серии
CharacteristicStringУникальный идентификатор характеристики
ProductStringУникальный идентификатор номенклатуры
TypeProductStringУникальный идентификатор вида номенклатуры
TypePriceUIDStringУникальный идентификатор вида цены
MaxSaleNumberМаксимальный процент ручной скидки
MaxMarkupNumberМаксимальный процент ручной наценки
UseSelectionBooleanПризнак использования отборов
TypeOperationSaleBooleanПризнак вида операции продажа
GenerateNumberBooleanПризнак необходимости генерации номера

Ответ, тип json, преобразуется в тип Структура
Код состояния 200

Имя параметраТипОписание
ErrorBooleanПризнак ошибки
ErrorMessageStringОписание ошибки
VersionStringНомер версии сервера лояльности
ExistingCardBooleanКарта найдена
CardRefNumberУникальный идентификатор карты
CardIDStringНомер карты клиента
ClientNumberУникальный идентификатор владельца дисконтной карты
PhoneNumberStringНомер телефона владельца дисконтной карты
EmailStringЭлектронная почта владельца дисконтной карты
DateOfBirthDateДата рождения владельца дисконтной карты
ClientNotFoundBooleanПризнак результата поиска карты лояльности


Получить данные подарочного сертификата

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

Шаблон: getgiftcardinfo
HTTP – метод: GET
Обработчик: ПолучитьДанныеПодарочногоСертификатаGET
Параметры:

Имя параметраТипОписание
ClientCardIDStringНомер карты лояльности
PhoneStringНомер телефона владельца карты лояльности
EmailStringЭлектронная почта владельца карты лояльности
ClientStringУникальный идентификатор владельца карты лояльности
StoreStringУникальный идентификатор магазина/склада
GiftCardNumberStringНомер подарочного сертификата
GiftCardUIDStringУникальный идентификатор подарочного сертификата
PromocodeStringНомер промокода
DiscountToActivateUIDStringУникальный идентификатор скидки следующей покупки
BonusesCountNumberКоличество бонусных баллов
GiftCardWriteOffAmountStringСумма списания бонусов
DateOfBirthDateДата рождения
ClientCardTypeUIDStringУникальный идентификатор вида дисконтной карты
BatchUIDStringУникальный идентификатор серии
CharacteristicStringУникальный идентификатор характеристики
ProductStringУникальный идентификатор номенклатуры
TypeProductStringУникальный идентификатор вида номенклатуры
TypePriceUIDStringУникальный идентификатор вида цены
MaxSaleNumberМаксимальный процент ручной скидки
MaxMarkupNumberМаксимальный процент ручной наценки
UseSelectionBooleanПризнак использования отборов
TypeOperationSaleBooleanПризнак вида операции продажа
GenerateNumberBooleanПризнак необходимости генерации номера

Ответ, тип json, преобразуется в тип Структура
Код состояния 200

Имя параметраТипОписание
ErrorBooleanПризнак ошибки
ErrorMessageStringОписание ошибки
VersionStringНомер версии сервера лояльности
GiftCardStructureОписание подарочного сертификата
GiftCardNumberStringНомер подарочного сертификата
GiftCardValueNumberНоминал подарочного сертификата
GiftCardBalanceNumberОстаток суммы подарочного сертификата
BlockedBooleanПризнак блокировки подарочного сертификата

Параметр GiftCard:

Имя параметраТипОписание
GiftCardNameStringНаименование подарочного сертификата
GiftCardRefStringУникальный идентификатор

Разблокировать подарочный сертификат

Процедура производит разблокировку подарочного сертификата в управляющей базе.
Шаблон:unlockgiftcard
HTTP – метод: POST
Обработчик: РазблокироватьПодарочныйСертификатPOST
Параметры:

Имя параметраТипОписание
ClientCardIDStringНомер карты лояльности
PhoneStringНомер телефона владельца карты лояльности
EmailStringЭлектронная почта владельца карты лояльности
ClientStringУникальный идентификатор владельца карты лояльности
StoreStringУникальный идентификатор магазина/склада
GiftCardNumberStringНомер подарочного сертификата
GiftCardUIDStringУникальный идентификатор подарочного сертификата
PromocodeStringНомер промокода
DiscountToActivateUIDStringУникальный идентификатор скидки следующей покупки
BonusesCountNumberКоличество бонусных баллов
GiftCardWriteOffAmountStringСумма списания бонусов
DateOfBirthDateДата рождения
ClientCardTypeUIDStringУникальный идентификатор вида дисконтной карты
BatchUIDStringУникальный идентификатор серии
CharacteristicStringУникальный идентификатор характеристики
ProductStringУникальный идентификатор номенклатуры
TypeProductStringУникальный идентификатор вида номенклатуры
TypePriceUIDStringУникальный идентификатор вида цены
MaxSaleNumberМаксимальный процент ручной скидки
MaxMarkupNumberМаксимальный процент ручной наценки
UseSelectionBooleanПризнак использования отборов
TypeOperationSaleBooleanПризнак вида операции продажа
GenerateNumberBooleanПризнак необходимости генерации номера

Ответ: Текст сообщения – Тип String

Списание подарочный сертификат

Процедура списывает указанный номинал с подарочного сертификата
Шаблон: writeoffgiftcard
HTTP – метод: POST
Обработчик: СписатьПодарочныйСертификатPOST
Параметры:

Имя параметраТипОписание
ClientCardIDStringНомер карты лояльности
PhoneStringНомер телефона владельца карты лояльности
EmailStringЭлектронная почта владельца карты лояльности
ClientStringУникальный идентификатор владельца карты лояльности
StoreStringУникальный идентификатор магазина/склада
GiftCardNumberStringНомер подарочного сертификата
GiftCardUIDStringУникальный идентификатор подарочного сертификата
PromocodeStringНомер промокода
DiscountToActivateUIDStringУникальный идентификатор скидки следующей покупки
BonusesCountNumberКоличество бонусных баллов
GiftCardWriteOffAmount
DateOfBirthDateДата рождения
ClientCardTypeUIDStringУникальный идентификатор вида дисконтной карты
BatchUIDStringУникальный идентификатор серии
CharacteristicStringУникальный идентификатор характеристики
ProductStringУникальный идентификатор номенклатуры
TypeProductStringУникальный идентификатор вида номенклатуры
TypePriceUIDStringУникальный идентификатор вида цены
MaxSaleNumberМаксимальный процент ручной скидки
MaxMarkupNumberМаксимальный процент ручной наценки
UseSelectionBoolean

Признак использования отборов

TypeOperationSaleBooleanПризнак вида операции продажа
GenerateNumberBooleanПризнак необходимости генерации номера

Ответ: Текст сообщения – Тип String

Использовать автоматические скидки

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

Шаблон: useautomaticdiscounts
HTTP – метод: GET
Обработчик: ИспользоватьАвтоматическиеСкидкиGET
Параметры: нет

Ответ,тип json, преобразуется в тип Структура
Код состояния 200

Имя параметраТипОписание
ErrorBooleanПризнак ошибки
ErrorMessageStringОписание ошибки
VersionStringНомер версии сервера лояльности
UseAutomaticDiscountsBooleanПризнак использования автоматических скидок

Рассчитать автоматические скидки

Шаблон: calculatediscounts
HTTP – метод: POST
Обработчик: РассчитатьАвтоматическиеСкидкиPOST
HTTP – метод: GET
Обработчик: РассчитатьАвтоматическиеСкидкиGET
Параметры:

Имя параметраТипОписание
LoyaltyCardsListArrayСписок карт лояльности
GoodsArrayСписок табличной части товаров
PromocodesListArrayСписок промокодов
ControlledDiscountsListArrayСписок выбранных управляемых скидок
CurrentDateDateДата расчета скидок
RetailStoreStructureЗначение магазина расчета скидок
ReturnBooleanПризнак вида операции возврат
GetLoyaltyCardDataBooleanПризнак необходимости возврата данных карты
GetMaxBonusPayBooleanПризнак необходимости возврата максимального значения бонусных баллов
BlockBonusesNumberЗначение блокировки бонусных баллов
GetPossibleOnPayDiscountsBooleanПризнак необходимости рассчитывать скидки за вид оплаты
PayTypesArrayСписок доступных видов оплаты

Параметр LoyaltyCardsList.

Имя параметраТипОписание
LoyaltyCardsListLinkДисконтная карта

Параметр Goods:

Имя параметраТипОписание
ItemLinkНоменклатура
PackageLinkЕдиница измерения
VariantLinkХарактеристика
PriceNumberЦена
AmountNumberСумма
CountNumberКоличество
PackagesCountNumberКоличество в базовых единицах
VATRateStringНаименование ставки НДС
PercentOfAutomaticDiscountNumberПроцент автоматической скидки
PercentOfManualDiscountNumberПроцент скидки наценки
AmountOfAutomaticDiscountNumberСумма автоматической скидки
AmountOfManualDiscountNumberСумма скидки наценки
TotalAmountNumberВсего
VATAmountNumberСумма НДС
LineUIDStringИдентификатор строки
OrderLinkЗаказ
AmountOfBonusPayNumberСумма скидки оплаты бонусами

Параметр Ссылка:

Имя параметраТипОписание
RefStringУникальный идентификатор
NameStringПредставление

Параметр PromocodesList:

Имя параметраТипОписание
PromocodeLinkПромокод
PromocodeDiscountUIDStringУникальный идентификатор скидки

Параметр ControlledDiscountsLis:

Имя параметраТипОписание
ControlledDiscountsListStringУникальный идентификатор скидки
LineUIDStringИдентификатор строки
KeyRelationStringКлюч связи

Параметр RetailStore:

Имя параметраТипОписание
RefStringУникальный идентификатор
NameStringПредставление

Структура параметра PayTypes:

Имя параметраТипОписание
PayTypeStringНаименование вида оплаты
IsUsedBooleanПризнак использования вида оплаты

Ответ, тип json, преобразуется в тип Структура

Код состояния 200

Имя параметраТипОписание
ErrorBooleanПризнак ошибки
ErrorMessageStringОписание ошибки
VersionStringНомер версии сервера лояльности
GoodsArrayОписание таблицы товаров
DiscountsListArrayТаблица примененных скидок/наценок
PromocodesListArrayТаблица примененных промокодов
BonusesToAccrueArrayТаблица бонусов к начислению
GiftsArrayТаблица подарков
CurrentDiscountsArrayТаблица действующих скидок наценок
MessagesArrayТаблица сообщений применения скидок
LoyaltyCardDescriptionStructureОписание данных карты
MaxBonusPayNumberМаксимальная сумма оплаты бонусами
PossibleOnPayDiscounsArrayТаблица скидок за вид оплаты

Структура параметра Goods:

Имя параметраТипОписание
ItemLinkНоменклатура
PackageLinkЕдиница измерения
VariantLinkХарактеристика
PriceNumberЦена
AmountNumberСумма
CountNumberКоличество
PackagesCountNumberКоличество в базовых единицах
VATRateStringНаименование ставки НДС
PercentOfAutomaticDiscountNumberПроцент автоматической скидки
PercentOfManualDiscountNumberПроцент скидки наценки
AmountOfAutomaticDiscountNumberСумма автоматической скидки
AmountOfManualDiscountNumberСумма скидки наценки
TotalAmountNumberВсего
VATAmountNumberСумма НДС
LineUIDStringИдентификатор строки
OrderLinkЗаказ

Структура параметра DiscountsList:

Имя параметраТипОписание
KeyRelationStringКлюч связи
DiscountLinkОписание скидки
DiscountValueNumberЗначение скидки наценки
AmountNumberСумма
MinimalPriceRestrictionBooleanПризнак ограничения минимальной ценой
CommentStringКомментарий
LineUIDStringИдентификатор строки
ReturnBooleanПризнак скидки при возврате товаров

Структура параметра PromocodesList:

Имя параметраТипОписание
PromocodeLinkПромокод
DiscountActiveBooleanПризнак предоставления скидки по промокоду
PromocodeActivationBooleanПризнак активации промокода
PromocodeDiscountLinkСкидка наценка по промокоду
ErrorDescriptionStringОписание ошибки применения
PromocodeUIDStringУникальный идентификатор промокода
DiscountConditionLinkУсловие предоставления скидки наценки

Структура параметра BonusesToAccrue:

Имя параметраТипОписание
KeyRelationStringКлюч связи
DiscountLinkОписание скидки
BonusProgrammLinkОписание бонусной программы
BonusCountNumberКоличество бонусных баллов к начислению
AccuralDateDateДата начисления
WriteOffDateDateДата списания

Структура параметра Gifts:

Имя параметраТипОписание
ItemLinkНоменклатура
StorageLinkМагазин
VariantLinkХарактеристика
PackageLinkЕдиница измерения
CountNumberКоличество
PackagesCountNumberКоличество в ед. измерения
PriceNumberЦена
AmountNumberСумма
GiftFromTheListBooleanПризнак выбора подарка из списка
ShoppingCartBooleanПризнак учета подарка как продажу
GiftOwnerStringУникальный идентификатор скидки
GiftNameStringПредставление скидки

Структура параметра CurrentDiscounts:

Имя параметраТипОписание
DiscountsLinkСкидка наценка
DiscountValueNumberЗначение скидки наценки
GroupBooleanПризнак это группа
CompletedNumberКоличество выполненных условий
ParentStringУникальный идентификатор родителя
TermsDiscountsStringОписание условий предоставления

Структура параметра Messages:

Имя параметраТипОписание
AfterSaleBooleanПризнак вывода сообщения после пробития чека
MessageTextStringТекст сообщения

Структура параметра LoyaltyCardDescription:

Имя параметраТипОписание
CardNotFoundBooleanПризнак результата поиска карты
LoyaltyCardStructureСтруктура описания карты лояльности

 

Структура параметра LoyaltyCard:

Имя параметраТипОписание
ClientNameStringНаименование клиента
IsPersonBooleanПризнак физического лица
DateOfBirthDateДата рождения
PhoneStringНомер телефона
EmailStringЭлектронная почта
BarcodeStringШтрихкод
MagneticCodeStringМагнитный код
CardGUIDStringУникальный идентификатор карты
ClientGUIDStringУникальный идентификатор владельца карты лояльности
IsBlockedBooleanПризнак блокировки бонусов
BonusDataStructureОписание данных бонусов
SellCountNumberЗначение оборота продаж
SearchTypeStringТип поиска

Структура параметра BonusData:

Имя параметраТипОписание
PaymentPercentNumberМаксимальный процент оплаты бонусами
BonusCountNumberОстаток бонусных баллов
BonusRateNumberКурс конвертации бонусных баллов

Структура параметра PossibleOnPayDiscouns:

Имя параметраТипОписание
PayTypeStringУникальный идентификатор вида оплаты
AmountNumberСумма скидки

Проверить подарочный сертификат

Шаблон:checkgiftcard
HTTP – метод: GET
Обработчик: ПроверитьПодарочныйСертификатGET
Параметры:

Имя параметраТипОписание
ClientCardIDStringНомер карты лояльности
PhoneStringНомер телефона владельца карты лояльности
EmailStringЭлектронная почта владельца карты лояльности
ClientStringУникальный идентификатор владельца карты лояльности
StoreStringУникальный идентификатор магазина/склада
GiftCardNumberStringНомер подарочного сертификата
GiftCardUIDStringУникальный идентификатор подарочного сертификата
PromocodeStringНомер промокода
DiscountToActivateUIDStringУникальный идентификатор скидки следующей покупки
BonusesCountNumberКоличество бонусных баллов
GiftCardWriteOffAmountStringСумма списания бонусов
DateOfBirthDateДата рождения
ClientCardTypeUIDStringУникальный идентификатор вида дисконтной карты
BatchUIDStringУникальный идентификатор серии
CharacteristicStringУникальный идентификатор характеристики
ProductStringУникальный идентификатор номенклатуры
TypeProductStringУникальный идентификатор вида номенклатуры
TypePriceUIDStringУникальный идентификатор вида цены
MaxSaleNumberМаксимальный процент ручной скидки
MaxMarkupNumberМаксимальный процент ручной наценки
UseSelectionBooleanПризнак использования отборов
TypeOperationSaleBooleanПризнак вида операции продажа
GenerateNumberBoolean

Ответ, тип json, преобразуется в тип Структура
Код состояния 200

Имя параметраТипОписание
ErrorBooleanПризнак ошибки
ErrorMessageStringОписание ошибки
VersionStringНомер версии сервера лояльности
GiftCardUsedBooleanПризнак использования подарочного сертификата

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

Шаблон: getcontrolleddiscountslist
HTTP – метод: GET
Обработчик: ПолучитьСписокУправляемыхСкидокGET
Параметры:

Имя параметраТипОписание
ClientCardIDStringНомер карты лояльности
PhoneStringНомер телефона владельца карты лояльности
EmailStringЭлектронная почта владельца карты лояльности
ClientStringУникальный идентификатор владельца карты лояльности
StoreStringУникальный идентификатор магазина/склада
GiftCardNumberStringНомер подарочного сертификата
GiftCardUIDStringУникальный идентификатор подарочного сертификата
PromocodeStringНомер промокода
DiscountToActivateUIDStringУникальный идентификатор скидки следующей покупки
BonusesCountNumberКоличество бонусных баллов
GiftCardWriteOffAmountStringСумма списания бонусов
DateOfBirthDateДата рождения
ClientCardTypeUIDStringУникальный идентификатор вида дисконтной карты
BatchUIDStringУникальный идентификатор серии
CharacteristicStringУникальный идентификатор характеристики
ProductStringУникальный идентификатор номенклатуры
TypeProductStringУникальный идентификатор вида номенклатуры
TypePriceUIDStringУникальный идентификатор вида цены
MaxSaleNumberМаксимальный процент ручной скидки
MaxMarkupNumberМаксимальный процент ручной наценки
UseSelectionBooleanПризнак использования отборов
TypeOperationSaleBooleanПризнак вида операции продажа
GenerateNumberBooleanПризнак необходимости генерации номера

Ответ,тип json, преобразуется в тип Структура
Код состояния 200

Имя параметраТипОписание
DiscountValueNumberЗначение скидки наценки
DiscountDescriptionStringПредставление управляемой скидки
DiscoutTypeStringТип скидки
ApplicationAreaStringОбласть действия
DiscountIDStringИдентификатор строки
DiscountRefStringУникальный идентификатор скидки
ReturnBooleanПризнак применения скидки при возврате
BonusesBooleanПризнак применения скидки для начисления бонусов

Разблокировать промокод

Шаблон: unlockpromocode
HTTP – метод: POST
Обработчик: РазблокироватьПромокодPOST
Параметры:

Имя параметраТипОписание
ClientCardIDStringНомер карты лояльности
PhoneStringНомер телефона владельца карты лояльности
EmailStringЭлектронная почта владельца карты лояльности
ClientStringУникальный идентификатор владельца карты лояльности
StoreStringУникальный идентификатор магазина/склада
GiftCardNumberStringНомер подарочного сертификата
GiftCardUIDStringУникальный идентификатор подарочного сертификата
PromocodeStringНомер промокода
DiscountToActivateUIDStringУникальный идентификатор скидки следующей покупки
BonusesCountNumberКоличество бонусных баллов
GiftCardWriteOffAmountStringСумма списания бонусов
DateOfBirthDateДата рождения
ClientCardTypeUIDStringУникальный идентификатор вида дисконтной карты
BatchUIDStringУникальный идентификатор серии
CharacteristicStringУникальный идентификатор характеристики
ProductStringУникальный идентификатор номенклатуры
TypeProductStringУникальный идентификатор вида номенклатуры
TypePriceUIDStringУникальный идентификатор вида цены
MaxSaleNumberМаксимальный процент ручной скидки
MaxMarkupNumberМаксимальный процент ручной наценки
UseSelectionBooleanПризнак использования отборов
TypeOperationSaleBooleanПризнак вида операции продажа
GenerateNumberBooleanПризнак необходимости генерации номера

Получить данные промокода

Шаблон:promocodeinfo
HTTP – метод: GET
Обработчик: ПолучитьДанныеПромокодаGET
Параметры:

Имя параметраТипОписание
ClientCardIDStringНомер карты лояльности
PhoneStringНомер телефона владельца карты лояльности
EmailStringЭлектронная почта владельца карты лояльности
ClientStringУникальный идентификатор владельца карты лояльности
StoreStringУникальный идентификатор магазина/склада
GiftCardNumberStringНомер подарочного сертификата
GiftCardUIDStringУникальный идентификатор подарочного сертификата
PromocodeStringНомер промокода
DiscountToActivateUIDStringУникальный идентификатор скидки следующей покупки
BonusesCountNumberКоличество бонусных баллов
GiftCardWriteOffAmountStringСумма списания бонусов
DateOfBirthDateДата рождения
ClientCardTypeUIDStringУникальный идентификатор вида дисконтной карты
BatchUIDStringУникальный идентификатор серии
CharacteristicStringУникальный идентификатор характеристики
ProductStringУникальный идентификатор номенклатуры
TypeProductStringУникальный идентификатор вида номенклатуры
TypePriceUIDStringУникальный идентификатор вида цены
MaxSaleNumberМаксимальный процент ручной скидки
MaxMarkupNumberМаксимальный процент ручной наценки
UseSelectionBooleanПризнак использования отборов
TypeOperationSaleBooleanПризнак вида операции продажа
GenerateNumberBooleanПризнак необходимости генерации номера

Ответ, тип json, преобразуется в тип Структура
Код состояния 200

Имя параметраТипОписание
ErrorBooleanПризнак ошибки
ErrorMessageStringОписание ошибки
VersionStringНомер версии сервера лояльности
PromocodeIsAvalibleBooleanПризнак доступности промокода
PromocodeStatusStringОписание ошибки промокода
PromocodeDiscountDescriptionStringПредставление скидки промокода
PromocodeDiscountLinkСкидка промокода

Получить остатки

Шаблон: getleftovers
HTTP – метод: GET
Обработчик: ПолучитьОстаткиGET
HTTP – метод: POST
Обработчик: ПолучитьОстаткиPOST
Параметры:

Имя параметраТипОписание
ItemLinkНоменклатура
VariantLinkХарактеристики
PackageLinkЕдиницы измерения

Ответ, тип json, преобразуется в тип Структура
Код состояния 200

Имя параметраТипОписание
LeftoverLocationStringМесто хранения
VariantStringХарактеристика
LeftoverNumberОстаток
ReservedNumberВ резерве
FreeLeftoverNumberСвободно

Найти карту клиента

Шаблон: findclientcard
HTTP – метод: GET
Обработчик: НайтиКартуКлиентаGET
Параметры:

Имя параметраТипОписание
ClientCardIDStringНомер карты лояльности
PhoneStringНомер телефона
EmailStringЭлектронная почта
BlockBonusesStringПризнак блокировки бонусов
ClientGUIDStringУникальный идентификатор владельца карты лояльности
CardGUIDStringУникальный идентификатор карты лояльности

Ответ,тип json, преобразуется в тип Структура

Код состояния 200

Имя параметраТипОписание
ErrorBooleanПризнак ошибки
ErrorMessageStringОписание ошибки
VersionStringНомер версии сервера лояльности
LoyaltyCardsListArrayСписок карт лояльности

ПараметрLoyaltyCardsList:

Имя параметраТипОписание
ClientNameStringНаименование клиенат
IsPersonBooleanВид констрагента
DateOfBirthDateДата рождения
PhoneStringНомер телефона
EmailStringЭлектронная почта
BarcodeStringШтрихкод
MagneticCodeStringМангнитный код
CardGUIDStringУникальный идентификатор карты лояльности
ClientGUIDStringУникальный идентификатор владельца карты лояльности
IsBlockedStringПризнак блокировки бонусных баллов
BonusDataStructureДанные о бонусных баллах
SellCountNumberОборот продаж
SearchTypeStringТип поиска
ValidBooleanПризнак действия карты

Получить обороты продаж

Шаблон: salesturnover
HTTP – метод: GET
Обработчик: ПолучитьОборотыПродажGET
Параметры:

Имя параметраТипОписание
ClientCardIDStringНомер карты лояльности
PhoneStringНомер телефона владельца карты лояльности
EmailStringЭлектронная почта владельца карты лояльности
ClientStringУникальный идентификатор владельца карты лояльности
StoreStringУникальный идентификатор магазина/склада
GiftCardNumberStringНомер подарочного сертификата
GiftCardUIDStringУникальный идентификатор подарочного сертификата
PromocodeStringНомер промокода
DiscountToActivateUIDStringУникальный идентификатор скидки следующей покупки
BonusesCountNumberКоличество бонусных баллов
GiftCardWriteOffAmountStringСумма списания бонусов
DateOfBirthDateДата рождения
ClientCardTypeUIDStringУникальный идентификатор вида дисконтной карты
BatchUIDStringУникальный идентификатор серии
CharacteristicStringУникальный идентификатор характеристики
ProductStringУникальный идентификатор номенклатуры
TypeProductStringУникальный идентификатор вида номенклатуры
TypePriceUIDStringУникальный идентификатор вида цены
MaxSaleNumberМаксимальный процент ручной скидки
MaxMarkupNumberМаксимальный процент ручной наценки
UseSelectionBooleanПризнак использования отборов
TypeOperationSaleBooleanПризнак вида операции продажа
GenerateNumberBooleanПризнак необходимости генерации номера

Ответ, тип json, преобразуется в тип Структура
Код состояния 200

Имя параметраТипОписание
ErrorBooleanПризнак ошибки
ErrorMessageStringОписание ошибки
VersionStringНомер версии сервера лояльности
CardRefStringУникальный идентификатор карты
SellCountNumberОборот продаж
BarcodeStringШтрихкод
MagneticCodeStringМагнитный код
ClientNotFoundBooleanПризнак результата поиска карты лояльности

Получить виды карт

Шаблон: getcardtypes
HTTP – метод: GET
Обработчик: ПолучитьВидыКартGET
Параметры: нет
Ответ, тип json, преобразуется в тип Структура
Код состояния 200

Имя параметраТипОписание
CardTypeIDStringУникальный идентификатор вида карты лояльности
CardTypeDescriptionStringНаименование вида карты лояльности
IsPersonBooleanПризнак именной карты лояльности
GenerateNumerBooleanПризнак необходимости генерировать номера карты

Получить список продавцов

Шаблон:listofemployees
HTTP – метод: GET
Обработчик: ПолучитьСписокПродавцовGET
Параметры:

Имя параметраТипОписание
ClientCardIDStringНомер карты лояльности
PhoneStringНомер телефона владельца карты лояльности
EmailStringЭлектронная почта владельца карты лояльности
ClientStringУникальный идентификатор владельца карты лояльности
StoreStringУникальный идентификатор магазина/склада
GiftCardNumberStringНомер подарочного сертификата
GiftCardUIDStringУникальный идентификатор подарочного сертификата
PromocodeStringНомер промокода
DiscountToActivateUIDStringУникальный идентификатор скидки следующей покупки
BonusesCountNumberКоличество бонусных баллов
GiftCardWriteOffAmountStringСумма списания бонусов
DateOfBirthDateДата рождения
ClientCardTypeUIDStringУникальный идентификатор вида дисконтной карты
BatchUIDStringУникальный идентификатор серии
CharacteristicStringУникальный идентификатор характеристики
ProductStringУникальный идентификатор номенклатуры
TypeProductStringУникальный идентификатор вида номенклатуры
TypePriceUIDStringУникальный идентификатор вида цены
MaxSaleNumberМаксимальный процент ручной скидки
MaxMarkupNumberМаксимальный процент ручной наценки
UseSelectionBooleanПризнак использования отборов
TypeOperationSaleBooleanПризнак вида операции продажа
GenerateNumberBooleanПризнак необходимости генерации номера

Ответ, тип json, преобразуется в тип Структура
Код состояния 200

Имя параметраТипОписание
EmployeeDescriptionStringНаименование сотрудника
EmployeeCodeStringКод сотрудника
EmployeeIDStringУникальный идентификатор сотрудника

Получить список серий по отбору

Шаблон: getlistbatches

HTTP – метод: GET
Обработчик: ПолучитьСписокСерийПоОтборуGET
Параметры:

Имя параметраТипОписание
ClientCardIDStringНомер карты лояльности
PhoneStringНомер телефона владельца карты лояльности
EmailStringЭлектронная почта владельца карты лояльности
ClientStringУникальный идентификатор владельца карты лояльности
StoreStringУникальный идентификатор магазина/склада
GiftCardNumberStringНомер подарочного сертификата
GiftCardUIDStringУникальный идентификатор подарочного сертификата
PromocodeStringНомер промокода
DiscountToActivateUIDStringУникальный идентификатор скидки следующей покупки
BonusesCountNumberКоличество бонусных баллов
GiftCardWriteOffAmountStringСумма списания бонусов
DateOfBirthDateДата рождения
ClientCardTypeUIDStringУникальный идентификатор вида дисконтной карты
BatchUIDStringУникальный идентификатор серии
CharacteristicStringУникальный идентификатор характеристики
ProductStringУникальный идентификатор номенклатуры
TypeProductStringУникальный идентификатор вида номенклатуры
TypePriceUIDStringУникальный идентификатор вида цены
MaxSaleNumberМаксимальный процент ручной скидки
MaxMarkupNumberМаксимальный процент ручной наценки
UseSelectionBooleanПризнак использования отборов
TypeOperationSaleBooleanПризнак вида операции продажа
GenerateNumberBooleanПризнак необходимости генерации номера

Ответ, тип json, преобразуется в тип Структура

Код состояния 200

Имя параметраТипОписание
BatchDescriptionStringНаименование серии
BatchIDStringУникальный идентификатор серии

Получить данные серии

Шаблон:getseriesdata
HTTP – метод: GET
Обработчик: ПолучитьДанныеСерииGET
Параметры:

Имя параметраТипОписание
ClientCardIDStringНомер карты лояльности
PhoneStringНомер телефона владельца карты лояльности
EmailStringЭлектронная почта владельца карты лояльности
ClientStringУникальный идентификатор владельца карты лояльности
StoreStringУникальный идентификатор магазина/склада
GiftCardNumberStringНомер подарочного сертификата
GiftCardUIDStringУникальный идентификатор подарочного сертификата
PromocodeStringНомер промокода
DiscountToActivateUIDStringУникальный идентификатор скидки следующей покупки
BonusesCountNumberКоличество бонусных баллов
GiftCardWriteOffAmountStringСумма списания бонусов
DateOfBirthDateДата рождения
ClientCardTypeUIDStringУникальный идентификатор вида дисконтной карты
BatchUIDStringУникальный идентификатор серии
CharacteristicStringУникальный идентификатор характеристики
ProductStringУникальный идентификатор номенклатуры
TypeProductStringУникальный идентификатор вида номенклатуры
TypePriceUIDStringУникальный идентификатор вида цены
MaxSaleNumberМаксимальный процент ручной скидки
MaxMarkupNumberМаксимальный процент ручной наценки
UseSelectionBooleanПризнак использования отборов
TypeOperationSaleBooleanПризнак вида операции продажа
GenerateNumberBooleanПризнак необходимости генерации номера

Ответ, тип json, преобразуется в тип Структура
Код состояния 200

Имя параметраТипОписание
ErrorBooleanПризнак ошибки
ErrorMessageStringОписание ошибки
VersionStringНомер версии сервера лояльности
NameBatchStringНаименование серии
BatchUsedBooleanПризнак наличия серии


Получить актуальную цену

Шаблон: getprice
HTTP – метод: GET
Обработчик: ПолучитьАктуальнуюЦенуGET
Параметры:

Имя параметраТипОписание
ClientCardIDStringНомер карты лояльности
PhoneStringНомер телефона владельца карты лояльности
EmailStringЭлектронная почта владельца карты лояльности
ClientStringУникальный идентификатор владельца карты лояльности
StoreStringУникальный идентификатор магазина/склада
GiftCardNumberStringНомер подарочного сертификата
GiftCardUIDStringУникальный идентификатор подарочного сертификата
PromocodeStringНомер промокода
DiscountToActivateUIDStringУникальный идентификатор скидки следующей покупки
BonusesCountNumberКоличество бонусных баллов
GiftCardWriteOffAmountStringСумма списания бонусов
DateOfBirthDateДата рождения
ClientCardTypeUIDStringУникальный идентификатор вида дисконтной карты
BatchUIDStringУникальный идентификатор серии
CharacteristicStringУникальный идентификатор характеристики
ProductStringУникальный идентификатор номенклатуры
TypeProductStringУникальный идентификатор вида номенклатуры
TypePriceUIDStringУникальный идентификатор вида цены
MaxSaleNumberМаксимальный процент ручной скидки
MaxMarkupNumberМаксимальный процент ручной наценки
UseSelectionBooleanПризнак использования отборов
TypeOperationSaleBooleanПризнак вида операции продажа
GenerateNumberBooleanПризнак необходимости генерации номера

Ответ, тип json, преобразуется в тип Структура

Код состояния 200

Имя параметраТипОписание
ErrorBooleanПризнак ошибки
ErrorMessageStringОписание ошибки
VersionStringНомер версии сервера лояльности
TypePriceUIDStringУникальный идентификатор вида цены
CharacteristicStringХарактеристика
ProductStringНоменклатура
BatchUIDStringУникальный идентификатор серии

Получить список скидок по видам оплаты

Шаблон: getlistonpaydiscounts
HTTP – метод: GET
Обработчик: ПолучитьСписокСкидокПоВидамОплатыGET
Параметры: нет
Ответ, тип json, преобразуется в тип Структура
Код состояния 200

Имя параметраТипОписание
DiscountIDStringУникальный идентификатор скидки
PayTypeLinkВид оплаты

Заказать звонок