☰ Menu · Changelog
More
Changelog
What changed in the API, newest first.
22 November 2026
cashieronPOST /v1/transactions,POST /v1/checks/calculateandPOST /v1/holds: a string or{id, name}saying who rang the check. Stored with the check and the hold, returned ascashierand 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/calculateandPOST /v1/transactionscarryearn_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_idwith checks, calculations and holds whenregister_idis missing or bound to no location; answers carrylocationwithmatched_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 answersredeem_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_typeon the check and on lines; the owner sets per type whether it earns and whether it can be paid with cashback, otherwise400 discount_redeem_not_allowed. - Cashback as payment or as discount: in discount mode every line has
redeem_allocated; the mode is insettings.redeem_accounting. - Offline:
GET /v1/accountreturnstimeout_seconds,offline_redeemandoffline_max_hoursinsettings. See When the till is offline. - Gifts:
POST /v1/checks/calculateanswersgifts.pendingandgifts.unlocks,POST /v1/transactionsanswersgifts.unlocked; mark a gift handed out withPOST /v1/members/{member}/gifts/{gift_id}/give. Eventsgift.unlockedandgift.given.
5 November 2026
- Every transaction and
POST /v1/checks/calculatecarryline_itemswith what each line earned:amount,cashback_earned,earn_percent,redeemable,quantity_refunded. - Refunds by lines:
POST /v1/transactions/{external_id}/refundstakesline_itemswith 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_prefixinGET /v1/account. - Rules per product: the owner overrides a category on one product, for good or between dates;
GET /v1/catalog/productsreturns them inrules. - Cashback can go below zero: a return or a void takes back cashback the guest already spent,
cashback.balanceturns 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}/returnstakes the returnedline_itemsand 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: pickupwithlocation,pickup_at,guestandday_number. - Every order has
paymentandhistory.GET /v1/orderstakes?type=and?location=. - A dish with a required choice added without one is refused with
needs_optionsbefore 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
/v1answer a JSON404 endpoint_not_foundinstead of the website's page;GET /v1itself describes the API. - Validation errors say what to send, for example that
amountis 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/accountreturns the rules insettings. - Holds:
POST /v1/holds, capture withhold_id, release, automatic expiry. POST /v1/checks/calculateshows 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,heldandavailable. - Every check, scan and calculation has
displaywith ready text for the cashier and the receipt. - New scopes
members:adjust,catalog:read,catalog:write; new eventstransaction.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, thedevices:writescope. - 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/v1keeps working.