BonusReward (v3)
Rewards possible for the campaigns and their state
| # | Field | Type | Description |
|---|---|---|---|
| 0 | id | int | internal bonus reward id |
| 1 | bid | int | bonus campaign id |
| 2 | name | string | campaign name |
| 3 | description | string | campaign description (marketing text) |
| 4 | start_ddate | date | reward period start date (delivery date based), empty if immediate |
| 5 | end_ddate | date | reward period end date (delivery date based), empty if open-ended |
| 6 | current_points | int | points collected by this user so far (0 if not authenticated) |
| 7 | state | double | percentage progress towards first reward (0 if not authenticated, can exceed 100%) |
| 8 | points | int | points needed to get this reward) |
| 9 | itemid | int | the item being offered if a reward is claimed. 0 means unused. |
| 10 | discount | int | The Discount id of an discount being offered if a reward is claimed. 0 means unused. |
| 11 | discount_period | int | a period that discount applies. 0 means unused (means forever). |
| 12 | redemption_status | bool | if true, this reward was already applied for, but the backend did not confirm it yet. Once its confirmed, the reward is applied and this field is reset to false. Applied rewards (e.g. discounts) can be seen in the profile section. |
| 13 | has_image | bool | true if this reward has an image (bonus_reward.image_url is set). If so, the image can be fetched via the proxy with type 'br' (e.g. br.px?bs.i= |
Used in endpoints
Other versions
- BonusReward v5 (newer)
- BonusReward v4 (newer)
- BonusReward v2
- BonusReward v1