Get Receipt
Retrieve a printable receipt for an authenticated customer's order
Get Receipt
Returns a printable receipt payload for an order owned by the authenticated customer.
Receipts are available for orders that have been paid, refunded, or completed. Draft and pending orders do not have receipts yet.
Endpoint
GET /receiptAuthentication
Requires a valid JWT access token.
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9...Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
orderId | string | Yes | Order document ID |
Example Request
curl "https://edge.tiquo.app/api/client/v1/receipt?orderId=order_123" \
-H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9..."Response
{
"success": true,
"data": {
"order": {
"id": "order_123",
"orderNumber": "ORD-001234",
"status": "completed",
"paymentStatus": "paid",
"currency": "GBP",
"subtotal": 80,
"taxTotal": 16,
"discountTotal": 0,
"total": 96,
"items": [],
"createdAt": 1706576400000,
"completedAt": 1706580000000
},
"business": {
"name": "Tiquo Demo",
"brandName": "Tiquo Demo",
"logo": "https://example.com/logo.png",
"primaryColor": "#111827",
"vatNumber": "GB123456789",
"city": "London",
"country": "GB"
},
"customer": {
"id": "cust_456",
"customerNumber": "CUST-000001",
"displayName": "John Smith",
"email": "john@example.com"
}
}
}The receipt payload includes order totals and items, business receipt branding and address details, and customer details so a client can render or print the receipt without another API call.
The order object can also include taxSetting, discountName, serviceChargeAmount, tipAmount, refundAmount, refundedAt, paymentMethod, cardBrand, cardLast4, and completedAt. Each line item contains id, name, quantity, unitPrice, subtotal, tax, discount, total, type, and optional specialInstructions.
The business object can include name, logo, brandName, primaryColor, vatNumber, address fields, contact fields, sublocationName, and locationName.
Errors
| Status | Description |
|---|---|
400 | Missing orderId |
401 | Invalid or expired access token |
404 | Receipt is not available for this customer or order |
500 | Internal server error |
DOM Package
The DOM Package exposes this endpoint as getReceipt().
const receipt = await auth.getReceipt('order_123');