All the JSON elements referenced in the Receipts API reference are expected unless otherwise indicated below or a written waiver is obtained from flexEngage. DO NOT send non-required elements that you do not use.
MAKE SURE THAT EVERYTHING THAT APPEARS ON THE PAPER RECEIPT IS SENT.
flexEngage will work with the merchant to create a suitable receipt template based on their requirements. Below is a sample email receipt that has been annotated followed by a table that identifies the JSON elements used for the annotated data. There are also expanded views of specific sections following this high level sample.
The table below identifies the Merchant (Web) Portal and OpenAPI elements used in the annotated email receipt sample (above) and the PDF receipt sample (below).
| 1 | Email Subject Line from Merchant Portal | 2 | Email Sender Name and Sender Email Address from Merchant Portal |
| 3 | Email Header from Merchant Portal | 4 | Logo from Merchant Portal |
| 5 | Survey from Merchant Portal | 6 | See "Loyalty Information" below |
| 7 | See "Item Information" below | 8 | See "Return Information" below |
| 9 | See "Order Information" below | 10 | See "Receipt Summary Information" below |
| 11 | See "Tender Information" below | 12 | See "Store Information" below |
| 13 | See "Transaction Details" below | 14 | See "Delivery Pick-up Information" below |
| 15 | See "Sold To Information" below | 16 | Barcode Graphic generated based on: barcodeType barcodeNumber |
| 17 | See "Deposit Information" below | 18 | See "Payment History" below |
| 19 | See "Terms and Conditions" below | 20 | See "Transaction Signature" below |
| 21 | additionalInfo1 additionalInfo2 additionalInfo3 additionalInfo4 additionalInfo5 | 22 | Marketing Campaign Content from Merchant Portal |
| 23 | Corporate Social Media Links from Merchant Portal | 24 | Email Footer from Merchant Portal |
| 25 | Static content provided by flexEngage |
Below is the Store Information on the email receipt.
"store": {
"id": "000",
"name": "TEST STORE",
"address": {
"typeCode": "RetailStore",
"addressLine1": "456 Retailer Avenue",
"addressLine2": "Suite 200",
"city": "Chicago",
"territory": "IL",
"postalCode": "60601",
"country": {
"value": "United States",
"code": "US"
},
"postalCodeExtension": "4321"
},
"telephone": {
"areaCode": "312",
"localNumber": "5550198"
}
}
Below are the Transaction Details on the email receipt.
| 13A | |
| 13B | |
| 13C | |
| 13D | |
Below is the Loyalty Information on the email receipt.
"loyalty": {
"number": "LY-0001234567",
"customerName": "Jane M. Smith",
"expirationDateTime": "2027-06-30T23:59:59-05:00",
"balance": 2450,
"misc": "10% Gold Member Discount Applied"
},
Rows marked “(Custom)” on the sample come from merchant-specific custom properties, not from the loyalty object.
Below the Item Information on the email receipt.
"items": [
{
"name": "Merino Wool Crewneck Sweater",
"description": "Lightweight merino blend, ribbed cuffs and hem. Machine washable.",
"classCode": "TOPS-KNT",
"sku": "MWS-4421-NVY-M",
"upc": "012345678901",
"price": 89.99,
"total": 89.99,
"priceNotation": "N",
"quantity": {
"value": 1,
"units": 1,
"unitOfMeasureCode": "Each"
},
"discounts": [
{ "amount": 9.0, "name": "Gold Member 10% Discount" }
],
"miscInfo": "Gift wrap requested",
"category": "Men's Sweaters",
"customCategory1": "Tops",
"customCategory2": "Knitwear",
"supportingDocuments": {
"warranty": {"name": "1-Year Manufacturer Warranty", "url": "https://northfieldgoods.com/warranty"}
},
"taxes": [
{ "description": "IL State Sales Tax", "percent": 0.0625, "taxableAmount": 80.99, "amount": 5.06, "taxTypeCode": "Sales" }
]
}
]
See the Request Field Reference for more on item pricing, discounts, and price notations.
Below is the Order Information on the email receipt.
| 9A | |
| 9B | |
| 9C | |
| 9D | |
| 9E | |
| 9F | |
| 9G | |
action describes what kind of order event this is — valid values include Create, Modify, Cancel,
Payment, Shipment, Pickup, Return, Notify, and Other.
Below is the Return Information on the email receipt.
| 8A | |
| 8B | |
Below is the Receipt Summary Information on the email receipt.
"grossAmount": 50.0,
"discounts": [
{ "amount": 9.0, "name": "Gold Member 10% Discount" },
{ "amount": 5.0, "name": "Spring Promotion" }
],
"netAmount": 41.0,
"taxes": [
{ "description": "IL State Sales Tax", "percent": 0.0625, "taxableAmount": 36.0, "amount": 2.25, "taxTypeCode": "Sales" }
],
"grandAmount": 43.25,
"tip": 0.0,
"serviceCharge": 0.0,
"fees": [
{ "amount": 5.0, "description": "Alteration Service" }
]
Below is the Tender Information on the email receipt.
| 11A | |
| 11B | |
| 11C | |
Below is the Deposit Information on the email receipt.
"deposit": {
"accountNumber": "DEP-ORD-20260417",
"amount": 50.0,
"balanceDue": 121.85
}
Below is the Payment History on the email receipt.
"tenderHistory": [
{
"tenderTypeCode": "CreditCard",
"dateTime": "2026-03-14T16:05:00-05:00",
"amount": 100.91,
"creditDebit": {
"first6Digits": "411111",
"last4Digits": "4242",
"typeCode": "Visa"
}
}
]
Below is the Sold To Information on the email receipt.
"soldTo": {
"address": {
"typeCode": "Home",
"addressLine1": "1842 Lakeshore Drive",
"addressLine2": "Apt 4C",
"city": "Chicago",
"territory": "IL",
"postalCode": "60614",
"country": {
"value": "United States",
"code": "US"
},
"postalCodeExtension": "2281"
},
"customerName": "Jane M. Smith",
"customerNumber": "CUST-00398271",
"telephone1": {
"areaCode": "312",
"localNumber": "5550142"
}
}
Below is the Delivery Pick-up Information on the email receipt.
"deliveryPickup": {
"address": {
"typeCode": "Home",
"addressLine1": "1842 Lakeshore Drive",
"addressLine2": "Apt 4C",
"addressLine3": null,
"city": "Chicago",
"territory": "IL",
"postalCode": "60614",
"country": {
"value": "United States",
"code": "US"
},
"postalCodeExtension": "2281"
},
"instructions": "Leave with doorman. Ring unit 4C.",
"dateTime": "2026-04-24"
}
Below is the Terms and Conditions on the email receipt.
"terms": [
{
"description": "All sales final on altered merchandise. Returns accepted within 30 days with original receipt.",
"supportingDocuments": {
"policy": {"name": "Return Policy", "url": "https://northfieldgoods.com/returns"}
}
},
{
"signature": {
"base64Image": "iVBORw0KGgoAAA…..",
"imageMimeType": "image/png",
"dateTime": "2026-04-17T14:32:40-05:00",
"text": "I agree to pay the above total amount according to the card issuer agreement."
}
}
]
Below is the Transaction Signature on the email receipt.
"signature": {
"base64Image": "iVBORw0KGgoAAAANSU…..",
"imageMimeType": "image/png",
"dateTime": "2026-04-17T14:32:55-05:00",
"text": "Signed at checkout for the total above."
}