☰ Мәзір · Есептеу
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_itemsмассив
Транзакциядағыдай. Санат ережелері үшін қолданылады.
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 өз ережелері бар нүктеге байланса: нүкте, онда кэшбэкпен төлеуге бола ма, болмаса max_redeem 0 және redeem_blocked_reason: "redeem_not_allowed_here". Онда 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_itemsмассив
Әр позиция не есептейді: amount, cashback_earned, earn_percent, redeemable. Чекте немесе себет жанында көрсетіңіз.
line_items[].promoboolean
Тек акция ережелері бар мекемелерде: жол акциядағы тауар ретінде жіберілген бе.
hold_requiredboolean
Мекеме тек резерв арқылы төлетеді, ал hold_id жіберілмеген.
stamps_earned, reward_unlocked, discount_percent
Штамп және келу бағдарламалары үшін.
displayобъект
Қонақтың тіліндегі cashier_text және receipt_lines.