☰ Menú · Calcular
Referencia de la API
Calcular un ticket
Consulta qué generaría y canjearía un ticket antes de que el cliente pague. No se escribe nada.
POST
/v1/checks/calculatePermiso: transactions:write o devices:write
Aplica las mismas reglas que POST /v1/transactions: el nivel del cliente, las reglas de categoría, el porcentaje del programa, los límites del local y las reservas. Llámalo cada vez que cambie la cesta. Otra caja podría gastar el saldo antes de que se cierre el ticket; usa una reserva cuando eso importe.
- memberstring, obligatorio
- Número de tarjeta, valor escaneado, número de serie, id de socio o teléfono.
- amountinteger, obligatorio
- El total del ticket antes del cashback, en unidades mínimas.
- redeem_amountinteger
- Cuánto quiere pagar el cliente con cashback.
- hold_iduuid
- Calcula como si esta reserva se hubiera capturado.
- discount_typestring
- El código de descuento del ticket, como en una transacción. Las líneas pueden llevar el suyo.
- line_items[].promoboolean
truecuando el artículo está en promoción. Entonces las reglas de promoción del propietario deciden si la línea acumula y si se puede pagar con cashback. Se ignora si el local no activó la regla.- register_idstring
- El código de tu caja. Si el propietario lo vinculó a un local, el cálculo sigue las reglas del local.
- store_idstring
- El código de tienda (local) de su sistema contable, hasta 64 caracteres. Se usa cuando falta
register_ido no está vinculado a ningún local. Si ambos apuntan a locales distintos, ganaregister_id. Vea cómo enviar el local y la caja. - cashierstring or object
- Se acepta como en una transacción, para que la caja envíe el mismo cuerpo. Un cálculo no guarda nada.
- line_itemsarray
- Igual que en una transacción; lo usan las reglas de categoría.
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 }'Respuesta · 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
- Lo que se canjearía de verdad.
- max_redeeminteger
- Lo máximo que puede canjear este ticket ahora.
- limited_bystring o null
- Cuando la petición pidió más:
balance,program,per_checkoper_day. - location, redeem_allowed, redeem_blocked_reason
- Solo cuando
register_idestá vinculado a un local con reglas propias: el local, si allí se puede canjear y, si no,redeem_blocked_reason: "redeem_not_allowed_here"conmax_redeem0.limited_byes entonceslocation. El local se encuentra porregister_idostore_id; el objetolocationllevastore_codeymatched_by. - discount_typeobject or null
- Solo cuando el local usa tipos de descuento y la solicitud envió uno: el tipo del ticket con
earnyredeem. Conredeem: falsela respuesta tienemax_redeem0,limited_by: "discount_type"yredeem_blocked_reason: "discount_redeem_not_allowed". - cashback_earned, earn_rate, level
- Lo que generaría el ticket y con qué nivel.
- balance_afterinteger
- El saldo después de este ticket.
- line_itemsarray
- Lo que acumularía cada línea:
amount,cashback_earned,earn_percent,redeemable. Muéstralo en el ticket o junto a la cesta. - line_items[].promoboolean
- Solo en locales con reglas de promoción: si la línea se envió como artículo en promoción.
- hold_requiredboolean
- El local solo canjea mediante reservas y no se envió
hold_id. - stamps_earned, reward_unlocked, discount_percent
- Para programas de sellos y de visitas.
- displayobject
cashier_textyreceipt_linesen el idioma del cliente.