Запит на отримання коду підтвердження для списання бонусів

URI: /api/v1/promotion/write-off-bonuses/confirmation-code

Метод використовується для відправки клієнту кода підтвердження на списання бонусів.

Запит виконується методом POST у json форматі з даними.

⚠️ Запит повинен містити заголовок Accept: application/json

Параметри запиту

Ім'я	Тип	Обов'язковий	Опис
drugstore_id	string	Так	Ідентифікатор аптеки (з бази даних аптеки)
document	object	Так	Дані чека
document.number	string	Так	Внутрішній номер чека
document.date	string	Так	Дата і час формування чека
document.total	float	Так	Повна вартість товару в чеку
customer	object	Так	Дані покупця
customer.phone	string	Так	Номер телефона покупця
customer.card_number	string	Так	Номер бонусної картки покупця
bonus_to_write_off	float	Так	Кількість бонусів для списання
comments	string	Ні	Коментарі
type	string	Ні	Тип підтвердження: sms, call, null, viber, viber_bot, telegram_bot 🛈Якщо поле не передано або type = null — буде використано тип підтвердження, визначений у базових налаштуваннях. 🛈 Типи viber, viber_bot та telegram_bot доступні лише за умови попереднього підключення відповідних сервісів. 🛈 Будь-які інші поля type, окрім перелічених, не допускаються

Приклад запиту

Запит: /api/v1/promotion/write-off-bonuses/confirmation-code

{
    "drugstore_id": "969",
    "document": {
        "number": "2525256",
        "date": "2023-04-17 11:20",
        "total": 325
    },
    "customer": {
        "phone": "380997654321",
        "card_number": "969000000013"
    },
    "bonus_to_write_off": 5,
    "comments": null,
    "type": "sms"
}

Параметри відповіді

Ім'я	Тип	Опис
message	string	Результат запиту на отримання коду підтвердження для списання бонусів

Приклад успішної відповіді

Код підтвердження для списання бонусів надіслано

Відповідь: 200 OK

{
    "message": "Код підтвердження для списання бонусів надіслано"
}

Бонуси будуть списані без коду підтвердження

Відповідь: 202 Accepted

{
    "message": "Бонуси будуть списані без коду підтвердження"
}

Приклади неуспішних відповідей

Недостатньо бонусів на рахунку

Відповідь: 400 Bad Request

{
    "message": "Недостатньо бонусів на рахунку"
}