> ## Documentation Index
> Fetch the complete documentation index at: https://voucherify-pz-test.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

## Reward

| Attributes                  | Description                                                                                                                                                                                                                                                         |
| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id`string`                  | Unique reward ID, assigned by Voucherify.**Example:**rew\_nIy4gHpQHle2c3pNMwuj7G6j                                                                                                                                                                                  |
| name`string`                | Reward name.                                                                                                                                                                                                                                                        |
| stock`integer`, `null`      | Configurable for **material rewards**. The number of units of the product that you want to share as a reward. Use this parameter to code a stock-taking logic.                                                                                                      |
| redeemed`integer`, `null`   | Defines the number of already invoked (successful) reward redemptions.                                                                                                                                                                                              |
| attributes`object`          | These properties are configurable for **material rewards**.Attributes	Descriptionimage\_urlstring

The HTTPS URL pointing to the .png or .jpg file.


descriptionstring	

An arbitrary string that you can attach to a material reward. |
| 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`string`                | Reward type.Available values: `CAMPAIGN`, `COIN`, `MATERIAL`                                                                                                                                                                                                        |
| parameters                  | Defines how the reward is generated.[Reward type](#reward-type)                                                                                                                                                                                                     |
| created\_at`string`         | Timestamp representing the date and time when the reward was created. The value is shown in the ISO 8601 format.**Example:**2022-08-11T14:49:22.586Z                                                                                                                |
| updated\_at`string`, `null` | Timestamp representing the date and time when the reward was updated. The value is shown in the ISO 8601 format.**Example:**2022-08-11T16:01:34.885Z                                                                                                                |
| object                      | The type of the object represented by the JSON. This object stores information about the reward.Available values: `reward`                                                                                                                                          |

## Reward type

One of:

[Digital](#digital), [Pay with Points](#pay-with-points), [Material](#material)

## Digital

| Attributes       | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| campaign`object` | Objects stores information about the campaign related to the reward.Attributes	Descriptionidstring

Unique campaign ID, assigned by Voucherify.


balanceinteger	

The number of points to be added to a loyalty card or the amount to be added to the current balance on the gift card.

For gift cards, the value is multiplied by 100 to precisely represent 2 decimal places. For example, \$100 amount is written as 10000.


typestring	

Campaign type.

Available values: DISCOUNT\_COUPONS, GIFT\_VOUCHERS, LOYALTY\_PROGRAM |

## Pay with Points

| Attributes   | Description                                                                                                                                                                                                                                                                                                                                                                                                            |
| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| coin`object` | Defines the ratio by mapping the number of loyalty points in points\_ratio to a predefined cash amount in exchange\_ratio.Attributes	Descriptionexchange\_rationumber

The cash equivalent of the points defined in the points\_ratio property.


points\_ratiointeger	

The number of loyalty points that will map to the predefined cash amount defined by the exchange\_ratio property. |

## Material

| Attributes      | Description                                                                                                                                                                                                                                                                                                                                                         |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| product`object` | Contains information about the product given as a reward.Attributes	Descriptionidstring

Unique product ID, assigned by Voucherify.

Example:

prod\_0b7d7dfb05cbe5c616


sku\_idstring, null	

Unique SKU ID, assigned by Voucherify, of the SKU given as a reward.

Example:

sku\_0b7d7dfb090be5c619 |