POS / Register
Get Current Register Session
Returns the authenticated user's currently OPEN register session, or `null` if they have none. Use this on POS load to resume an in-progress shift.
Open Register Session
Opens a register session (shift) for the authenticated user, tied to a warehouse (the register's stock location). The opening float is the starting cash in the drawer.
Close Register Session
Closes a register session and performs cash reconciliation.
Ring Up Sale (Checkout)
Ring up a sale: cart lines + tender(s) become a paid, fully-fulfilled sales order plus a POS transaction.
Refund Transaction
Refund a completed POS sale in full — credit and restock the items, then either refund the original tenders (card via processor, cash at the drawer) or top up the customer's store-credit wallet.
Get Receipt
Return the printable receipt for a POS sale — assembled from the transaction, its sales order lines, and the register session.
List Transactions
Paginated POS transaction (sales) history.
Get POS Settings
Return the register's operational settings. Requires a Bearer token with `pos.operate`.
Update POS Settings
Update the register settings. Requires a Bearer token with `pos.manage`.
Get Payment Config
Return the active processor's public web-payments config that the in-browser SDK needs to render a card form. No secrets are returned.
List Square Locations
List the merchant's Square locations, for the settings location picker. Returns an empty array if Square is unreachable or not configured.
Send POS Receipt (E-Receipt)
Delivers the POS sale's e-receipt to an ad-hoc email and/or phone target and records the marketing opt-in captured at the register. Requires permission: pos.operate.