Печать ваучера на чеке

Последние изменения: 10.10.2023

Метод позволяет напечатать на чеке код ваучера (qr код) и клиент, отсканировав его в приложении UDS App, сможет получить баллы за покупку. Например, клиент забыл телефон, не было времени, сотрудник не рассказал про возможность накопить и т.п., то клиент сможет накопить баллы позже по чеку с таким ваучером. Срок жизни ваучера- 3 часа.

Маркетинговая политика

Важно! Обязательным условием использования данного функционала является настройка модуля программы лояльности в настройках административной панели UDS Business (https://admin.uds.app/). Вам необходимо указать Начислять бонусные баллы в блоке настройки Способ предоставления скидки и поставить базовый статус больше 0

Параметры, которые нужно отправить при создании ваучера:

Endpoint

https://api.uds.app/partner/v2/operations/voucher

Метод

POST

Обязательные заголовки запроса (Headers)

'Accept' : 'application/json',
'Content-Type' : 'application/json',
'Authorization' : 'Basic ' + данные авторизации

Тело запроса (Body)

{
"nonce": "string",
"cashier": {
    "externalId": "string",
    "name": "string"
},
"receipt": {
    "total": 100,
    "number": "string",
    "skipLoyaltyTotal": null
}
}

где nonce - UUID ваучера, чтобы исключить повторное генерирование ваучера для одного и того же чека.

cashier.externalId и cashier.name - Идентификатор и имя кассира, производивший оплату. externalId может состоять только из цифр и латинских букв. В кассовой системе этим идентификатором может являться id или номер сотрудника.

receipt.total* - Итоговая сумма чека.

receipt.number - Номер чека.

receipt.skipLoyaltyTotal - Cумма, на которую не должен начисляться кешбэк. Если в заказе присутствуют товары, которые не должны участвовать в системе UDS (т.е. на эти товары не начисляются бонусные баллы), то нужно передать в этом поле их сумму.

Создание ваучера на проведение операции в UDS. В случае успеха вы получите информацию для печати кода и ссылки на графическое отображение QR кода ваучера на чеке.

*-обязательное поле для заполнения

Ответ на запрос создания ваучера

{
"code": "string",
"qrCodeText": "string",
"qrCode128": "string",
"qrCode256": "string",
"expiresIn": "2023-05-15T11:08:57Z",
"points": 0
}

где code - Числовой код ваучераб

qrCodeText - Текст для генерации QR - кода ваучера для дальнейшей печати

qrCode128 - Ссылка для генерирования картинки QR кода (size 128), которую можно распечатать.

qrCode256 - Ссылка для генерирования картинки QR кода (size 256), которую можно распечатать.

expiresIn - Время, когда ваучер сгорит по UTC

points - Количество баллов для начисления. Рассчитывается из настроек базового уровня бонусной программы. Если клиент с повышенным статусом отсканирует чек, то бонусы будут начислены согласно статусу клиента

Примечание:

В ответе есть два типа ссылок: qrCode256(128 или 64) - https://qr.uds.app/qrcode?text=uds://voucher/?code=12345678&s=256 по данной ссылке нужно сделать GET запрос и в ответ получить картинку QR кода для печати.qrCodeText - https://d.uds.app?link=https%3A%2F%2Fslug.uds.app%2Fc%2Fvoucher%3Fcode%3D75852816&ius=uds&ibi=com.setinbox.TheGame&ofl=https%3A%2F%2Fuds.app&isi=954809132&apn=com.setinbox.game ; из данной ссылки необходимо самостоятельно сгенерировать Qr код.

В самом QR коде должна быть ссылка только вида

https://d.uds.app?link=https%3A%2F%2Fslug.uds.app%2Fc%2Fvoucher%3Fcode%3D75852816&ius=uds&ibi=com.setinbox.TheGame&ofl=https%3A%2F%2Fuds.app&isi=954809132&apn=com.setinbox.game

При сканировании подобной ссылки клиент будет перенаправлен в приложение для применения ваучера. Если клиент не скачал приложение, то он будет направлен в магазин приложений и после регстрации автоматически будет предложено использовать ваучер для получения бонусов.

Возвращаемые ошибки

Status	Error Code	Description
400	invalidChecksum	Способ предоставления скидки не кешбэк (CHARGE_SCORES), Поля total, skipLoyaltyTotal не коррелируют с маркетинговыми настройками компании, Размер начисляемых бонусных баллов равен 0, Поле total меньше или равно skipLoyaltyTotal
401	unauthorized	Доступ запрещен, данный токен аутентификации не установлен или не имеет соответствующего разрешения. Необходимо проверить актуальность API Key и ID компании и корректность аутентификации Basic
400	badRequest	Произошла ошибка проверки достоверности формы. Например, это может быть несоответствие типов или ошибки нарушения ограничений. Возникает при передаче некорректного запроса

Пример работы:

Помогла ли вам статья?