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

РазблокироватьБонусыПодарочныеСертификатыПриЗаписи

Описание, пример вызова

// Производит разблокировку бонусов клиента при записи документа
//
// Параметры:
//  Источник - ДокументОбъект.ЧекККМ - документ-источник.
//  Отказ - Булево
//
Процедура РазблокироватьБонусыПодарочныеСертификатыПриЗаписи(Источник, Отказ) Экспорт

Пример вызова

СерверЛояльностиПоставщикДанных.РазблокироватьБонусыПодарочныеСертификатыПриЗаписи(Источник, Отказ)

БонусыЗаблокированы

Описание, пример вызова

// Проверяет блокировку бонусов клиента
//
// Параметры:
//  ДисконтнаяКарта - ОпределяемыйТип.КартаЛояльностиСерверЛояльности - карта клиента.
//
// Возвращаемое значение:
//  Булево - Истина - если есть блокировка бонусов, Ложь, если нет блокировки.
//
Функция БонусыЗаблокированы(ДисконтнаяКарта) Экспорт

Пример вызова

Результат = СерверЛояльностиПоставщикДанных.БонусыЗаблокированы(ДисконтнаяКарта)

ЗаблокироватьБонусы

Описание, пример вызова

// Блокирует бонусы клиента после ответа Сервиса Лояльности для предотвращения двойного списания
//
// Параметры:
//  ДисконтнаяКарта - ОпределяемыйТип.КартаЛояльностиСерверЛояльности - карта клиента.
//  ДатаБлокировки  - Дата - дата и время блокировки бонусов.
//
Процедура ЗаблокироватьБонусы(ДисконтнаяКарта, ДатаБлокировки) Экспорт

Пример вызова

СерверЛояльностиПоставщикДанных.ЗаблокироватьБонусы(ДисконтнаяКарта, ДатаБлокировки)

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

Описание, пример вызова

// Разблокирует бонусы клиента
//
// Параметры:
//  ДисконтнаяКарта - ОпределяемыйТип.КартаЛояльностиСерверЛояльности - карта клиента
//
Процедура РазблокироватьБонусы(ДисконтнаяКарта) Экспорт

Пример вызова

СерверЛояльностиПоставщикДанных.РазблокироватьБонусы(ДисконтнаяКарта)

СписатьБонусы

Описание, пример вызова

// Списывает бонусы клиента
//
// Параметры:
//  ДисконтнаяКарта       - ОпределяемыйТип.КартаЛояльностиСерверЛояльности - карта клиента.
//  КоличествоБонусныхБаллов  - Число
//
Процедура СписатьБонусы(ДисконтнаяКарта, КоличествоБонусныхБаллов) Экспорт

Пример вызова

СерверЛояльностиПоставщикДанных.СписатьБонусы(ДисконтнаяКарта, КоличествоБонусныхБаллов)

ПараметрыМетодаИзЗапроса

Описание, пример вызова

// Возвращает структуру параметров из HTTP запроса
//
// Параметры:
//  Запрос - Структура - Параметры HTTP-запроса.
//  Результат - Структура - содержит в себе набор параметров, которые могут быть переданы через HTTP-запрос:
//    * ИдентификаторКартыКлиента   - Строка
//    * НомерТелефона         - Строка
//    * Клиент             - Строка
//    * Магазин           - Строка
//    * НомерСертификата       - Строка
//    * ГУИДСертификата        - Строка
//    * КоличествоБонусныхБаллов   - Число
//    * СуммаСписания         - Число
//    * ДатаРождения         - Дата
//    * ГУИДВидаКарты         - Строка
//
Процедура ПараметрыМетодаИзЗапроса(Запрос, Результат) Экспорт

Пример вызова

СерверЛояльностиПоставщикДанных.ПараметрыМетодаИзЗапроса(Запрос, Результат)

ПараметрыМетодаИзЗапросаНайтиКартуКлиента

Описание, пример вызова

// Возвращает структуру параметров из HTTP запроса поиска карты клиента
//
// Параметры:
//  Запрос - Структура - Параметры HTTP-запроса.
//  Результат - Структура - содержит в себе набор параметров, которые могут быть переданы через HTTP-запрос:
//    * ИдентификаторКартыКлиента             - Строка
//    * НомерТелефона                   - Строка
//    * АдресЭП                     - Строка
//    * БлокироватьКарту                 - Булево
//    * УникальныйИдентификаторВладельцаКарты       - Строка
//
Процедура ПараметрыМетодаИзЗапросаНайтиКартуКлиента(Запрос, Результат) Экспорт

