Loyalty Reward Object

Each loyalty reward object contains information about a reward that was issued according to the rules of a given loyalty program. The meaning of the value depends on the loyalty scheme.

Name

Type

Description

id

integer, required

the identifier of this reward

identifier

string, required

consumer identifier

name

string, required

reward name

value

float, required

reward value

claimed

boolean, required

indicating if the reward has been claimed or not

timestamp

string, required

the date and time of issuing the reward, in UTC, formatted as an ISO 8601 date

receipt_timestamp

string, required

the timestamp of the receipt which triggered the reward

Notes

  • All keys will have a value except for receipt_timestamp which can be null if the reward was not triggered by a receipt.

Example

{
  "claimed": true,
  "id": 345,
  "identifier": "990000000001",
  "name": "Coupon",
  "receipt_timestamp": "2013-06-26T12:52:33+00:00",
  "timestamp": "2013-06-24T16:25:34+00:00",
  "value": 5.0
}