Skip to main content

Send POS Receipt (E-Receipt)

POST 
/api/pos/transactions/:posTransaction/receipt/send

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.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

The target is captured ad-hoc — it is NOT read from the customer's CRM record — so a walk-in can get an e-receipt without becoming a customer, and an attached customer can have it sent to a different address than the one on file.

Channels: email is sent synchronously (the response reflects sent/failed immediately); phone is recorded as a pending SMS delivery because no SMS provider is wired yet — the intent is stored and can be fulfilled once an SMS channel exists.

Marketing opt-in (tri-state): true opts the attached customer into email marketing, false opts them out, and omitting the field leaves their existing preference unchanged. It is only applied when a customer is attached to the sale (guest checkouts skip it).

Request body:

  • email (string, nullable) — email address to send the receipt to. Required when phone is absent.
  • phone (string, nullable, max 32) — phone number for an SMS receipt (captured as pending). Required when email is absent.
  • marketing_opt_in (boolean, nullable) — marketing consent captured at send time.

Returns one delivery record per channel used (201 Created).

Authentication: Requires Bearer token (PAT).

Request​

Responses​

Created

Response Headers
    Content-Type