The reward object

id string

rew_vbb1afhXu5c1e2t2bwKqR9a6

object string

The type of the object represented by JSON. The value is reward.

name string

5$ discount

created_at string, ISO 8601 date format

2016-11-16T14:14:31Z

type string

Defines the reward type:

• MATERIAL (products as rewards),
• CAMPAIGN (digital rewards like coupons, gift credits),
• COIN (pay-with-points reward)

parameters object

An object that defines how the reward is generated.

If reward type is campaign:

"parameters": {
    "campaign": {
        "id": "camp_XowjJAe1wakCYZHWBbr4dKbw"
    }
}

If reward type is coin:

"parameters": {
        "coin": {
          "exchange_ratio": 0.01,
          "points_ratio": 1
        }
      }

If reward type is material:

"parameters": {
        "product": {
          "id": "prod_ZrP5jovC31FU8a"
        }
      }

stock string

Configurable for material rewards. Defines the total number of the product that you want to share as reward in your loyalty campaigns.

 "stock": "70"

redeemed string

Defines number of already invoked (successful)) reward redemptions.

 "redeemed": "2"

attributes object

Configurable for material rewards. Defines the reward attributes:

• description
• image_url

"attributes": {
        "image_url": "",
        "description": "Free Headphones, series 265-ER352"
}