☰ Μενού · Υπολογισμός
Αναφορά API

Υπολογισμός απόδειξης

Μάθετε τι θα δώσει και τι θα εξαργυρώσει μια απόδειξη πριν πληρώσει ο πελάτης. Δεν καταγράφεται τίποτα.

POST/v1/checks/calculate
Δικαίωμα: transactions:write ή devices:write

Εφαρμόζει τους ίδιους κανόνες με το POST /v1/transactions: το επίπεδο του πελάτη, τους κανόνες κατηγοριών, το ποσοστό του προγράμματος, τα όρια και τις δεσμεύσεις της επιχείρησης. Καλέστε το όσο συχνά αλλάζει το καλάθι. Ένα άλλο ταμείο μπορεί ακόμη να ξοδέψει το υπόλοιπο πριν κλείσει η απόδειξη· όταν αυτό έχει σημασία, χρησιμοποιήστε δέσμευση.

memberstring, υποχρεωτικό
Αριθμός κάρτας, τιμή σάρωσης, serial, id μέλους ή τηλέφωνο.
amountinteger, υποχρεωτικό
Το σύνολο της απόδειξης πριν από το cashback, στη μικρότερη υποδιαίρεση.
redeem_amountinteger
Πόσα θέλει να πληρώσει ο πελάτης με cashback.
hold_iduuid
Υπολογισμός σαν να είχε επιβεβαιωθεί αυτή η δέσμευση.
discount_typestring
Ο κωδικός έκπτωσης της απόδειξης, όπως σε μια συναλλαγή. Οι γραμμές μπορούν να έχουν δικό τους.
line_items[].promoboolean
true όταν το προϊόν είναι σε προσφορά. Τότε οι κανόνες προσφορών του ιδιοκτήτη αποφασίζουν αν η γραμμή δίνει cashback και αν πληρώνεται με cashback. Αγνοείται αν το κατάστημα δεν ενεργοποίησε τον κανόνα.
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_redeem 0. Τότε το limited_by είναι location. Το κατάστημα βρίσκεται με το register_id ή το store_id· το αντικείμενο location περιέχει store_code και matched_by.
discount_typeobject or null
Μόνο όταν το κατάστημα χρησιμοποιεί τύπους έκπτωσης και το αίτημα έστειλε έναν: ο τύπος της απόδειξης με earn και redeem. Με redeem: false η απάντηση έχει max_redeem 0, 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 στη γλώσσα του πελάτη.