Before you start
- Receipts are built from loaded purchases, so Transaction Data must already be flowing. Receipt content directly reflects what you send there — products, prices, taxes, discounts and payment methods.
- These are server-to-server calls — see API Authentication.
How a receipt becomes available
- The POS completes a transaction.
- Your system sends the purchase to the Purchase Load API.
- The Purchase Load API processes and stores the purchase.
- A purchase-loaded event is triggered.
- The Receipts API indexes the receipt for quick lookup.
- The receipt becomes available through the retrieval endpoints.
Retrieve receipts
1
List the customer’s receipts
GET /v1/receiptsQuery the receipt list for a customer. Lists are paginated — page through until you have the range you need, and keep thereceiptId of any receipt you want to render.2
Fetch a single receipt
GET /v1/receipts/{receiptId}Retrieve the full receipt for display — as structured JSON for your own rendering, or as HTML for email delivery or a web view.3
[Optional] Get the barcode
GET /v1/receipts/{receiptId}/barcodeRetrieve a barcode representation of the receipt identifier for scanning and verification, for example at a returns desk.Failure and edge cases
Related
- Digital Receipts API reference
- Transaction Data — the purchase data that receipts are rendered from