Loyalty Identifier Event Object¶

Every operation which modifies the value of a loyalty identifier is recorded in the loyalty event log.

Each loyalty identifier event object contains at least the timestamp of the loyalty operation and the associated loyalty value. The additional fields define the context and origin of the loyalty operation.

The meaning of value is different depending on set. If set is false then the value represents a difference that was added to or subtracted from the previous value of the loyalty identifier. If set is true then the value represents the absolute value assigned to the loyalty identifier.

Name	Type	Description
`description`	string, optional	event description
`receipt_id`	string, optional	the `id` of the receipt associated with the event
`receipt_timestamp`	string, optional	the `timestamp` of the receipt associated with the event
`set`	boolean, required	indicates if the value field represents an absolute loyalty value
`timestamp`	string, required	the date and time of the event, in UTC, formatted as an ISO 8601 date
`transaction_id`	string, optional	the `transaction_id` of the receipt associated with the event
`value`	float, required	loyalty value recorded with the event