Пример вызова

СерверЛояльностиПоставщикДанных.ПараметрыМетодаИзЗапросаНайтиКартуКлиента(Запрос, Результат)

ПолучитьСтруктуруОтвета

Описание, пример вызова

// Возвращает структуру параметров ответа HTTP-сервиса
//
// Параметры:
//  ВариантОтвета - Строка - в зависимости от указанного варианта будет возвращаться та или иная структура ответа
//  Результат - Структура - содержит в себе набор параметров ответа HTTP-сервиса "Сервис лояльности":
//    * Error           - Булево
//    * ErrorMessage       - Строка
//    * AllowControl       - Булево
//    * RestrictionsList     - Массив
//    * GiftCardName       - Строка
//    * GiftCardRef       - Строка
//    * GiftCard         - Структура
//    * GiftCardNumber       - Строка
//    * GiftCardValue       - Число
//    * GiftCardBalance     - Число
//    * Blocked         - Булево
//    * UseAutomaticDiscounts   - Булево
//    * BonusCount         - Число
//    * BonusRate         - Число
//    * BonusCurrency       - Строка
//    * PaymentPercent       - Число
//    * EndDate         - Число
//    * ClientNotFound       - Дата
//    * ExistingCard       - Булево
//    * CardID           - Строка
//    * Client           - Строка
//    * PhoneNumber       - Строка
//    * Email           - Строка
//
Процедура ПолучитьСтруктуруОтвета(ВариантОтвета = "ЗапросКоличестваБонусов", Результат = Неопределено) Экспорт

Пример вызова

СерверЛояльностиПоставщикДанных.ПолучитьСтруктуруОтвета(ВариантОтвета, Результат);

ПолучитьБонусныеБаллыРезерв

Описание, пример вызова

// Возвращает количество зарезервированных бонусных баллов
//
// Параметры:
//  ДисконтнаяКарта - ОпределяемыйТип.КартаЛояльностиСерверЛояльности
//
// Возвращаемое значение:
//  Число - количество бонусных баллов, находящихся в резерве
//
Функция ПолучитьБонусныеБаллыРезерв(ДисконтнаяКарта) Экспорт

Пример вызова

Результат = СерверЛояльностиПоставщикДанных.ПолучитьБонусныеБаллыРезерв(ДисконтнаяКарта)

СкорректироватьРегистрСведенийБонусныеБаллыКСписанию

Описание, пример вызова

// Выполняет корректировку регистра сведений "Бонусные баллы к списанию"
//
// Параметры:
//  Объект - ДокументОбъект.ЧекККМ
//
Процедура СкорректироватьРегистрСведенийБонусныеБаллыКСписанию(Объект) Экспорт

Пример вызова

СерверЛояльностиПоставщикДанных.СкорректироватьРегистрСведенийБонусныеБаллыКСписанию(Объект)

СкорректироватьРегистрСведенийПодарочныеСертификатыКСписанию

Описание, пример вызова

// Выполняет корректировку регистра сведений "Бонусные баллы к списанию"
//
// Параметры:
//  Объект - ДокументОбъект.ЧекККМ
//
Процедура СкорректироватьРегистрСведенийПодарочныеСертификатыКСписанию(Объект) Экспорт

Пример вызова

СерверЛояльностиПоставщикДанных.СкорректироватьРегистрСведенийПодарочныеСертификатыКСписанию(Объект)

СкорректироватьРегистрСведенийПромокодыКСписанию

Описание, пример вызова

// Выполняет корректировку регистра сведений "Промокоды к списанию"
//
// Параметры:
//  Объект - ДокументОбъект.ЧекККМ
//
Процедура СкорректироватьРегистрСведенийПромокодыКСписанию(Объект) Экспорт

Пример вызова

СерверЛояльностиПоставщикДанных.СкорректироватьРегистрСведенийПромокодыКСписанию(Объект)

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

Описание, пример вызова

// Разблокирует подарочный сертификат
//
// Параметры:
//  ДанныеСертификата - Структура - содержит ссылки на подарочный сертификат и его серийный номер.
//
Процедура РазблокироватьПодарочныйСертификат(ДанныеСертификата) Экспорт

