Receipt Properties Object

Stores additional receipt properties in a mapping. Properties do not have a set schema, though a few have a specific use or convention.

Standard properties

Some properties have a standardised format across retailers, these are:

Key	Type	Descriptions
salesperson	string	the name of the sales person who took the transaction
operator	string	the code of the salesperson
email_settings	mapping	a mapping controlling the sending of email (see Email Settings)
messaging_settings	mapping	a mapping controlling the sending of phone messages through various other channels (see Messaging Settings)

Email Settings

Key	Type	Description
send	boolean	fine grained control of automatic email sending, which will override the retailer’s default behaviour (if the default behaviour is desired then do not set this key). Set to true to send if the retailer’s default is to not send, or set to false to not send if the retailer’s default is to send
template	string	for retailers with mutiple templates, select a particular template to use for sending this email
block	boolean	block email sending completely; with this option set to true, email sending for a receipt is disabled

Messaging Settings

• Sending of phone messages requires a valid phone number. If the identifier field is set on the receipt, an attempt is made to resolve a phone number associated with it. If no phone number can be resolved, then a phone number found in receipt properties is used. Any path in receipt properties can be used to send the phone number, but first it needs to be configured for each retailer. The phone number is validated before attempting to send the message. If the phone number does not include the country code, it’s derived from the value specified for country in the Store Object.

• Currently only the send flag is supported; set it to false to disable automatic message sending through any of the channels.

Key	Type	Description
sms	mapping	settings to control sending of messages through the sms channel.
whatsapp	mapping	settings to control sending of messages through the whatsapp channel.

Example

Disabling automatic sending of an sms message:

{
  "messaging_settings": {
    "sms": {
      "send": false
    }
  }
}