☰ Меню · Розрахунок
Довідник API
Розрахунок чека
Дізнайтеся, що чек нарахує й спише, ще до оплати. Нічого не записується.
POST
/v1/checks/calculateПраво: transactions:write або devices:write
Застосовує ті самі правила, що й POST /v1/transactions: рівень гостя, правила категорій, частку програми, ліміти та резерви закладу. Викликайте його щоразу, коли змінюється кошик. Інша каса все ще може витратити баланс до закриття чека. Якщо це важливо, використовуйте резерв.
- memberstring, обов’язковий
- Номер картки, відскановане значення, серійний номер, id учасника або телефон.
- amountinteger, обов’язковий
- Сума чека до списання кешбеку, у дрібних одиницях.
- redeem_amountinteger
- Скільки гість хоче оплатити кешбеком.
- hold_iduuid
- Розрахувати так, ніби цей резерв уже підтверджено.
- discount_typestring
- Код знижки чека, як у транзакції. Позиції можуть мати свій.
- line_items[].promoboolean
true, якщо товар в акції. Тоді правила для акцій власника вирішують, чи нараховує рядок і чи можна оплатити його кешбеком. Ігнорується, якщо заклад не ввімкнув правило.- register_idstring
- Код вашої каси. Якщо власник прив'язав його до точки, розрахунок іде за правилами точки.
- store_idstring
- Код магазину (точки) з вашої облікової системи, до 64 символів. Використовується, якщо
register_idне передано або він не прив'язаний до жодної точки. Якщо обидва вказують на різні точки, перемагаєregister_id. Див. як передати точку і касу. - cashierstring or object
- Приймається як у транзакції, щоб каса могла надсилати одне й те саме тіло. Розрахунок нічого не зберігає.
- line_itemsarray
- Так само, як у транзакції. Використовуються правилами категорій.
curl
curl https://loyaltyfy.io/api/v1/checks/calculate \
-H "Authorization: Bearer sk_test_..." \
-H "Content-Type: application/json" \
-d '{ "member": "2000111703779", "amount": 20000, "redeem_amount": 5000 }'Відповідь · 200
{
"object": "check_calculation",
"amount": 20000,
"redeem_amount": 1250,
"max_redeem": 1250,
"limited_by": "balance",
"net_amount": 18750,
"cashback_earned": 938,
"earn_rate": 5,
"level": "Base",
"balance_after": 938,
"category_rules_applied": false,
"line_items": [
{ "sku": "1001", "name": "Espresso", "quantity": 2, "unit_price": 4000, "category": "Coffee", "amount": 8000, "earn_percent": 5, "cashback_earned": 375, "redeemable": true },
{ "sku": "2005", "name": "Cheesecake", "quantity": 1, "unit_price": 12000, "category": "Desserts", "amount": 12000, "earn_percent": 5, "cashback_earned": 563, "redeemable": true }
],
"hold_required": false,
"stamps_earned": 0,
"reward_unlocked": false,
"member": { "object": "member", ... },
"display": {
"cashier_text": "Paid with cashback: 12.50 MDL · Cashback earned: 9.38 MDL · Cashback balance: 9.38 MDL",
"receipt_lines": [
"Paid with cashback: 12.50 MDL",
"Cashback earned: 9.38 MDL",
"Cashback balance: 9.38 MDL"
]
}
}- redeem_amountinteger
- Скільки буде списано насправді.
- max_redeeminteger
- Найбільша сума, яку цей чек може списати зараз.
- limited_bystring або null
- Якщо запит просив більше:
balance,program,per_checkабоper_day. - location, redeem_allowed, redeem_blocked_reason
- Лише якщо
register_idприв'язано до точки зі своїми правилами: точка, чи можна на ній списувати і, якщо ні,redeem_blocked_reason: "redeem_not_allowed_here"таmax_redeem0.limited_byтодіlocation. Точка знаходиться заregister_idабоstore_id; в об'єктіlocationєstore_codeіmatched_by. - discount_typeobject or null
- Лише якщо заклад використовує типи знижок і запит його передав: тип чека з
earnіredeem. Приredeem: falseу відповідіmax_redeem0,limited_by: "discount_type"іredeem_blocked_reason: "discount_redeem_not_allowed". - cashback_earned, earn_rate, level
- Що нарахує чек і за яким рівнем.
- balance_afterinteger
- Баланс після цього чека.
- line_itemsarray
- Що нарахує кожна позиція:
amount,cashback_earned,earn_percent,redeemable. Показуйте на чеку або біля кошика. - line_items[].promoboolean
- Лише в закладів із правилами для акцій: чи був рядок надісланий як товар в акції.
- hold_requiredboolean
- Заклад списує лише через резерви, а
hold_idне передано. - stamps_earned, reward_unlocked, discount_percent
- Для програм зі штампами та візитами.
- displayobject
cashier_textіreceipt_linesмовою гостя.