☰ Menu · Changelog
More

Changelog

What changed in the API, newest first.

22 November 2026

  • cashier on POST /v1/transactions, POST /v1/checks/calculate and POST /v1/holds: a string or {id, name} saying who rang the check. Stored with the check and the hold, returned as cashier and used by the owner's cashier signals. It never changes cashback and is left out of the idempotency check.

17 November 2026

  • Rule "in one visit the guest either earns or redeems": a check that redeems earns no cashback, and the answers of POST /v1/checks/calculate and POST /v1/transactions carry earn_blocked: "redeemed". Without the rule there is no such field.

16 November 2026

  • Locations: the owner binds register codes and store codes to locations. Send store_id with checks, calculations and holds when register_id is missing or bound to no location; answers carry location with matched_by. See how to send the location and the register.
  • Location rules: own percent, earning off, paying with cashback forbidden or capped per location. A check or hold with cashback where it is forbidden is refused with 400 redeem_not_allowed_here, and the calculation answers redeem_blocked_reason. Product and category exceptions per location: GET /v1/catalog/location-rules.
  • Category by name: venues with the detailed rule order accept the category name as well as its code in line_items[].category. A name never creates a new category; the most specific rule wins.
  • Items on promotion: line_items[].promo: true; the owner decides whether such lines earn and whether they can be paid with cashback.
  • Discount types: discount_type on the check and on lines; the owner sets per type whether it earns and whether it can be paid with cashback, otherwise 400 discount_redeem_not_allowed.
  • Cashback as payment or as discount: in discount mode every line has redeem_allocated; the mode is in settings.redeem_accounting.
  • Offline: GET /v1/account returns timeout_seconds, offline_redeem and offline_max_hours in settings. See When the till is offline.
  • Gifts: POST /v1/checks/calculate answers gifts.pending and gifts.unlocks, POST /v1/transactions answers gifts.unlocked; mark a gift handed out with POST /v1/members/{member}/gifts/{gift_id}/give. Events gift.unlocked and gift.given.

5 November 2026

  • Every transaction and POST /v1/checks/calculate carry line_items with what each line earned: amount, cashback_earned, earn_percent, redeemable, quantity_refunded.
  • Refunds by lines: POST /v1/transactions/{external_id}/refunds takes line_items with sku and quantity; cashback follows what each line really earned.
  • Card number prefix: the owner sets it in the register rules and new cards start with it; settings.card_prefix in GET /v1/account.
  • Rules per product: the owner overrides a category on one product, for good or between dates; GET /v1/catalog/products returns them in rules.
  • Cashback can go below zero: a return or a void takes back cashback the guest already spent, cashback.balance turns negative and the next check nets the debt before anything is paid out.
  • Dashboard: birthday greetings per card language, events and birthday banners without an image (text rides on the card's artwork), stamp levels that change at the moment the stamps are collected.
  • Dashboard: automated campaigns (bought a product, stopped buying it, a schedule to a segment) with a send journal; cohorts of buyers with lifetime value; segments by products bought and by cashback balance.
  • Returns by line: POST /v1/transactions/{external_id}/returns takes the returned line_items and moves cashback by what each line earned; the same engine as a refund with lines, as its own endpoint.

24 October 2026

  • Takeaway orders: type: pickup with location, pickup_at, guest and day_number.
  • Every order has payment and history. GET /v1/orders takes ?type= and ?location=.
  • A dish with a required choice added without one is refused with needs_options before it reaches you.

9 October 2026

  • A voided or fully refunded check no longer counts as a visit or as spend, so returns do not raise a guest's cashback level.
  • Unknown paths under /v1 answer a JSON 404 endpoint_not_found instead of the website's page; GET /v1 itself describes the API.
  • Validation errors say what to send, for example that amount is a whole number in minor units.

7 October 2026

  • Venue rules for registers: redemption through holds, check numbers per register, a limit for late checks, cashback limits per check and per day, card scan required, manual adjustments. Each key can have its own values. GET /v1/account returns the rules in settings.
  • Holds: POST /v1/holds, capture with hold_id, release, automatic expiry.
  • POST /v1/checks/calculate shows what a check would do without writing anything.
  • Partial refunds: POST /v1/transactions/{external_id}/refunds.
  • Catalogue: upload products by SKU; the owner sets per category whether it earns cashback, whether it can be paid with cashback, and its own percent.
  • Members show cashback levels, next_level, held and available.
  • Every check, scan and calculation has display with ready text for the cashier and the receipt.
  • New scopes members:adjust, catalog:read, catalog:write; new events transaction.refunded, balance.adjusted.

6 October 2026

  • API v1 at /api/v1, for every program type: cashback, stamps, visit discounts, VIP levels.
  • Members: enrol with your own card number, look up by card, barcode, phone or id, history, reward redemption.
  • Card barcode format per program: QR or Code 128 with the card number, or QR with the serial.
  • Transactions with line_items, voids, cashback redemption with the program's caps.
  • Kiosks and scanners: POST /v1/scans, POST /v1/visits, the devices:write scope.
  • Menu API with your SKUs in external_id, bulk price and stop-list sync.
  • Table orders from the QR menu with statuses for the POS.
  • Webhooks with signatures and retries, Idempotency-Key, cursor pagination, key scopes.
  • The earlier POS API at /api/pos/v1 keeps working.
Questions about an integration: api@loyaltyfy.io. We answer within one business day.