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 | Survey from Merchant Portal |
| 5 | Logo from Merchant Portal | 6 | See "Store Information" below |
| 7 | ReceiptHeader | 8 | See "Receipt Transaction Header" - below |
| 9 | See "Item Information" below | 13 | See "Order Information" below |
| 14 | See "Return Information" - below | 15 | See "Receipt Summary Information" below |
| 16 | See "Tender Information" below | 17 | See "Deposit Information" below |
| 18 | See "Payment History" below | 19 | See "Sold To Information" below |
| 20 | See "Delivery Pickup Information" below | 21 | See "Terms and Conditions" below |
| 22 | See "Transaction Signature' below | 23 | Corporate Social Media Links from Merchant Portal |
| 24 | additionalInfo1 additionalInfo2 additionalInfo3 additionalInfo4 additionalInfo5 | 25 | Receipt Footer from Merchant Portal |
| 26 | Barcode Graphic generated based on: barcodeType barcodeNumber | 27 | Marketing Campaign Content from Merchant Portal |
| 28 | Email Footer from Merchant Portal | 29 | Static content provided by flexEngage |
Below is the Store Information on the email receipt.
"store": {
"id": "001",
"name": "flexEngage Retail Store",
"address": {
"typeCode": null,
"addressLine1": "14 E Washington Street",
"city": "Orlando",
"territory": "FL",
"postalCode": "32584",
"country": {
"value": "US",
"code": "US"
},
"postalCodeExtension": null
},
"telephone": {
"areaCode": "407",
"localNumber": "60FLEX8"
}
}
Below the Receipt Transaction Header on the email receipt.
| 8A | |
| 8B | |
| 8C | |
| 8D | |
| 8E | |
Below the Item Information on the email receipt.
"items": [
{
"name": "LIVING ROOM SET",
"description": null,
"classCode": null,
"sku": "20170220001",
"upc": "20170220001",
"price": 2049,
"total": 1499,
"priceNotation": "T",
"quantity": {
"value": 1,
"units": 1,
"unitOfMeasureCode": "Each"
},
"discounts": [
{ "amount": -550.97, "name": "Sale" }
],
"miscInfo": "Reg: $2,049.00 Sale: $1,499.00 You Saved: $550.97\nflexEngage In-Home Delivery\n(Assembly Included)\nUsually delivers in 3 to 4 weeks",
"supportingDocuments": {
"Review 1": {"name": "Write a review", "url": "https://www.flexEngage.com/review"},
"WARRANTY1": {"name": "Warranty Information", "url": "https://www.flexEngage.com/warranty-information"}
}
}
]
See the Request Field Reference for more on item pricing, discounts, and price notations.
Below is the Order Information on the email receipt.
| 13A | |
| 13B | |
| 13C | |
| 13D | |
| 13E | |
| 13F | |
| 13G | |
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.
| 14A | |
| 14B | |
Below is the Receipt Summary Information on the email receipt.
"grossAmount": 1499,
"discounts": [
{ "amount": -1.0, "name": "Discount Name" }
],
"netAmount": 1618.99,
"taxes": [
{ "description": null, "percent": 0.06, "taxableAmount": 1499, "amount": 89.94, "taxTypeCode": "Sales" },
{ "description": "County Tax", "percent": 0.045, "taxableAmount": 1000, "amount": 45, "taxTypeCode": "Sales" }
],
"grandAmount": 1708.93,
"tip": 1.0,
"serviceCharge": 1.0,
"fees": [
{ "amount": 119.99, "description": "In-Home Delivery" },
{ "amount": 20.99, "description": "Installation Fee" }
]
Below is the Tender Information on the email receipt.
| 16A | |
| 16B | |
| 16C | |
| 16D | |
Below is the Deposit Information on the email receipt.
"deposit": {
"accountNumber": "555555",
"amount": 36.30,
"balanceDue": 40.0
}
Below is the Payment History on the email receipt.
"tenderHistory": [
{
"tenderTypeCode": "GiftCard",
"dateTime": "2016-05-13T00:00:00+05:00",
"amount": 10.00
},
{
"tenderTypeCode": "CreditDebit",
"dateTime": "2016-05-13T00:00:00+05:00",
"amount": 26.30,
"creditDebit": {
"first6Digits": "000000",
"last4Digits": "0000",
"typeCode": "Visa"
}
}
]
Below is the Sold To Information on the email receipt.
"soldTo": {
"address": {
"typeCode": null,
"addressLine1": "22 Main Street",
"city": "Orlando",
"territory": "FL",
"postalCode": "34734",
"country": {
"value": "US",
"code": "US"
},
"postalCodeExtension": null
},
"customerName": "Joe",
"customerNumber": null,
"telephone1": {
"areaCode": "321",
"localNumber": "0000000"
}
}
Below is the Delivery Pick-up Information on the email receipt.
"deliveryPickup": {
"address": {
"typeCode": null,
"addressLine1": "22 Elm Street",
"addressLine2": null,
"addressLine3": null,
"city": "New York",
"territory": "NY",
"postalCode": "10009",
"country": {
"value": "Country",
"code": "US"
},
"postalCodeExtension": null
},
"instructions": "These are the delivery pickup instructions",
"dateTime": "2016-01-06"
}
Below is the Terms and Conditions on the email receipt.
"terms": [
{
"signature": {
"base64Image": "iVBORw0KGgoAAA…..",
"imageMimeType": "image/png",
"dateTime": "2016-05-13",
"text": null
},
"description": "These are the terms you just agreed to\nI have read and agree...",
"supportingDocuments": null
}
]
Below is the Transaction Signature on the email receipt.
"signature": {
"base64Image": "iVBORw0KGgoAAAANSU…..",
"imageMimeType": "image/png",
"dateTime": "2016-05-13",
"text": "This is the transaction signature"
}