Response body schema for GET v1/loyalties/{campaignId}/reward-assignments/{assignmentId}/reward
Name | Type | Description |
---|---|---|
id | String | Unique reward ID, assigned by Voucherify. |
name | String | Reward name. |
stock | Integer | Configurable for material rewards. The number of units of the product that you want to share as reward. |
redeemed | Integer | Defines the number of already invoked (successful) reward redemptions. |
attributes | LoyaltiesRewardAssignmentsRewardGetResponseBodyAttributes | |
metadata | Object | The metadata object stores all custom attributes assigned to the reward. A set of key/value pairs that you can attach to a reward object. It can be useful for storing additional information about the reward in a structured format. |
type | TypeEnum | Reward type. |
parameters | RewardType | |
createdAt | OffsetDateTime | Timestamp representing the date and time when the reward was created. The value is shown in the ISO 8601 format. |
updatedAt | OffsetDateTime | Timestamp representing the date and time when the reward was updated. The value is shown in the ISO 8601 format. |
_object | ObjectEnum | The type of the object represented by the JSON. This object stores information about the reward. |
Name | Value |
---|---|
CAMPAIGN | "CAMPAIGN" |
COIN | "COIN" |
MATERIAL | "MATERIAL" |
Name | Value |
---|---|
REWARD | "reward" |