Formats

To make it as easy as possible to use the receipt data all keys are always present, unless explicitly noted otherwise, but for certain keys the key’s value may be null.

You may make the following assumptions about the keys present in these objects, unless noted otherwise:

• All keys will always be present.

• All keys containing arrays may contain an empty array, but will never be null.

Receipts

Format	Description
Receipt Object	A receipt.
Item Object	A receipt item.
Item Properties Object	Additional item properties.
Tax Object	Tax is stored in the taxes property on both a receipt and receipt item. Multiple tax objects can be stored at the receipt level. Multiple tax objects can also be stored at the item level. Tax objects contain a name to separate different tax amounts.
Tax Properties Object	Additional tax properties.
Discount Object	Discount applied to the entire receipt and to individual items.
Discount Properties Object	Additional discount properties.
Return Object	An item’s return details.
Return Properties Object	Additional return properties.
Payment Object	A receipt’s payment details.
Store Object	Receipt’s store location details.
Retailer Object	Receipt’s retailer details.
Receipt Properties Object	Additional receipt properties.
Attachment Object	Receipt attachment.
Delivery Object	A receipt’s email delivery statistics.
L10N Object	A receipt’s language, time-zone, and currency information.
Feedback Object	A container for various kinds of feedback associated with this receipt.
Survey Object	Survey feedback.
Rating Object	Ratings feedback.
VAT Object	VAT is now deprecated. Use tax objects instead. VAT is applied to the entire receipt and to individual items. Each individual item in a receipt can only contain one vat entry. Receipts can hold multiple vat entries.

Identifiers

Format	Description
Identifier Object	A consumer’s identifier.
Identifier Properties Object	Additional metadata associated with a consumer’s identifier.

Loyalty

Format	Description
Loyalty Program Object	Loyalty program details.
Loyalty Identifier Object	A loyalty value associated with a consumer’s identifier.
Loyalty Identifier Event Object	An event recorded with each loyalty identifier value modification.
Loyalty Reward Object	A loyalty reward associated with a consumer’s identifier.

POS

Format	Description
POS Status Object	Till status.