☰ Meniu · Calcul
Referință API

Calculul unui bon

Află ce ar acumula și ce ar folosi un bon înainte ca oaspetele să plătească. Nu se scrie nimic.

POST/v1/checks/calculate
Permisiune: transactions:write sau devices:write

Aplică aceleași reguli ca POST /v1/transactions: nivelul oaspetelui, regulile categoriilor, partea stabilită de program, limitele localului și rezervările. Apelează-l ori de câte ori se schimbă coșul. O altă casă ar putea totuși să folosească soldul înainte să se închidă bonul; folosește o rezervare când asta contează.

memberstring, obligatoriu
Numărul cardului, valoarea scanată, seria, id-ul membrului sau telefonul.
amountinteger, obligatoriu
Totalul bonului înainte de cashback, în subunități.
redeem_amountinteger
Cât vrea oaspetele să plătească cu cashback.
hold_iduuid
Calculează ca și cum această rezervare ar fi confirmată.
discount_typestring
Codul reducerii bonului, ca la tranzacție. Liniile pot avea propriul cod.
line_items[].promoboolean
true când produsul este în promoție. Atunci regulile pentru promoții ale proprietarului decid dacă linia acumulează și dacă poate fi plătită cu cashback. Ignorat dacă localul nu a pornit regula.
register_idstring
Codul casei tale. Dacă proprietarul l-a legat de o locație, calculul urmează regulile locației.
store_idstring
Codul magazinului (locației) din sistemul vostru contabil, până la 64 de caractere. Se folosește când register_id lipsește sau nu este legat de nicio locație. Când ambele indică locații diferite, câștigă register_id. Vezi cum transmiteți locația și casa.
cashierstring or object
Acceptat ca la o tranzacție, ca acea casă să trimită același corp. Un calcul nu salvează nimic.
line_itemsarray
La fel ca la o tranzacție; folosite de regulile categoriilor.
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 }'
Răspuns · 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
Cât s-ar folosi efectiv.
max_redeeminteger
Suma maximă pe care o poate folosi acum acest bon.
limited_bystring sau null
Când cererea a fost pentru mai mult: balance, program, per_check sau per_day.
location, redeem_allowed, redeem_blocked_reason
Doar când register_id este legat de o locație cu reguli proprii: locația, dacă se poate plăti cu cashback acolo și, dacă nu, redeem_blocked_reason: "redeem_not_allowed_here" cu max_redeem 0. limited_by este atunci location. Locația se găsește după register_id sau store_id; obiectul location conține store_code și matched_by.
discount_typeobject or null
Doar când localul folosește tipuri de reduceri și cererea a trimis unul: tipul bonului cu earn și redeem. Cu redeem: false răspunsul are max_redeem 0, limited_by: "discount_type" și redeem_blocked_reason: "discount_redeem_not_allowed".
cashback_earned, earn_rate, level
Ce ar acumula bonul și la ce nivel.
balance_afterinteger
Soldul după acest bon.
line_itemsarray
Ce ar acumula fiecare poziție: amount, cashback_earned, earn_percent, redeemable. Arătați-l pe bon sau lângă coș.
line_items[].promoboolean
Doar pentru localurile cu reguli pentru promoții: dacă linia a fost trimisă ca produs în promoție.
hold_requiredboolean
Localul acceptă plata doar prin rezervări și nu s-a trimis hold_id.
stamps_earned, reward_unlocked, discount_percent
Pentru programele cu ștampile și vizite.
displayobject
cashier_text și receipt_lines în limba oaspetelui.