Skip to main content
GET
/
v1
/
loyalties
/
{campaignId}
/
reward-assignments
/
{assignmentId}
/
reward
Get Reward Details
curl --request GET \
  --url https://{cluster}.voucherify.io/v1/loyalties/{campaignId}/reward-assignments/{assignmentId}/reward \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'
{
  "id": "rew_Dev2yQLodRV33UKPKHTUQWk1",
  "name": "Get a product",
  "type": "MATERIAL",
  "parameters": {
    "product": {
      "id": "prod_0b2ac1dab28985cb1e",
      "sku_id": null
    }
  },
  "stock": "1",
  "redeemed": "1",
  "attributes": {
    "description": "Product"
  },
  "created_at": "2022-06-13T10:43:15.929Z",
  "updated_at": "2022-08-11T15:59:30.820Z",
  "metadata": null,
  "object": "reward"
}

Authorizations

​
X-App-Id
string
header
required
​
X-App-Token
string
header
required
​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
campaignId
string
required

The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty%20Campaign.

Example:

"camp_rRsfatlwN7unSeUIJDCYedal"

​
assignmentId
string
required

Unique reward assignment ID.

Example:

"rewa_m9hEAu10KsPcLhGXiHG85aY0"

Response

200 - application/json

Returns reward details in the context of a loyalty campaign and reward assignment ID.

Response body schema for GET v1/loyalties/{campaignId}/reward-assignments/{assignmentId}/reward

​
id
string
required

Unique reward ID, assigned by Voucherify.

Example:

"rew_nIy4gHpQHle2c3pNMwuj7G6j"

​
name
string
required

Reward name.

​
stock
integer | null
required

Configurable for material rewards. The number of units of the product that you want to share as reward.

​
redeemed
integer | null
required

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

​
metadata
object
required

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
enum<string>
required

Reward type.

Available options:
CAMPAIGN,
COIN,
MATERIAL
​
created_at
string<date-time>
required

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<date-time> | null
required

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
enum<string>
default:reward
required

The type of the object represented by the JSON. This object stores information about the reward.

Available options:
reward
​
attributes
object

These properties are configurable for material rewards.

​
parameters
object

Defines how the reward is generated.

  • Digital
  • Pay with Points
  • Material
⌘I