Пример вызова

СерверЛояльностиПоставщикДанных.РазблокироватьПодарочныйСертификат(ДанныеСертификата)

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

Описание, пример вызова

// Списывает баланс подарочного сертификата
//
// Параметры:
//  ДанныеСертификата - Структура - Содержит данные подарочного сертификата: ПодарочныйСертификат, СерийныйНомер
//  СуммаСписания    - Число     - Сумма списания которая будет списана с баланса подарочного сертификата
//
Процедура СписатьБалансПодарочногоСертификата(ДанныеСертификата, СуммаСписания) Экспорт

Пример вызова

СерверЛояльностиПоставщикДанных.СписатьБалансПодарочногоСертификата(ДанныеСертификата, СуммаСписания)

ПолучитьСуммуПодарочногоСертификатаРезерв

Описание, пример вызова

// Возвращает зарезервированную сумму подарочного сертификата
//
// Параметры:
//  ДанныеСертификата - Структура - Содержит данные подарочного сертификата: ПодарочныйСертификат, СерийныйНомер
//
// Возвращаемое значение:
//  Число - сумма, находящаяся в резерве
//
Функция ПолучитьСуммуПодарочногоСертификатаРезерв(ДанныеСертификата) Экспорт

Пример вызова

Результат = СерверЛояльностиПоставщикДанных.ПолучитьСуммуПодарочногоСертификатаРезерв(ДанныеСертификата)

ЗаблокироватьПодарочныйСертификат

Описание, пример вызова

// Блокирует подарочный сертификат после ответа Сервиса Лояльности с целью предотвращения двойного списания баланса
//
// Параметры:
//  ДанныеСертификата - Структура - содержит ссылки на подарочный сертификат и его серийный номер
//  ДатаБлокировки    - Дата
//
Процедура ЗаблокироватьПодарочныйСертификат(ДанныеСертификата, ДатаБлокировки) Экспорт

Пример вызова

СерверЛояльностиПоставщикДанных.ЗаблокироватьПодарочныйСертификат(ДанныеСертификата, ДатаБлокировки)

ЗарезервироватьПрименениеПромокода

Описание, пример вызова

// Резервирует одно применение промокода после ответа Сервиса Лояльности с целью предотвращения двойного применения
// конечного промокода.
//
// Параметры:
//  Промокод - ОпределяемыйТип.ПромокодСерверЛояльности - Строка содержащая промокод
//
Процедура ЗарезервироватьПрименениеПромокода(Промокод) Экспорт

Пример вызова

СерверЛояльностиПоставщикДанных.ЗарезервироватьПрименениеПромокода(Промокод)

СнятьРезервПримененияПромокода

Описание, пример вызова

// Отменяет резерв применения конечного промокода
//
// Параметры:
//  Промокод - ОпределяемыйТип.ПромокодСерверЛояльности - Строка содержащая промокод.
//
Процедура СнятьРезервПримененияПромокода(Промокод) Экспорт

Пример вызова

СерверЛояльностиПоставщикДанных.СнятьРезервПримененияПромокода(Промокод)

ЗафиксироватьОшибкуСервисаЛояльности

Описание, пример вызова

// Фиксирует ошибку Сервиса Лояльности в журнале регистрации
//
// Параметры:
//  ОписаниеОшибки - Строка - текстовое описание возникшей ошибки
//  ИмяФункции     - Строка - наименование функции Сервиса лояльности
//
// Возвращаемое значение:
//  HTTPСервисОтвет
//
Функция ЗафиксироватьОшибкуСервисаЛояльности(ОписаниеОшибки, ИмяФункции) Экспорт

Пример вызова

Результат = СерверЛояльностиПоставщикДанных.ЗафиксироватьОшибкуСервисаЛояльности(ОписаниеОшибки, ИмяФункции)

ОбработкаСостоянияБонусовИПодарочныхСертификатов

Описание, пример вызова

// Выполняет обработку состояния бонусов и подарочных сертификатов клиентов
// Происходит проверка наличия заблокированных бонусов и подарочных сертификатов клиентов
// Если такие найдены и время экспирации для них истекло - происходит разблокировка
Процедура ОбработкаСостоянияБонусовИПодарочныхСертификатов() Экспорт

Пример вызова

