Сервер лояльности 3.0.7
- Методы сервер лояльности поставщик данных
- ping
- Получить бонусы клиента
- Разблокировать бонусы клиента
- Списать бонусы клиента
- Выдать карту покупателю
- Получить данные подарочного сертификата
- Разблокировать подарочный сертификат
- Списание подарочный сертификат
- Использовать автоматические скидки
- Рассчитать автоматические скидки
- Проверить подарочный сертификат
- Получить список управляемых скидок
- Разблокировать промокод
- Получить данные промокода
- Получить остатки
- Найти карту клиента
- Получить обороты продаж
- Получить виды карт
- Получить список продавцов
- Получить список серий по отбору
- Получить данные серии
- Получить актуальную цену
- Получить список скидок по видам оплаты
Методы сервер лояльности поставщик данных
ping
Процедура проверяет соединение с сервером лояльности
Шаблон: ping
HTTP – метод: GET
Обработчик: pingGET
Код состояния 200 – Ответ «ok»- Тип String
Получить бонусы клиента
Процедура получает данные о бонусах клиента и производит блокировку бонусных баллов карты клиента в управляющей базе.
Шаблон: getclientbonuses
HTTP – метод: GET
Обработчик: ПолучитьБонусыКлиентаGET
Параметры:
| Имя параметра | Тип | Описание |
|---|---|---|
| ClientCardID | String | Номер карты лояльности |
| Phone | String | Номер телефона владельца карты лояльности |
| String | Электронная почта владельца карты лояльности | |
| Client | String | Уникальный идентификатор владельца карты лояльности |
| Store | String | Уникальный идентификатор магазина/склада |
| GiftCardNumber | String | Номер подарочного сертификата |
| GiftCardUID | String | Уникальный идентификатор подарочного сертификата |
| Promocode | String | Номер промокода |
| DiscountToActivateUID | String | Уникальный идентификатор скидки следующей покупки |
| BonusesCount | Number | Количество бонусных баллов |
| GiftCardWriteOffAmount | String | Сумма списания бонусов |
| DateOfBirth | Date | Дата рождения |
| ClientCardTypeUID | String | Уникальный идентификатор вида дисконтной карты |
| BatchUID | String | Уникальный идентификатор серии |
| Characteristic | String | Уникальный идентификатор характеристики |
| Product | String | Уникальный идентификатор номенклатуры |
| TypeProduct | String | Уникальный идентификатор вида номенклатуры |
| TypePriceUID | String | Уникальный идентификатор вида цены |
| MaxSale | Number | Максимальный процент ручной скидки |
| MaxMarkup | Number | Максимальный процент ручной наценки |
| TypePriceUID | String | Уникальный идентификатор вида цены |
| UseSelection | Boolean | Признак использования отборов |
| TypeOperationSale | Boolean | Признак вида операции продажа |
| GenerateNumber | Boolean | Признак необходимости генерации номера |
Ответ, тип json, преобразуется в тип Структура
Код состояния 200
| Имя параметра | Тип | Описание |
|---|---|---|
| Error | Boolean | Признак ошибки |
| ErrorMessage | String | Описание ошибки |
| Version | String | Номер версии сервера лояльности |
| BonusCount | Number | Количество бонусных баллов |
| BonusRate | Number | Значение конвертации бонусных баллов к валюте расчета |
| BonusCurrency | String | Код валюты расчета |
| PaymentPercent | Number | Значение максимального процента оплаты |
| CardRef | String | Уникальный идентификатор карты клиента |
| Barcode | String | Штрихкод карты лояльности |
| MagneticCode | String | Магнитный код карты лояльности |
| EndDate | String | Дата окончания действия запрета продаж |
| ClientNotFound | Boolean | Признак результата поиска карты лояльности |
Разблокировать бонусы клиента
Процедура разблокирует данные бонусной карты лояльности в управляющей базе
Шаблон: unlockclientbonuses
HTTP – метод: POST
Обработчик: РазблокироватьБонусыКлиентаPOST
Параметры:
| Имя параметра | Тип | Описание |
|---|---|---|
| ClientCardID | String | Номер карты лояльности |
| Phone | String | Номер телефона владельца карты лояльности |
| String | Электронная почта владельца карты лояльности | |
| Client | String | Уникальный идентификатор владельца карты лояльности |
| Store | String | Уникальный идентификатор магазина/склада |
| GiftCardNumber | String | Номер подарочного сертификата |
| GiftCardUID | String | Уникальный идентификатор подарочного сертификата |
| Promocode | String | Номер промокода |
| DiscountToActivateUID | String | Уникальный идентификатор скидки следующей покупки |
| BonusesCount | Number | Количество бонусных баллов |
| GiftCardWriteOffAmount | String | Сумма списания бонусов |
| DateOfBirth | Date | Дата рождения |
| ClientCardTypeUID | String | Уникальный идентификатор вида дисконтной карты |
| BatchUID | String | Уникальный идентификатор серии |
| Characteristic | String | Уникальный идентификатор характеристики |
| Product | Strig | Уникальный идентификатор номенклатуры |
| TypeProduct | String | Уникальный идентификатор вида номенклатуры |
| TypePriceUID | String | Уникальный идентификатор вида цены |
| MaxSale | Number | Максимальный процент ручной скидки |
| MaxMarkup | Number | Максимальный процент ручной наценки |
| UseSelection | Boolean | Признак использования отборов |
| TypeOperationSale | Boolean | Признак вида операции продажа |
| GenerateNumber | Boolean | Признак необходимости генерации номера |
Ответ: Текст сообщения – Тип String
Списать бонусы клиента
Процедура списывает указанное количество бонусных баллов с баланса карты лояльности
Шаблон: writeoffclientbonuses
HTTP – метод: POST
Обработчик: СписатьБонусыКлиентаPOST
Параметры:
| Имя параметра | Тип | Описание |
|---|---|---|
| ClientCardID | String | Номер карты лояльности |
| Phone | String | Номер телефона владельца карты лояльности |
| String | Электронная почта владельца карты лояльности | |
| Client | String | Уникальный идентификатор владельца карты лояльности |
| Store | String | Уникальный идентификатор магазина/склада |
| GiftCardNumber | String | Номер подарочного сертификата |
| GiftCardUID | String | Уникальный идентификатор подарочного сертификата |
| Promocode | String | Номер промокода |
| DiscountToActivateUID | String | Уникальный идентификатор скидки следующей покупки |
| BonusesCount | Number | Количество бонусных баллов |
| GiftCardWriteOffAmount | String | Сумма списания бонусов |
| DateOfBirth | Date | Дата рождения |
| ClientCardTypeUID | String | Уникальный идентификатор вида дисконтной карты |
| BatchUID | String | Уникальный идентификатор серии |
| Characteristic | String | Уникальный идентификатор характеристики |
| Product | String | Уникальный идентификатор номенклатуры |
| TypeProduct | String | Уникальный идентификатор вида номенклатуры |
| TypePriceUID | String | Уникальный идентификатор вида цены |
| MaxSale | Number | Максимальный процент ручной скидки |
| MaxMarkup | Number | Максимальный процент ручной наценки |
| UseSelection | Boolean | Признак использования отборов |
| TypeOperationSale | Boolean | Признак вида операции продажа |
| GenerateNumber | Boolean | Признак необходимости генерации номера |
Ответ: Текст сообщения – Тип String
Выдать карту покупателю
Процедура производит регистрацию новой карты лояльности клиента
Шаблон:issueclientcard
HTTP – метод: POST
Обработчик: ВыдатьКартуКлиентуPOST
Параметры:
| Имя параметра | Тип | Описание |
|---|---|---|
| ClientCardID | String | Номер карты лояльности |
| Phone | String | Номер телефона владельца карты лояльности |
| String | Электронная почта владельца карты лояльности | |
| Client | String | Уникальный идентификатор владельца карты лояльности |
| Store | String | Уникальный идентификатор магазина/склада |
| GiftCardNumber | String | Номер подарочного сертификата |
| GiftCardUID | String | Уникальный идентификатор подарочного сертификата |
| Promocode | String | Номер промокода |
| DiscountToActivateUID | String | Уникальный идентификатор скидки следующей покупки |
| BonusesCount | Number | Количество бонусных баллов |
| GiftCardWriteOffAmount | String | Сумма списания бонусов |
| DateOfBirth | Date | Дата рождения |
| ClientCardTypeUID | String | Уникальный идентификатор вида дисконтной карты |
| BatchUID | String | Уникальный идентификатор серии |
| Characteristic | String | Уникальный идентификатор характеристики |
| Product | String | Уникальный идентификатор номенклатуры |
| TypeProduct | String | Уникальный идентификатор вида номенклатуры |
| TypePriceUID | String | Уникальный идентификатор вида цены |
| MaxSale | Number | Максимальный процент ручной скидки |
| MaxMarkup | Number | Максимальный процент ручной наценки |
| UseSelection | Boolean | Признак использования отборов |
| TypeOperationSale | Boolean | Признак вида операции продажа |
| GenerateNumber | Boolean | Признак необходимости генерации номера |
Ответ, тип json, преобразуется в тип Структура
Код состояния 200
| Имя параметра | Тип | Описание |
|---|---|---|
| Error | Boolean | Признак ошибки |
| ErrorMessage | String | Описание ошибки |
| Version | String | Номер версии сервера лояльности |
| ExistingCard | Boolean | Карта найдена |
| CardRef | Number | Уникальный идентификатор карты |
| CardID | String | Номер карты клиента |
| Client | Number | Уникальный идентификатор владельца дисконтной карты |
| PhoneNumber | String | Номер телефона владельца дисконтной карты |
| String | Электронная почта владельца дисконтной карты | |
| DateOfBirth | Date | Дата рождения владельца дисконтной карты |
| ClientNotFound | Boolean | Признак результата поиска карты лояльности |
Получить данные подарочного сертификата
Процедура получает данные о подарочном сертификате и производит блокировку подарочного сертификата в управляющей базе
Шаблон: getgiftcardinfo
HTTP – метод: GET
Обработчик: ПолучитьДанныеПодарочногоСертификатаGET
Параметры:
| Имя параметра | Тип | Описание |
|---|---|---|
| ClientCardID | String | Номер карты лояльности |
| Phone | String | Номер телефона владельца карты лояльности |
| String | Электронная почта владельца карты лояльности | |
| Client | String | Уникальный идентификатор владельца карты лояльности |
| Store | String | Уникальный идентификатор магазина/склада |
| GiftCardNumber | String | Номер подарочного сертификата |
| GiftCardUID | String | Уникальный идентификатор подарочного сертификата |
| Promocode | String | Номер промокода |
| DiscountToActivateUID | String | Уникальный идентификатор скидки следующей покупки |
| BonusesCount | Number | Количество бонусных баллов |
| GiftCardWriteOffAmount | String | Сумма списания бонусов |
| DateOfBirth | Date | Дата рождения |
| ClientCardTypeUID | String | Уникальный идентификатор вида дисконтной карты |
| BatchUID | String | Уникальный идентификатор серии |
| Characteristic | String | Уникальный идентификатор характеристики |
| Product | String | Уникальный идентификатор номенклатуры |
| TypeProduct | String | Уникальный идентификатор вида номенклатуры |
| TypePriceUID | String | Уникальный идентификатор вида цены |
| MaxSale | Number | Максимальный процент ручной скидки |
| MaxMarkup | Number | Максимальный процент ручной наценки |
| UseSelection | Boolean | Признак использования отборов |
| TypeOperationSale | Boolean | Признак вида операции продажа |
| GenerateNumber | Boolean | Признак необходимости генерации номера |
Ответ, тип json, преобразуется в тип Структура
Код состояния 200
| Имя параметра | Тип | Описание |
|---|---|---|
| Error | Boolean | Признак ошибки |
| ErrorMessage | String | Описание ошибки |
| Version | String | Номер версии сервера лояльности |
| GiftCard | Structure | Описание подарочного сертификата |
| GiftCardNumber | String | Номер подарочного сертификата |
| GiftCardValue | Number | Номинал подарочного сертификата |
| GiftCardBalance | Number | Остаток суммы подарочного сертификата |
| Blocked | Boolean | Признак блокировки подарочного сертификата |
| Имя параметра | Тип | Описание |
|---|---|---|
| GiftCardName | String | Наименование подарочного сертификата |
| GiftCardRef | String | Уникальный идентификатор |
Разблокировать подарочный сертификат
Процедура производит разблокировку подарочного сертификата в управляющей базе.
Шаблон:unlockgiftcard
HTTP – метод: POST
Обработчик: РазблокироватьПодарочныйСертификатPOST
Параметры:
| Имя параметра | Тип | Описание |
|---|---|---|
| ClientCardID | String | Номер карты лояльности |
| Phone | String | Номер телефона владельца карты лояльности |
| String | Электронная почта владельца карты лояльности | |
| Client | String | Уникальный идентификатор владельца карты лояльности |
| Store | String | Уникальный идентификатор магазина/склада |
| GiftCardNumber | String | Номер подарочного сертификата |
| GiftCardUID | String | Уникальный идентификатор подарочного сертификата |
| Promocode | String | Номер промокода |
| DiscountToActivateUID | String | Уникальный идентификатор скидки следующей покупки |
| BonusesCount | Number | Количество бонусных баллов |
| GiftCardWriteOffAmount | String | Сумма списания бонусов |
| DateOfBirth | Date | Дата рождения |
| ClientCardTypeUID | String | Уникальный идентификатор вида дисконтной карты |
| BatchUID | String | Уникальный идентификатор серии |
| Characteristic | String | Уникальный идентификатор характеристики |
| Product | String | Уникальный идентификатор номенклатуры |
| TypeProduct | String | Уникальный идентификатор вида номенклатуры |
| TypePriceUID | String | Уникальный идентификатор вида цены |
| MaxSale | Number | Максимальный процент ручной скидки |
| MaxMarkup | Number | Максимальный процент ручной наценки |
| UseSelection | Boolean | Признак использования отборов |
| TypeOperationSale | Boolean | Признак вида операции продажа |
| GenerateNumber | Boolean | Признак необходимости генерации номера |
Ответ: Текст сообщения – Тип String
Списание подарочный сертификат
Процедура списывает указанный номинал с подарочного сертификата
Шаблон: writeoffgiftcard
HTTP – метод: POST
Обработчик: СписатьПодарочныйСертификатPOST
Параметры:
| Имя параметра | Тип | Описание |
|---|---|---|
| ClientCardID | String | Номер карты лояльности |
| Phone | String | Номер телефона владельца карты лояльности |
| String | Электронная почта владельца карты лояльности | |
| Client | String | Уникальный идентификатор владельца карты лояльности |
| Store | String | Уникальный идентификатор магазина/склада |
| GiftCardNumber | String | Номер подарочного сертификата |
| GiftCardUID | String | Уникальный идентификатор подарочного сертификата |
| Promocode | String | Номер промокода |
| DiscountToActivateUID | String | Уникальный идентификатор скидки следующей покупки |
| BonusesCount | Number | Количество бонусных баллов |
| GiftCardWriteOffAmount | ||
| DateOfBirth | Date | Дата рождения |
| ClientCardTypeUID | String | Уникальный идентификатор вида дисконтной карты |
| BatchUID | String | Уникальный идентификатор серии |
| Characteristic | String | Уникальный идентификатор характеристики |
| Product | String | Уникальный идентификатор номенклатуры |
| TypeProduct | String | Уникальный идентификатор вида номенклатуры |
| TypePriceUID | String | Уникальный идентификатор вида цены |
| MaxSale | Number | Максимальный процент ручной скидки |
| MaxMarkup | Number | Максимальный процент ручной наценки |
| UseSelection | Boolean |
Признак использования отборов |
| TypeOperationSale | Boolean | Признак вида операции продажа |
| GenerateNumber | Boolean | Признак необходимости генерации номера |
Ответ: Текст сообщения – Тип String
Использовать автоматические скидки
Процедура возвращает признак использования автоматических скидок в управляющей базе.
Шаблон: useautomaticdiscounts
HTTP – метод: GET
Обработчик: ИспользоватьАвтоматическиеСкидкиGET
Параметры: нет
Ответ,тип json, преобразуется в тип Структура
Код состояния 200
| Имя параметра | Тип | Описание |
|---|---|---|
| Error | Boolean | Признак ошибки |
| ErrorMessage | String | Описание ошибки |
| Version | String | Номер версии сервера лояльности |
| UseAutomaticDiscounts | Boolean | Признак использования автоматических скидок |
Рассчитать автоматические скидки
Шаблон: calculatediscounts
HTTP – метод: POST
Обработчик: РассчитатьАвтоматическиеСкидкиPOST
HTTP – метод: GET
Обработчик: РассчитатьАвтоматическиеСкидкиGET
Параметры:
| Имя параметра | Тип | Описание |
|---|---|---|
| LoyaltyCardsList | Array | Список карт лояльности |
| Goods | Array | Список табличной части товаров |
| PromocodesList | Array | Список промокодов |
| ControlledDiscountsList | Array | Список выбранных управляемых скидок |
| CurrentDate | Date | Дата расчета скидок |
| RetailStore | Structure | Значение магазина расчета скидок |
| Return | Boolean | Признак вида операции возврат |
| GetLoyaltyCardData | Boolean | Признак необходимости возврата данных карты |
| GetMaxBonusPay | Boolean | Признак необходимости возврата максимального значения бонусных баллов |
| BlockBonuses | Number | Значение блокировки бонусных баллов |
| GetPossibleOnPayDiscounts | Boolean | Признак необходимости рассчитывать скидки за вид оплаты |
| PayTypes | Array | Список доступных видов оплаты |
Параметр LoyaltyCardsList.
| Имя параметра | Тип | Описание |
|---|---|---|
| LoyaltyCardsList | Link | Дисконтная карта |
Параметр Goods:
| Имя параметра | Тип | Описание |
|---|---|---|
| Item | Link | Номенклатура |
| Package | Link | Единица измерения |
| Variant | Link | Характеристика |
| Price | Number | Цена |
| Amount | Number | Сумма |
| Count | Number | Количество |
| PackagesCount | Number | Количество в базовых единицах |
| VATRate | String | Наименование ставки НДС |
| PercentOfAutomaticDiscount | Number | Процент автоматической скидки |
| PercentOfManualDiscount | Number | Процент скидки наценки |
| AmountOfAutomaticDiscount | Number | Сумма автоматической скидки |
| AmountOfManualDiscount | Number | Сумма скидки наценки |
| TotalAmount | Number | Всего |
| VATAmount | Number | Сумма НДС |
| LineUID | String | Идентификатор строки |
| Order | Link | Заказ |
| AmountOfBonusPay | Number | Сумма скидки оплаты бонусами |
Параметр Ссылка:
| Имя параметра | Тип | Описание |
|---|---|---|
| Ref | String | Уникальный идентификатор |
| Name | String | Представление |
Параметр PromocodesList:
| Имя параметра | Тип | Описание |
|---|---|---|
| Promocode | Link | Промокод |
| PromocodeDiscountUID | String | Уникальный идентификатор скидки |
Параметр ControlledDiscountsLis:
| Имя параметра | Тип | Описание |
|---|---|---|
| ControlledDiscountsList | String | Уникальный идентификатор скидки |
| LineUID | String | Идентификатор строки |
| KeyRelation | String | Ключ связи |
Параметр RetailStore:
| Имя параметра | Тип | Описание |
|---|---|---|
| Ref | String | Уникальный идентификатор |
| Name | String | Представление |
Структура параметра PayTypes:
| Имя параметра | Тип | Описание |
|---|---|---|
| PayType | String | Наименование вида оплаты |
| IsUsed | Boolean | Признак использования вида оплаты |
Ответ, тип json, преобразуется в тип Структура
Код состояния 200
| Имя параметра | Тип | Описание |
|---|---|---|
| Error | Boolean | Признак ошибки |
| ErrorMessage | String | Описание ошибки |
| Version | String | Номер версии сервера лояльности |
| Goods | Array | Описание таблицы товаров |
| DiscountsList | Array | Таблица примененных скидок/наценок |
| PromocodesList | Array | Таблица примененных промокодов |
| BonusesToAccrue | Array | Таблица бонусов к начислению |
| Gifts | Array | Таблица подарков |
| CurrentDiscounts | Array | Таблица действующих скидок наценок |
| Messages | Array | Таблица сообщений применения скидок |
| LoyaltyCardDescription | Structure | Описание данных карты |
| MaxBonusPay | Number | Максимальная сумма оплаты бонусами |
| PossibleOnPayDiscouns | Array | Таблица скидок за вид оплаты |
Структура параметра Goods:
| Имя параметра | Тип | Описание |
|---|---|---|
| Item | Link | Номенклатура |
| Package | Link | Единица измерения |
| Variant | Link | Характеристика |
| Price | Number | Цена |
| Amount | Number | Сумма |
| Count | Number | Количество |
| PackagesCount | Number | Количество в базовых единицах |
| VATRate | String | Наименование ставки НДС |
| PercentOfAutomaticDiscount | Number | Процент автоматической скидки |
| PercentOfManualDiscount | Number | Процент скидки наценки |
| AmountOfAutomaticDiscount | Number | Сумма автоматической скидки |
| AmountOfManualDiscount | Number | Сумма скидки наценки |
| TotalAmount | Number | Всего |
| VATAmount | Number | Сумма НДС |
| LineUID | String | Идентификатор строки |
| Order | Link | Заказ |
Структура параметра DiscountsList:
| Имя параметра | Тип | Описание |
|---|---|---|
| KeyRelation | String | Ключ связи |
| Discount | Link | Описание скидки |
| DiscountValue | Number | Значение скидки наценки |
| Amount | Number | Сумма |
| MinimalPriceRestriction | Boolean | Признак ограничения минимальной ценой |
| Comment | String | Комментарий |
| LineUID | String | Идентификатор строки |
| Return | Boolean | Признак скидки при возврате товаров |
Структура параметра PromocodesList:
| Имя параметра | Тип | Описание |
|---|---|---|
| Promocode | Link | Промокод |
| DiscountActive | Boolean | Признак предоставления скидки по промокоду |
| PromocodeActivation | Boolean | Признак активации промокода |
| PromocodeDiscount | Link | Скидка наценка по промокоду |
| ErrorDescription | String | Описание ошибки применения |
| PromocodeUID | String | Уникальный идентификатор промокода |
| DiscountCondition | Link | Условие предоставления скидки наценки |
Структура параметра BonusesToAccrue:
| Имя параметра | Тип | Описание |
|---|---|---|
| KeyRelation | String | Ключ связи |
| Discount | Link | Описание скидки |
| BonusProgramm | Link | Описание бонусной программы |
| BonusCount | Number | Количество бонусных баллов к начислению |
| AccuralDate | Date | Дата начисления |
| WriteOffDate | Date | Дата списания |
Структура параметра Gifts:
| Имя параметра | Тип | Описание |
|---|---|---|
| Item | Link | Номенклатура |
| Storage | Link | Магазин |
| Variant | Link | Характеристика |
| Package | Link | Единица измерения |
| Count | Number | Количество |
| PackagesCount | Number | Количество в ед. измерения |
| Price | Number | Цена |
| Amount | Number | Сумма |
| GiftFromTheList | Boolean | Признак выбора подарка из списка |
| ShoppingCart | Boolean | Признак учета подарка как продажу |
| GiftOwner | String | Уникальный идентификатор скидки |
| GiftName | String | Представление скидки |
Структура параметра CurrentDiscounts:
| Имя параметра | Тип | Описание |
|---|---|---|
| Discounts | Link | Скидка наценка |
| DiscountValue | Number | Значение скидки наценки |
| Group | Boolean | Признак это группа |
| Completed | Number | Количество выполненных условий |
| Parent | String | Уникальный идентификатор родителя |
| TermsDiscounts | String | Описание условий предоставления |
Структура параметра Messages:
| Имя параметра | Тип | Описание |
|---|---|---|
| AfterSale | Boolean | Признак вывода сообщения после пробития чека |
| MessageText | String | Текст сообщения |
Структура параметра LoyaltyCardDescription:
| Имя параметра | Тип | Описание |
|---|---|---|
| CardNotFound | Boolean | Признак результата поиска карты |
| LoyaltyCard | Structure | Структура описания карты лояльности |
Структура параметра LoyaltyCard:
| Имя параметра | Тип | Описание |
|---|---|---|
| ClientName | String | Наименование клиента |
| IsPerson | Boolean | Признак физического лица |
| DateOfBirth | Date | Дата рождения |
| Phone | String | Номер телефона |
| String | Электронная почта | |
| Barcode | String | Штрихкод |
| MagneticCode | String | Магнитный код |
| CardGUID | String | Уникальный идентификатор карты |
| ClientGUID | String | Уникальный идентификатор владельца карты лояльности |
| IsBlocked | Boolean | Признак блокировки бонусов |
| BonusData | Structure | Описание данных бонусов |
| SellCount | Number | Значение оборота продаж |
| SearchType | String | Тип поиска |
Структура параметра BonusData:
| Имя параметра | Тип | Описание |
|---|---|---|
| PaymentPercent | Number | Максимальный процент оплаты бонусами |
| BonusCount | Number | Остаток бонусных баллов |
| BonusRate | Number | Курс конвертации бонусных баллов |
Структура параметра PossibleOnPayDiscouns:
| Имя параметра | Тип | Описание |
|---|---|---|
| PayType | String | Уникальный идентификатор вида оплаты |
| Amount | Number | Сумма скидки |
Проверить подарочный сертификат
Шаблон:checkgiftcard
HTTP – метод: GET
Обработчик: ПроверитьПодарочныйСертификатGET
Параметры:
| Имя параметра | Тип | Описание |
|---|---|---|
| ClientCardID | String | Номер карты лояльности |
| Phone | String | Номер телефона владельца карты лояльности |
| String | Электронная почта владельца карты лояльности | |
| Client | String | Уникальный идентификатор владельца карты лояльности |
| Store | String | Уникальный идентификатор магазина/склада |
| GiftCardNumber | String | Номер подарочного сертификата |
| GiftCardUID | String | Уникальный идентификатор подарочного сертификата |
| Promocode | String | Номер промокода |
| DiscountToActivateUID | String | Уникальный идентификатор скидки следующей покупки |
| BonusesCount | Number | Количество бонусных баллов |
| GiftCardWriteOffAmount | String | Сумма списания бонусов |
| DateOfBirth | Date | Дата рождения |
| ClientCardTypeUID | String | Уникальный идентификатор вида дисконтной карты |
| BatchUID | String | Уникальный идентификатор серии |
| Characteristic | String | Уникальный идентификатор характеристики |
| Product | String | Уникальный идентификатор номенклатуры |
| TypeProduct | String | Уникальный идентификатор вида номенклатуры |
| TypePriceUID | String | Уникальный идентификатор вида цены |
| MaxSale | Number | Максимальный процент ручной скидки |
| MaxMarkup | Number | Максимальный процент ручной наценки |
| UseSelection | Boolean | Признак использования отборов |
| TypeOperationSale | Boolean | Признак вида операции продажа |
| GenerateNumber | Boolean |
Ответ, тип json, преобразуется в тип Структура
Код состояния 200
| Имя параметра | Тип | Описание |
|---|---|---|
| Error | Boolean | Признак ошибки |
| ErrorMessage | String | Описание ошибки |
| Version | String | Номер версии сервера лояльности |
| GiftCardUsed | Boolean | Признак использования подарочного сертификата |
Получить список управляемых скидок
Шаблон: getcontrolleddiscountslist
HTTP – метод: GET
Обработчик: ПолучитьСписокУправляемыхСкидокGET
Параметры:
| Имя параметра | Тип | Описание |
|---|---|---|
| ClientCardID | String | Номер карты лояльности |
| Phone | String | Номер телефона владельца карты лояльности |
| String | Электронная почта владельца карты лояльности | |
| Client | String | Уникальный идентификатор владельца карты лояльности |
| Store | String | Уникальный идентификатор магазина/склада |
| GiftCardNumber | String | Номер подарочного сертификата |
| GiftCardUID | String | Уникальный идентификатор подарочного сертификата |
| Promocode | String | Номер промокода |
| DiscountToActivateUID | String | Уникальный идентификатор скидки следующей покупки |
| BonusesCount | Number | Количество бонусных баллов |
| GiftCardWriteOffAmount | String | Сумма списания бонусов |
| DateOfBirth | Date | Дата рождения |
| ClientCardTypeUID | String | Уникальный идентификатор вида дисконтной карты |
| BatchUID | String | Уникальный идентификатор серии |
| Characteristic | String | Уникальный идентификатор характеристики |
| Product | String | Уникальный идентификатор номенклатуры |
| TypeProduct | String | Уникальный идентификатор вида номенклатуры |
| TypePriceUID | String | Уникальный идентификатор вида цены |
| MaxSale | Number | Максимальный процент ручной скидки |
| MaxMarkup | Number | Максимальный процент ручной наценки |
| UseSelection | Boolean | Признак использования отборов |
| TypeOperationSale | Boolean | Признак вида операции продажа |
| GenerateNumber | Boolean | Признак необходимости генерации номера |
Ответ,тип json, преобразуется в тип Структура
Код состояния 200
| Имя параметра | Тип | Описание |
|---|---|---|
| DiscountValue | Number | Значение скидки наценки |
| DiscountDescription | String | Представление управляемой скидки |
| DiscoutType | String | Тип скидки |
| ApplicationArea | String | Область действия |
| DiscountID | String | Идентификатор строки |
| DiscountRef | String | Уникальный идентификатор скидки |
| Return | Boolean | Признак применения скидки при возврате |
| Bonuses | Boolean | Признак применения скидки для начисления бонусов |
Разблокировать промокод
Шаблон: unlockpromocode
HTTP – метод: POST
Обработчик: РазблокироватьПромокодPOST
Параметры:
| Имя параметра | Тип | Описание |
|---|---|---|
| ClientCardID | String | Номер карты лояльности |
| Phone | String | Номер телефона владельца карты лояльности |
| String | Электронная почта владельца карты лояльности | |
| Client | String | Уникальный идентификатор владельца карты лояльности |
| Store | String | Уникальный идентификатор магазина/склада |
| GiftCardNumber | String | Номер подарочного сертификата |
| GiftCardUID | String | Уникальный идентификатор подарочного сертификата |
| Promocode | String | Номер промокода |
| DiscountToActivateUID | String | Уникальный идентификатор скидки следующей покупки |
| BonusesCount | Number | Количество бонусных баллов |
| GiftCardWriteOffAmount | String | Сумма списания бонусов |
| DateOfBirth | Date | Дата рождения |
| ClientCardTypeUID | String | Уникальный идентификатор вида дисконтной карты |
| BatchUID | String | Уникальный идентификатор серии |
| Characteristic | String | Уникальный идентификатор характеристики |
| Product | String | Уникальный идентификатор номенклатуры |
| TypeProduct | String | Уникальный идентификатор вида номенклатуры |
| TypePriceUID | String | Уникальный идентификатор вида цены |
| MaxSale | Number | Максимальный процент ручной скидки |
| MaxMarkup | Number | Максимальный процент ручной наценки |
| UseSelection | Boolean | Признак использования отборов |
| TypeOperationSale | Boolean | Признак вида операции продажа |
| GenerateNumber | Boolean | Признак необходимости генерации номера |
Получить данные промокода
Шаблон:promocodeinfo
HTTP – метод: GET
Обработчик: ПолучитьДанныеПромокодаGET
Параметры:
| Имя параметра | Тип | Описание |
|---|---|---|
| ClientCardID | String | Номер карты лояльности |
| Phone | String | Номер телефона владельца карты лояльности |
| String | Электронная почта владельца карты лояльности | |
| Client | String | Уникальный идентификатор владельца карты лояльности |
| Store | String | Уникальный идентификатор магазина/склада |
| GiftCardNumber | String | Номер подарочного сертификата |
| GiftCardUID | String | Уникальный идентификатор подарочного сертификата |
| Promocode | String | Номер промокода |
| DiscountToActivateUID | String | Уникальный идентификатор скидки следующей покупки |
| BonusesCount | Number | Количество бонусных баллов |
| GiftCardWriteOffAmount | String | Сумма списания бонусов |
| DateOfBirth | Date | Дата рождения |
| ClientCardTypeUID | String | Уникальный идентификатор вида дисконтной карты |
| BatchUID | String | Уникальный идентификатор серии |
| Characteristic | String | Уникальный идентификатор характеристики |
| Product | String | Уникальный идентификатор номенклатуры |
| TypeProduct | String | Уникальный идентификатор вида номенклатуры |
| TypePriceUID | String | Уникальный идентификатор вида цены |
| MaxSale | Number | Максимальный процент ручной скидки |
| MaxMarkup | Number | Максимальный процент ручной наценки |
| UseSelection | Boolean | Признак использования отборов |
| TypeOperationSale | Boolean | Признак вида операции продажа |
| GenerateNumber | Boolean | Признак необходимости генерации номера |
Ответ, тип json, преобразуется в тип Структура
Код состояния 200
| Имя параметра | Тип | Описание |
|---|---|---|
| Error | Boolean | Признак ошибки |
| ErrorMessage | String | Описание ошибки |
| Version | String | Номер версии сервера лояльности |
| PromocodeIsAvalible | Boolean | Признак доступности промокода |
| PromocodeStatus | String | Описание ошибки промокода |
| PromocodeDiscountDescription | String | Представление скидки промокода |
| PromocodeDiscount | Link | Скидка промокода |
Получить остатки
Шаблон: getleftovers
HTTP – метод: GET
Обработчик: ПолучитьОстаткиGET
HTTP – метод: POST
Обработчик: ПолучитьОстаткиPOST
Параметры:
| Имя параметра | Тип | Описание |
|---|---|---|
| Item | Link | Номенклатура |
| Variant | Link | Характеристики |
| Package | Link | Единицы измерения |
Ответ, тип json, преобразуется в тип Структура
Код состояния 200
| Имя параметра | Тип | Описание |
|---|---|---|
| LeftoverLocation | String | Место хранения |
| Variant | String | Характеристика |
| Leftover | Number | Остаток |
| Reserved | Number | В резерве |
| FreeLeftover | Number | Свободно |
Найти карту клиента
Шаблон: findclientcard
HTTP – метод: GET
Обработчик: НайтиКартуКлиентаGET
Параметры:
| Имя параметра | Тип | Описание |
|---|---|---|
| ClientCardID | String | Номер карты лояльности |
| Phone | String | Номер телефона |
| String | Электронная почта | |
| BlockBonuses | String | Признак блокировки бонусов |
| ClientGUID | String | Уникальный идентификатор владельца карты лояльности |
| CardGUID | String | Уникальный идентификатор карты лояльности |
Ответ,тип json, преобразуется в тип Структура
Код состояния 200
| Имя параметра | Тип | Описание |
|---|---|---|
| Error | Boolean | Признак ошибки |
| ErrorMessage | String | Описание ошибки |
| Version | String | Номер версии сервера лояльности |
| LoyaltyCardsList | Array | Список карт лояльности |
ПараметрLoyaltyCardsList:
| Имя параметра | Тип | Описание |
|---|---|---|
| ClientName | String | Наименование клиенат |
| IsPerson | Boolean | Вид констрагента |
| DateOfBirth | Date | Дата рождения |
| Phone | String | Номер телефона |
| String | Электронная почта | |
| Barcode | String | Штрихкод |
| MagneticCode | String | Мангнитный код |
| CardGUID | String | Уникальный идентификатор карты лояльности |
| ClientGUID | String | Уникальный идентификатор владельца карты лояльности |
| IsBlocked | String | Признак блокировки бонусных баллов |
| BonusData | Structure | Данные о бонусных баллах |
| SellCount | Number | Оборот продаж |
| SearchType | String | Тип поиска |
| Valid | Boolean | Признак действия карты |
Получить обороты продаж
Шаблон: salesturnover
HTTP – метод: GET
Обработчик: ПолучитьОборотыПродажGET
Параметры:
| Имя параметра | Тип | Описание |
|---|---|---|
| ClientCardID | String | Номер карты лояльности |
| Phone | String | Номер телефона владельца карты лояльности |
| String | Электронная почта владельца карты лояльности | |
| Client | String | Уникальный идентификатор владельца карты лояльности |
| Store | String | Уникальный идентификатор магазина/склада |
| GiftCardNumber | String | Номер подарочного сертификата |
| GiftCardUID | String | Уникальный идентификатор подарочного сертификата |
| Promocode | String | Номер промокода |
| DiscountToActivateUID | String | Уникальный идентификатор скидки следующей покупки |
| BonusesCount | Number | Количество бонусных баллов |
| GiftCardWriteOffAmount | String | Сумма списания бонусов |
| DateOfBirth | Date | Дата рождения |
| ClientCardTypeUID | String | Уникальный идентификатор вида дисконтной карты |
| BatchUID | String | Уникальный идентификатор серии |
| Characteristic | String | Уникальный идентификатор характеристики |
| Product | String | Уникальный идентификатор номенклатуры |
| TypeProduct | String | Уникальный идентификатор вида номенклатуры |
| TypePriceUID | String | Уникальный идентификатор вида цены |
| MaxSale | Number | Максимальный процент ручной скидки |
| MaxMarkup | Number | Максимальный процент ручной наценки |
| UseSelection | Boolean | Признак использования отборов |
| TypeOperationSale | Boolean | Признак вида операции продажа |
| GenerateNumber | Boolean | Признак необходимости генерации номера |
Ответ, тип json, преобразуется в тип Структура
Код состояния 200
| Имя параметра | Тип | Описание |
|---|---|---|
| Error | Boolean | Признак ошибки |
| ErrorMessage | String | Описание ошибки |
| Version | String | Номер версии сервера лояльности |
| CardRef | String | Уникальный идентификатор карты |
| SellCount | Number | Оборот продаж |
| Barcode | String | Штрихкод |
| MagneticCode | String | Магнитный код |
| ClientNotFound | Boolean | Признак результата поиска карты лояльности |
Получить виды карт
Шаблон: getcardtypes
HTTP – метод: GET
Обработчик: ПолучитьВидыКартGET
Параметры: нет
Ответ, тип json, преобразуется в тип Структура
Код состояния 200
| Имя параметра | Тип | Описание |
|---|---|---|
| CardTypeID | String | Уникальный идентификатор вида карты лояльности |
| CardTypeDescription | String | Наименование вида карты лояльности |
| IsPerson | Boolean | Признак именной карты лояльности |
| GenerateNumer | Boolean | Признак необходимости генерировать номера карты |
Получить список продавцов
Шаблон:listofemployees
HTTP – метод: GET
Обработчик: ПолучитьСписокПродавцовGET
Параметры:
| Имя параметра | Тип | Описание |
|---|---|---|
| ClientCardID | String | Номер карты лояльности |
| Phone | String | Номер телефона владельца карты лояльности |
| String | Электронная почта владельца карты лояльности | |
| Client | String | Уникальный идентификатор владельца карты лояльности |
| Store | String | Уникальный идентификатор магазина/склада |
| GiftCardNumber | String | Номер подарочного сертификата |
| GiftCardUID | String | Уникальный идентификатор подарочного сертификата |
| Promocode | String | Номер промокода |
| DiscountToActivateUID | String | Уникальный идентификатор скидки следующей покупки |
| BonusesCount | Number | Количество бонусных баллов |
| GiftCardWriteOffAmount | String | Сумма списания бонусов |
| DateOfBirth | Date | Дата рождения |
| ClientCardTypeUID | String | Уникальный идентификатор вида дисконтной карты |
| BatchUID | String | Уникальный идентификатор серии |
| Characteristic | String | Уникальный идентификатор характеристики |
| Product | String | Уникальный идентификатор номенклатуры |
| TypeProduct | String | Уникальный идентификатор вида номенклатуры |
| TypePriceUID | String | Уникальный идентификатор вида цены |
| MaxSale | Number | Максимальный процент ручной скидки |
| MaxMarkup | Number | Максимальный процент ручной наценки |
| UseSelection | Boolean | Признак использования отборов |
| TypeOperationSale | Boolean | Признак вида операции продажа |
| GenerateNumber | Boolean | Признак необходимости генерации номера |
Ответ, тип json, преобразуется в тип Структура
Код состояния 200
| Имя параметра | Тип | Описание |
|---|---|---|
| EmployeeDescription | String | Наименование сотрудника |
| EmployeeCode | String | Код сотрудника |
| EmployeeID | String | Уникальный идентификатор сотрудника |
Получить список серий по отбору
Шаблон: getlistbatches
HTTP – метод: GET
Обработчик: ПолучитьСписокСерийПоОтборуGET
Параметры:
| Имя параметра | Тип | Описание |
|---|---|---|
| ClientCardID | String | Номер карты лояльности |
| Phone | String | Номер телефона владельца карты лояльности |
| String | Электронная почта владельца карты лояльности | |
| Client | String | Уникальный идентификатор владельца карты лояльности |
| Store | String | Уникальный идентификатор магазина/склада |
| GiftCardNumber | String | Номер подарочного сертификата |
| GiftCardUID | String | Уникальный идентификатор подарочного сертификата |
| Promocode | String | Номер промокода |
| DiscountToActivateUID | String | Уникальный идентификатор скидки следующей покупки |
| BonusesCount | Number | Количество бонусных баллов |
| GiftCardWriteOffAmount | String | Сумма списания бонусов |
| DateOfBirth | Date | Дата рождения |
| ClientCardTypeUID | String | Уникальный идентификатор вида дисконтной карты |
| BatchUID | String | Уникальный идентификатор серии |
| Characteristic | String | Уникальный идентификатор характеристики |
| Product | String | Уникальный идентификатор номенклатуры |
| TypeProduct | String | Уникальный идентификатор вида номенклатуры |
| TypePriceUID | String | Уникальный идентификатор вида цены |
| MaxSale | Number | Максимальный процент ручной скидки |
| MaxMarkup | Number | Максимальный процент ручной наценки |
| UseSelection | Boolean | Признак использования отборов |
| TypeOperationSale | Boolean | Признак вида операции продажа |
| GenerateNumber | Boolean | Признак необходимости генерации номера |
Ответ, тип json, преобразуется в тип Структура
Код состояния 200
| Имя параметра | Тип | Описание |
|---|---|---|
| BatchDescription | String | Наименование серии |
| BatchID | String | Уникальный идентификатор серии |
Получить данные серии
Шаблон:getseriesdata
HTTP – метод: GET
Обработчик: ПолучитьДанныеСерииGET
Параметры:
| Имя параметра | Тип | Описание |
|---|---|---|
| ClientCardID | String | Номер карты лояльности |
| Phone | String | Номер телефона владельца карты лояльности |
| String | Электронная почта владельца карты лояльности | |
| Client | String | Уникальный идентификатор владельца карты лояльности |
| Store | String | Уникальный идентификатор магазина/склада |
| GiftCardNumber | String | Номер подарочного сертификата |
| GiftCardUID | String | Уникальный идентификатор подарочного сертификата |
| Promocode | String | Номер промокода |
| DiscountToActivateUID | String | Уникальный идентификатор скидки следующей покупки |
| BonusesCount | Number | Количество бонусных баллов |
| GiftCardWriteOffAmount | String | Сумма списания бонусов |
| DateOfBirth | Date | Дата рождения |
| ClientCardTypeUID | String | Уникальный идентификатор вида дисконтной карты |
| BatchUID | String | Уникальный идентификатор серии |
| Characteristic | String | Уникальный идентификатор характеристики |
| Product | String | Уникальный идентификатор номенклатуры |
| TypeProduct | String | Уникальный идентификатор вида номенклатуры |
| TypePriceUID | String | Уникальный идентификатор вида цены |
| MaxSale | Number | Максимальный процент ручной скидки |
| MaxMarkup | Number | Максимальный процент ручной наценки |
| UseSelection | Boolean | Признак использования отборов |
| TypeOperationSale | Boolean | Признак вида операции продажа |
| GenerateNumber | Boolean | Признак необходимости генерации номера |
Ответ, тип json, преобразуется в тип Структура
Код состояния 200
| Имя параметра | Тип | Описание |
|---|---|---|
| Error | Boolean | Признак ошибки |
| ErrorMessage | String | Описание ошибки |
| Version | String | Номер версии сервера лояльности |
| NameBatch | String | Наименование серии |
| BatchUsed | Boolean | Признак наличия серии |
Получить актуальную цену
Шаблон: getprice
HTTP – метод: GET
Обработчик: ПолучитьАктуальнуюЦенуGET
Параметры:
| Имя параметра | Тип | Описание |
|---|---|---|
| ClientCardID | String | Номер карты лояльности |
| Phone | String | Номер телефона владельца карты лояльности |
| String | Электронная почта владельца карты лояльности | |
| Client | String | Уникальный идентификатор владельца карты лояльности |
| Store | String | Уникальный идентификатор магазина/склада |
| GiftCardNumber | String | Номер подарочного сертификата |
| GiftCardUID | String | Уникальный идентификатор подарочного сертификата |
| Promocode | String | Номер промокода |
| DiscountToActivateUID | String | Уникальный идентификатор скидки следующей покупки |
| BonusesCount | Number | Количество бонусных баллов |
| GiftCardWriteOffAmount | String | Сумма списания бонусов |
| DateOfBirth | Date | Дата рождения |
| ClientCardTypeUID | String | Уникальный идентификатор вида дисконтной карты |
| BatchUID | String | Уникальный идентификатор серии |
| Characteristic | String | Уникальный идентификатор характеристики |
| Product | String | Уникальный идентификатор номенклатуры |
| TypeProduct | String | Уникальный идентификатор вида номенклатуры |
| TypePriceUID | String | Уникальный идентификатор вида цены |
| MaxSale | Number | Максимальный процент ручной скидки |
| MaxMarkup | Number | Максимальный процент ручной наценки |
| UseSelection | Boolean | Признак использования отборов |
| TypeOperationSale | Boolean | Признак вида операции продажа |
| GenerateNumber | Boolean | Признак необходимости генерации номера |
Ответ, тип json, преобразуется в тип Структура
Код состояния 200
| Имя параметра | Тип | Описание |
|---|---|---|
| Error | Boolean | Признак ошибки |
| ErrorMessage | String | Описание ошибки |
| Version | String | Номер версии сервера лояльности |
| TypePriceUID | String | Уникальный идентификатор вида цены |
| Characteristic | String | Характеристика |
| Product | String | Номенклатура |
| BatchUID | String | Уникальный идентификатор серии |
Получить список скидок по видам оплаты
Шаблон: getlistonpaydiscounts
HTTP – метод: GET
Обработчик: ПолучитьСписокСкидокПоВидамОплатыGET
Параметры: нет
Ответ, тип json, преобразуется в тип Структура
Код состояния 200
| Имя параметра | Тип | Описание |
|---|---|---|
| DiscountID | String | Уникальный идентификатор скидки |
| PayType | Link | Вид оплаты |