СерверЛояльностиПоставщикДанных.ОбработкаСостоянияБонусовИПодарочныхСертификатов()

ПолучитьСтруктуруЗапретаПродаж

Описание, пример вызова

// Возвращает структуру запрета продаж
//
// Параметры:
//  Организация - СправочникСсылка.Организации - организация.
//  Магазин   - СправочникСсылка.Магазины - магазин.
//
// Возвращаемое значение:
//  Структура - структура, содержащая в себе данные о запретах продаж:
//    * StartDate - Дата -дата начала действия запрета продаж.
//    * EndDate - Дата -дата окончания действия запрета продаж.
//    * SalesPromotionID - Строка -тестовое значение ГУИД маркетинговой акции/скидки, в которое содержатся данные
//                         запрета продаж.
//    * SalesPromotionName - Строка - наименование маркетинговой акции/скидки, в которое содержатся данные запрета продаж.
//    * Organisation - Структура - данные организации:
//      ** Name - Строка - наименование организации.
//      ** Ref - Строка - текстовое значение ГУИД организации.
//      ** ID - Строка - код организации.
//      ** TIN - Строка - ИНН организации.
//    * Store - Структура - данные магазина:
//       ** Name - Строка - наименование магазина.
//       ** Ref - Строка - текстовое значение ГУИД магазина.
//       ** ID - Строка - код магазина.
//    * DaysOfWeek - Массив из Строка - массив дней недели, на которые распространяется запрет продаж.
//   *  TypesOfGoods - Массив из Строка - массив видов номенклатуры, на которые распространяется запрет продаж.
//
Функция ПолучитьСтруктуруЗапретаПродаж(Организация = Неопределено, Магазин = Неопределено) Экспорт

Пример вызова

Результат = СерверЛояльностиПоставщикДанных.ПолучитьСтруктуруЗапретаПродаж(Организация, Магазин);

ПолучитьСтруктуруОстатков

Описание, пример вызова

// Возвращает структуру содержащую сведенья об остатках
//
// Возвращаемое значение:
//  Структура - структура, содержащая в себе данные об остатках:
//    * LeftoverLocation - Строка - Место хранения остатков.
//    * Variant - Строка - Характеристика.
//    * Leftover - Число - Остаток.
//    * Reserved - Число - Зарезервировано.
//    * FreeLeftover - Число - Свободный остаток.
//
Функция ПолучитьСтруктуруОстатков() Экспорт

Пример вызова

Результат = СерверЛояльностиПоставщикДанных.ПолучитьСтруктуруОстатков()

ТекстЗапросаБалансПодарочногоСертификата

Описание, пример вызова

// Возвращает текст запроса
//
// Возвращаемое значение:
//  Строка - текст запроса.
//
Функция ТекстЗапросаБалансПодарочногоСертификата() Экспорт

Пример вызова

Результат = СерверЛояльностиПоставщикДанных.ТекстЗапросаБалансПодарочногоСертификата()

ПолучитьДесериализованноеСсылочноеЗначение

Описание, пример вызова

// Возвращает десериализованное значение в виде ГУИД
//
// Параметры:
//  ВходящиеДанные - Структура - структура, содержащая в себе набор параметров из HTTP-запроса.
//  ИмяПараметра - Строка - имя десериализуемого параметра.
//  ТипЗначения - Строка - имя типа значения, например: "Справочники.Номенклатура".
//
// Возвращаемое значение:
//  ЛюбаяСсылка - полученное значение параметра.
//
Функция ПолучитьДесериализованноеСсылочноеЗначение(ВходящиеДанные, ИмяПараметра, ТипЗначения) Экспорт

Пример вызова

Результат = СерверЛояльностиПоставщикДанных.ПолучитьДесериализованноеСсылочноеЗначение(ВходящиеДанные, ИмяПараметра, ТипЗначения)

СписокУправляемыхСкидок

Описание, пример вызова

// Заполняет структуру ответа списком управляемых скидок
//
// Параметры:
//  СтруктураОтвета - Массив - массив структур, содержащий в себе параметры ответа:
//   * ЗначениеСкидки - Число - значение скидки.
//   * Представление - Строка - представление скидки.
//   * ТипСкидки - Строка - тип скидки.
//   * ОбластьДействия - Строка - область действия скидки.
//   * ИдентификаторСкидки - Строка - уникальный идентификатор скидки.
//   * СкидкаНаценка - Строка - наименование скидки.
//  ПараметрыРасчета - -Структура - структура, содержащая в себе набор параметров из HTTP-запроса.
//
Процедура СписокУправляемыхСкидок(СтруктураОтвета, ПараметрыРасчета) Экспорт

Пример вызова

СерверЛояльностиПоставщикДанных.СписокУправляемыхСкидок(СтруктураОтвета, ПараметрыРасчета)

СтруктураКартыЛояльности

Описание, пример вызова

// Инициализирует структуру карты лояльности.
//
// Возвращаемое значение:
//  Структура -  Структура карты лояльности:
// * ClientName - Строка
// * IsPerson - Булево
// * DateOfBirth - Строка
// * Phone - Строка
// * Email - Строка
// * Barcode - Строка
// * MagneticCode - Строка
// * CardGUID - Строка
// * ClientGUID - Строка
// * IsBlocked - Строка
// * BonusData - Структура:
//  ** PaymentPercent - Число
//  ** BonusCount - Число
//  ** BonusRate - Число
//  ** BonusCurrency - Строка
// * SellCount - Число
// * SearchType - Строка
//
Функция СтруктураКартыЛояльности() Экспорт

Пример вызова

Результат = СерверЛояльностиПоставщикДанных.СтруктураКартыЛояльности()

СписокВидовДисконтныхКарт

Описание, пример вызова

// Заполняет структуру ответа списком видов дисконтных карт
//
// Параметры:
//  СтруктураОтвета - Массив - массив структур, содержащий в себе параметры ответа:
//   * Идентификатор - Строка - уникальный идентификатор вида дисконтной карты.
//   * Наименование - Строка - наименование вида дисконтной карты.
//   * ЭтоИменнаяКарта - Булево - признак того что вид дисконтной карты именной.
//
Процедура СписокВидовДисконтныхКарт(СтруктураОтвета) Экспорт

Пример вызова

СерверЛояльностиПоставщикДанных.СписокВидовДисконтныхКарт(СтруктураОтвета)

СписокСотрудников

Описание, пример вызова

// Заполняет список сотрудников
//
// Параметры:
//  ПараметрыРасчета - -Структура - структура, содержащая в себе набор параметров из HTTP-запроса.
//  СтруктураОтвета - Массив - массив структур, содержащий в себе параметры ответа:
//   * СотрудникПредставление - Строка - Наименование сотрудника.
//   * КодСотрудника - Строка - Код сотрудника для входа в РМК.
//   * ИдентификаторСотрудника - Строка - УИД сотрудника.
//
Процедура СписокСотрудников(ПараметрыРасчета, СтруктураОтвета) Экспорт

Пример вызова

СерверЛояльностиПоставщикДанных.СписокСотрудников(ПараметрыРасчета, СтруктураОтвета)

ЗаполнитьСписокСерий

Описание, пример вызова

// Заполняет список серий
//
// Параметры:
//  ПараметрыРасчета - Структура - структура, содержащая в себе набор параметров из HTTP-запроса.
//  СтруктураОтвета - Массив - массив структур, содержащий в себе параметры ответа:
//   * СерияПредставление - Строка - Наименование серии.
//   * ИдентификаторСерий - Строка - УИД серии.
//
Процедура ЗаполнитьСписокСерий(ПараметрыРасчета, СтруктураОтвета) Экспорт

Пример вызова

СерверЛояльностиПоставщикДанных.ЗаполнитьСписокСерий(ПараметрыРасчета, СтруктураОтвета)

СписокСкидокПоВидамОплаты

Описание, пример вызова

// Заполняет структуру ответа списком управляемых скидок
//
// Параметры:
//  СтруктураОтвета - Массив - массив структур, содержащий в себе параметры ответа:
//   * ЗначениеСкидки - Число - значение скидки.
//   * Представление - Строка - представление скидки.
//   * ТипСкидки - Строка - тип скидки.
//   * ОбластьДействия - Строка - область действия скидки.
//   * ИдентификаторСкидки - Строка - уникальный идентификатор скидки.
//   * СкидкаНаценка - Строка - наименование скидки.
//
Процедура СписокСкидокПоВидамОплаты(СтруктураОтвета) Экспорт

Пример вызова

СерверЛояльностиПоставщикДанных.СписокСкидокПоВидамОплаты(СтруктураОтвета)