Introduction

Introduction
Errors
Versioning
Fetching Data
Object Schemas

Voucherify API

Publications
Qualifications
- Qualification Object
- Check Eligibilitypost
Validations
Redemptions
Vouchers
Campaigns
Promotions
Templates
Rewards
Loyalties
Referrals
Customers
Orders
Products
Product Collections
Validation Rules
Segments
Events
- Custom Event Object
- Track Custom Eventpost
Async Actions
Exports
Categories
Metadata Schemas
Locations
Bin
- List Bin Entriesget
- Delete Bin Entrydelete
Management
OAuth
Client-side

Events

Webhooks v2024-01-01
Redemption
Customer
Publication
- Succeededpost
Voucher
Campaign
Validation Rules
Distribution
- Manual_distribution_schedulepost

Introduction

Introduction
Errors
Versioning
Fetching Data
Object Schemas

Voucherify API

Publications
Qualifications
- Qualification Object
- Check Eligibilitypost
Validations
Redemptions
Vouchers
Campaigns
Promotions
Templates
Rewards
Loyalties
Referrals
Customers
Orders
Products
Product Collections
Validation Rules
Segments
Events
- Custom Event Object
- Track Custom Eventpost
Async Actions
Exports
Categories
Metadata Schemas
Locations
Bin
- List Bin Entriesget
- Delete Bin Entrydelete
Management
OAuth
Client-side

Events

Webhooks v2024-01-01
Redemption
Customer
Publication
- Succeededpost
Voucher
Campaign
Validation Rules
Distribution
- Manual_distribution_schedulepost

Get Reward

get https://{cluster}.voucherify.io/v1/rewards/{rewardId}

Retrieve a reward by the reward ID.

Path Params

rewardId

string

required

A unique reward ID.

Responses

Response body

object

string

required

Unique reward ID, assigned by Voucherify.

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.

attributes

object

These properties are configurable for material rewards.

image_url

string

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

description

string

An arbitrary string that you can attach to a material reward.

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.

Has additional fields

type

string

required

Reward type.

CAMPAIGN COIN MATERIAL

parameters

Defines how the reward is generated.

created_at

date-time

required

Timestamp representing the date and time when the reward was created. The value is shown in the ISO 8601 format.

updated_at

date-time | null

required

Timestamp representing the date and time when the reward was updated. The value is shown in the ISO 8601 format.

object

required

Defaults to reward

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

Response body

object

code

integer

required

Error's HTTP status code.

key

string

Short string describing the kind of error which occurred.

message

string

required

A human-readable message providing a short description of the error.

details

string

A human-readable message providing more details about the error.

request_id

string

This ID is useful when troubleshooting and/or finding the root cause of an error response by our support team.

resource_id

string

Unique resource ID that can be used in another endpoint to get more details.

resource_type

string

The resource type.

error

object

Includes additional information about the error.

message

string

The message configured by the user in a validation rule.

Updated 3 days ago

List Rewards

Create Reward

Did this page help you?

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.voucherify.io/v1/rewards/rewardId \
3
     --header 'X-Voucherify-Channel: Voucherify Documentation' \
4
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 3 days ago

List Rewards

Create Reward

Did this page help you?

Introduction
Introduction
Errors
Versioning
Fetching Data
Object Schemas

Voucherify API
Publications
Create Publicationget
Create Publicationpost
List Publicationsget
Publication Object
Qualifications
Check Eligibilitypost
Qualification Object
Validations
Validate Promotion Tier [Deprecated]post
Validate Promotions [Deprecated]post
Validate Voucher [Deprecated]post
Validate Stackable Discountspost
Validation Object
Redemptions
Redeem Promotion [Deprecated]post
Redeem Voucher [Deprecated]post
Rollback Stackable Redemptionspost
Rollback Redemptionpost
List Redemptionsget
Get Voucher's Redemptionsget
Get Redemptionget
Redeem Stackable Discountspost
Stackable Redemptions Object
Rollback Redemption Object
Redemption Object
Vouchers
Examine Qualification [Deprecated]post
Release Validation Sessiondelete
Update Vouchers' metadata in bulkpost
Update Vouchers in bulkpost
Import Vouchers using CSVpost
Import Voucherspost
Export Voucher Transactionspost
List Voucher Transactionsget
Add or Remove Voucher Balancepost
Disable Voucherpost
Enable Voucherpost
Delete Voucherdelete
Update Voucherput
Generate Random Codepost
Create Voucherpost
Get Voucherget
List Vouchersget
Voucher Object
Campaigns
Examine Qualification [Deprecated]post
Disable Campaignpost
Enable Campaignpost
Import Vouchers to Campaign by CSVpost
Import Vouchers to Campaignpost
Add Voucher with Specific Code to Campaignpost
Add Voucher to Campaignpost
Export Campaign Transactionspost
List Campaign Transactionsget
Delete Campaigndelete
Update Campaignput
Create Campaignpost
Get Campaignget
List Campaignsget
Campaign Object
Promotions
Delete Promotion Stackdelete
Update Promotion Stackput
Create Promotion Stackpost
Get Promotion Stackget
List Promotion Stacks in Campaignget
List Promotion Stacksget
Disable Promotion Tierpost
Enable Promotion Tierpost
Delete Promotion Tierdelete
Update Promotion Tierput
Get Promotion Tierget
Add Promotion Tier to Campaignpost
List Promotion Tiers from Campaignget
List Promotion Tiersget
Promotion Tier Object
Templates
Add Promotion Tier From Templatepost
Create Campaign From Templatepost
Delete Campaign Templatedelete
Update Campaign Templateput
Create Campaign Templatepost
Get Campaign Templateget
List Campaign Templatesget
Rewards
Delete Reward Assignmentdelete
Update Reward Assignmentput
Create Reward Assignmentpost
Get Reward Assignmentget
List Reward Assignmentsget
Delete Rewarddelete
Update Rewardput
Create Rewardpost
Get Rewardget
List Rewardsget
Reward Assignment Object
Reward Object
Loyalties
List Loyalty Tier Rewardsget
List Loyalty Tier Earning Rulesget
List Member's Loyalty Tiersget
Get Loyalty Tierget
Create Loyalty Tierspost
List Loyalty Tiersget
Delete Reward Assignmentdelete
Update Reward Assignmentput
Create Reward Assignmentpost
Get Reward Assignmentget
Get Reward Assignmentget
List Reward Assignmentsget
List Reward Assignmentsget
Redeem Rewardpost
Redeem Rewardpost
Get Reward Detailsget
List Member Rewardsget
Disable Earning Rulepost
Enable Earning Rulepost
Delete Earning Ruledelete
Update Earning Ruleput
Create Earning Rulepost
Get Earning Ruleget
List Earning Rulesget
Export Loyalty Campaign Point Expirationpost
List Loyalty Card Point Expirationget
Export Loyalty Card Transactionspost
Export Loyalty Card Transactionspost
List Loyalty Card Transactionsget
List Loyalty Card Transactionsget
Export Loyalty Campaign Transactionspost
List Loyalty Campaign Transactionsget
Cancel Member Pending Points [Beta]post
Adjust Member Pending Points [Beta]post
Activate Member Pending Points [Beta]post
List Member Pending Points [Beta]get
List Member Pending Points [Beta]get
List Campaign Pending Points [Beta]get
Transfer Pointspost
Adjust Loyalty Card Balancepost
Adjust Loyalty Card Balancepost
Add Memberpost
Get Memberget
Get Memberget
List Member Activityget
List Member Activityget
List Membersget
Delete Loyalty Campaigndelete
Update Loyalty Campaignput
Create Loyalty Campaignpost
Get Loyalty Campaignget
List Loyalty Campaignsget
Earning Rule Object
Loyalty Tier Object
Loyalty Card Object
Loyalty Campaign Object
Referrals
Remove Referral Code Holderdelete
Remove Referral Code Holderdelete
Add Referral Code Holderspost
Add Referral Code Holderspost
List Referral Code Holdersget
List Referral Code Holdersget
Customers
List Customer Activities [Deprecated]get
Delete Customer Permanentlypost
Delete Customerdelete
Update Customers' Metadata in bulkpost
Update Customers in bulkpost
Update Customerput
Import and Update Customers using CSVpost
Create Customerpost
List Customer Redeemablesget
List Customer's Segmentsget
List Customer Activityget
Get Customerget
List Customersget
Customer Activity Object
Customer Object
Orders
Create Orders Exportpost
Import Orderspost
Update Orderput
Create Orderpost
Get Orderget
List Ordersget
Order Object
Products
Delete SKUdelete
Update SKUput
Import SKUs using CSVpost
Create SKUpost
Get SKUget
List SKUs in Productget
Delete Productdelete
Update Products' Metadata in bulkpost
Update Products in bulkpost
Update Productput
Import Products using CSVpost
Create Productpost
Get Productget
List Productsget
SKU Object
Product Object
Product Collections
Delete Product Collectiondelete
List Products in Collectionget
Get Product Collectionget
Create Product Collectionpost
List Product Collectionsget
Product Collection Object
Validation Rules
Delete Validation Rule Assignmentdelete
Create Validation Rules Assignmentspost
List Validation Rule Assignmentsget
List Validation Rules' Assignment(s)get
Delete Validation Ruledelete
Update Validation Ruleput
Create Validation Rulespost
Get Validation Ruleget
List Validation Rulesget
Validation Rule Assignment Object
Validation Rule Object
Segments
Delete Segmentdelete
Create Segmentpost
Get Segmentget
Customer Segment Object
Events
Track Custom Eventpost
Custom Event Object
Async Actions
Get Async Actionget
List Async Actionsget
Async Action Object
Exports
Delete Exportdelete
Download Exportget
Create Exportpost
Get Exportget
List Exportsget
Export Object
Categories
Delete Categorydelete
Update Categoryput
Create Categorypost
Get Categoryget
List Categoriesget
Category Object
Metadata Schemas
Get Metadata Schemaget
List Metadata Schemasget
Metadata Schema Object
Locations
Get Locationget
List Locationsget
Location Object
Bin
Delete Bin Entrydelete
List Bin Entriesget
Management
Copy Campaign Templatepost
List Campaign Templatesget
Delete Branddelete
Update Brandput
Get Brandget
List Brandsget
Create Brandpost
Delete Webhookdelete
Update Webhookput
Get Webhookget
List Webhooksget
Create Webhookpost
Delete Stacking Rulesdelete
Update Stacking Rulesput
Get Stacking Rulesget
List Stacking Rulesget
Create Stacking Rulespost
Delete Custom Event Schemadelete
Update Custom Event Schemaput
Get Custom Event Schemaget
List Custom Event Schemasget
Create Custom Event Schemapost
Delete Metadata Schemadelete
Update Metadata Schemaput
Get Metadata Schemaget
List Metadata Schemasget
Create Metadata Schemapost
Unassign Userdelete
Update Userput
Get Userget
List Usersget
Assign Userpost
Invite a New Userpost
Delete Projectdelete
Update Projectput
Get Projectget
List Projectsget
Create Projectpost
OAuth
Revoke OAuth 2.0 Tokenpost
Introspect OAuth 2.0 Tokenpost
Generate OAuth 2.0 Tokenpost
Client-side
Redeem Voucher (client-side)post
Validate Voucher (client-side)get
Track Custom Event (client-side)post
List Promotion Tiers (client-side)get
Redeem Stackable Discounts (client-side)post
Validate Stackable Discounts (client-side)post
Check Eligibility (client-side)post
Create Publication (client-side)post

Events
Webhooks v2024-01-01
Redemption
Rollback failedpost
Rollback succeededpost
Failedpost
Succeededpost
Customer
Custom_eventpost
Publication succeededpost
Order canceledpost
Order updatedpost
Order paidpost
Order createdpost
Holder assignment deletedpost
Holder assignment createdpost
Loyalty tier leftpost
Loyalty tier prolongedpost
Loyalty tier downgradedpost
Loyalty tier upgradedpost
Loyalty tier joinedpost
Segment leftpost
Segment enteredpost
Voucher gift balance_addedpost
Voucher loyalty_card points_expiredpost
Voucher loyalty_card points_addedpost
Voucher loyalty_card pending_points updatedpost
Voucher loyalty_card pending_points canceledpost
Voucher loyalty_card pending_points addedpost
Voucher loyalty_card pending_points activatedpost
Reward_redemptions completedpost
Reward_redemptions pendingpost
Reward_redemptions createdpost
Rewarded loyalty_pointspost
Rewardedpost
Redemption rollback succeededpost
Redemption succeededpost
Deletedpost
Createdpost
Publication
Succeededpost
Voucher
Deletedpost
Gift balance_addedpost
Gift transaction createdpost
Loyalty_card points_expiredpost
Loyalty_card points_addedpost
Loyalty_card pending_points updatedpost
Loyalty_card pending_points canceledpost
Loyalty_card pending_points addedpost
Loyalty_card pending_points activatedpost
Loyalty_card transaction createdpost
Publishedpost
Updatedpost
Enabledpost
Disabledpost
Createdpost
Campaign
Promotion_tier deletedpost
Promotion_tier updatedpost
Promotion_tier enabledpost
Promotion_tier disabledpost
Promotion_tier createdpost
Loyalty_tier updatedpost
Loyalty_tier deletedpost
Loyalty_tier createdpost
Deletedpost
Updatedpost
Enabledpost
Disabledpost
Vouchers generation completedpost
Createdpost
Validation Rules
Deletedpost
Assignment deletedpost
Assignment createdpost
Updatedpost
Createdpost
Distribution
Manual_distribution_schedulepost

Introduction
Introduction
Errors
Versioning
Fetching Data
Object Schemas

Voucherify API
Publications
Create Publicationget
Create Publicationpost
List Publicationsget
Publication Object
Qualifications
Check Eligibilitypost
Qualification Object
Validations
Validate Promotion Tier [Deprecated]post
Validate Promotions [Deprecated]post
Validate Voucher [Deprecated]post
Validate Stackable Discountspost
Validation Object
Redemptions
Redeem Promotion [Deprecated]post
Redeem Voucher [Deprecated]post
Rollback Stackable Redemptionspost
Rollback Redemptionpost
List Redemptionsget
Get Voucher's Redemptionsget
Get Redemptionget
Redeem Stackable Discountspost
Stackable Redemptions Object
Rollback Redemption Object
Redemption Object
Vouchers
Examine Qualification [Deprecated]post
Release Validation Sessiondelete
Update Vouchers' metadata in bulkpost
Update Vouchers in bulkpost
Import Vouchers using CSVpost
Import Voucherspost
Export Voucher Transactionspost
List Voucher Transactionsget
Add or Remove Voucher Balancepost
Disable Voucherpost
Enable Voucherpost
Delete Voucherdelete
Update Voucherput
Generate Random Codepost
Create Voucherpost
Get Voucherget
List Vouchersget
Voucher Object
Campaigns
Examine Qualification [Deprecated]post
Disable Campaignpost
Enable Campaignpost
Import Vouchers to Campaign by CSVpost
Import Vouchers to Campaignpost
Add Voucher with Specific Code to Campaignpost
Add Voucher to Campaignpost
Export Campaign Transactionspost
List Campaign Transactionsget
Delete Campaigndelete
Update Campaignput
Create Campaignpost
Get Campaignget
List Campaignsget
Campaign Object
Promotions
Delete Promotion Stackdelete
Update Promotion Stackput
Create Promotion Stackpost
Get Promotion Stackget
List Promotion Stacks in Campaignget
List Promotion Stacksget
Disable Promotion Tierpost
Enable Promotion Tierpost
Delete Promotion Tierdelete
Update Promotion Tierput
Get Promotion Tierget
Add Promotion Tier to Campaignpost
List Promotion Tiers from Campaignget
List Promotion Tiersget
Promotion Tier Object
Templates
Add Promotion Tier From Templatepost
Create Campaign From Templatepost
Delete Campaign Templatedelete
Update Campaign Templateput
Create Campaign Templatepost
Get Campaign Templateget
List Campaign Templatesget
Rewards
Delete Reward Assignmentdelete
Update Reward Assignmentput
Create Reward Assignmentpost
Get Reward Assignmentget
List Reward Assignmentsget
Delete Rewarddelete
Update Rewardput
Create Rewardpost
Get Rewardget
List Rewardsget
Reward Assignment Object
Reward Object
Loyalties
List Loyalty Tier Rewardsget
List Loyalty Tier Earning Rulesget
List Member's Loyalty Tiersget
Get Loyalty Tierget
Create Loyalty Tierspost
List Loyalty Tiersget
Delete Reward Assignmentdelete
Update Reward Assignmentput
Create Reward Assignmentpost
Get Reward Assignmentget
Get Reward Assignmentget
List Reward Assignmentsget
List Reward Assignmentsget
Redeem Rewardpost
Redeem Rewardpost
Get Reward Detailsget
List Member Rewardsget
Disable Earning Rulepost
Enable Earning Rulepost
Delete Earning Ruledelete
Update Earning Ruleput
Create Earning Rulepost
Get Earning Ruleget
List Earning Rulesget
Export Loyalty Campaign Point Expirationpost
List Loyalty Card Point Expirationget
Export Loyalty Card Transactionspost
Export Loyalty Card Transactionspost
List Loyalty Card Transactionsget
List Loyalty Card Transactionsget
Export Loyalty Campaign Transactionspost
List Loyalty Campaign Transactionsget
Cancel Member Pending Points [Beta]post
Adjust Member Pending Points [Beta]post
Activate Member Pending Points [Beta]post
List Member Pending Points [Beta]get
List Member Pending Points [Beta]get
List Campaign Pending Points [Beta]get
Transfer Pointspost
Adjust Loyalty Card Balancepost
Adjust Loyalty Card Balancepost
Add Memberpost
Get Memberget
Get Memberget
List Member Activityget
List Member Activityget
List Membersget
Delete Loyalty Campaigndelete
Update Loyalty Campaignput
Create Loyalty Campaignpost
Get Loyalty Campaignget
List Loyalty Campaignsget
Earning Rule Object
Loyalty Tier Object
Loyalty Card Object
Loyalty Campaign Object
Referrals
Remove Referral Code Holderdelete
Remove Referral Code Holderdelete
Add Referral Code Holderspost
Add Referral Code Holderspost
List Referral Code Holdersget
List Referral Code Holdersget
Customers
List Customer Activities [Deprecated]get
Delete Customer Permanentlypost
Delete Customerdelete
Update Customers' Metadata in bulkpost
Update Customers in bulkpost
Update Customerput
Import and Update Customers using CSVpost
Create Customerpost
List Customer Redeemablesget
List Customer's Segmentsget
List Customer Activityget
Get Customerget
List Customersget
Customer Activity Object
Customer Object
Orders
Create Orders Exportpost
Import Orderspost
Update Orderput
Create Orderpost
Get Orderget
List Ordersget
Order Object
Products
Delete SKUdelete
Update SKUput
Import SKUs using CSVpost
Create SKUpost
Get SKUget
List SKUs in Productget
Delete Productdelete
Update Products' Metadata in bulkpost
Update Products in bulkpost
Update Productput
Import Products using CSVpost
Create Productpost
Get Productget
List Productsget
SKU Object
Product Object
Product Collections
Delete Product Collectiondelete
List Products in Collectionget
Get Product Collectionget
Create Product Collectionpost
List Product Collectionsget
Product Collection Object
Validation Rules
Delete Validation Rule Assignmentdelete
Create Validation Rules Assignmentspost
List Validation Rule Assignmentsget
List Validation Rules' Assignment(s)get
Delete Validation Ruledelete
Update Validation Ruleput
Create Validation Rulespost
Get Validation Ruleget
List Validation Rulesget
Validation Rule Assignment Object
Validation Rule Object
Segments
Delete Segmentdelete
Create Segmentpost
Get Segmentget
Customer Segment Object
Events
Track Custom Eventpost
Custom Event Object
Async Actions
Get Async Actionget
List Async Actionsget
Async Action Object
Exports
Delete Exportdelete
Download Exportget
Create Exportpost
Get Exportget
List Exportsget
Export Object
Categories
Delete Categorydelete
Update Categoryput
Create Categorypost
Get Categoryget
List Categoriesget
Category Object
Metadata Schemas
Get Metadata Schemaget
List Metadata Schemasget
Metadata Schema Object
Locations
Get Locationget
List Locationsget
Location Object
Bin
Delete Bin Entrydelete
List Bin Entriesget
Management
Copy Campaign Templatepost
List Campaign Templatesget
Delete Branddelete
Update Brandput
Get Brandget
List Brandsget
Create Brandpost
Delete Webhookdelete
Update Webhookput
Get Webhookget
List Webhooksget
Create Webhookpost
Delete Stacking Rulesdelete
Update Stacking Rulesput
Get Stacking Rulesget
List Stacking Rulesget
Create Stacking Rulespost
Delete Custom Event Schemadelete
Update Custom Event Schemaput
Get Custom Event Schemaget
List Custom Event Schemasget
Create Custom Event Schemapost
Delete Metadata Schemadelete
Update Metadata Schemaput
Get Metadata Schemaget
List Metadata Schemasget
Create Metadata Schemapost
Unassign Userdelete
Update Userput
Get Userget
List Usersget
Assign Userpost
Invite a New Userpost
Delete Projectdelete
Update Projectput
Get Projectget
List Projectsget
Create Projectpost
OAuth
Revoke OAuth 2.0 Tokenpost
Introspect OAuth 2.0 Tokenpost
Generate OAuth 2.0 Tokenpost
Client-side
Redeem Voucher (client-side)post
Validate Voucher (client-side)get
Track Custom Event (client-side)post
List Promotion Tiers (client-side)get
Redeem Stackable Discounts (client-side)post
Validate Stackable Discounts (client-side)post
Check Eligibility (client-side)post
Create Publication (client-side)post

Events
Webhooks v2024-01-01
Redemption
Rollback failedpost
Rollback succeededpost
Failedpost
Succeededpost
Customer
Custom_eventpost
Publication succeededpost
Order canceledpost
Order updatedpost
Order paidpost
Order createdpost
Holder assignment deletedpost
Holder assignment createdpost
Loyalty tier leftpost
Loyalty tier prolongedpost
Loyalty tier downgradedpost
Loyalty tier upgradedpost
Loyalty tier joinedpost
Segment leftpost
Segment enteredpost
Voucher gift balance_addedpost
Voucher loyalty_card points_expiredpost
Voucher loyalty_card points_addedpost
Voucher loyalty_card pending_points updatedpost
Voucher loyalty_card pending_points canceledpost
Voucher loyalty_card pending_points addedpost
Voucher loyalty_card pending_points activatedpost
Reward_redemptions completedpost
Reward_redemptions pendingpost
Reward_redemptions createdpost
Rewarded loyalty_pointspost
Rewardedpost
Redemption rollback succeededpost
Redemption succeededpost
Deletedpost
Createdpost
Publication
Succeededpost
Voucher
Deletedpost
Gift balance_addedpost
Gift transaction createdpost
Loyalty_card points_expiredpost
Loyalty_card points_addedpost
Loyalty_card pending_points updatedpost
Loyalty_card pending_points canceledpost
Loyalty_card pending_points addedpost
Loyalty_card pending_points activatedpost
Loyalty_card transaction createdpost
Publishedpost
Updatedpost
Enabledpost
Disabledpost
Createdpost
Campaign
Promotion_tier deletedpost
Promotion_tier updatedpost
Promotion_tier enabledpost
Promotion_tier disabledpost
Promotion_tier createdpost
Loyalty_tier updatedpost
Loyalty_tier deletedpost
Loyalty_tier createdpost
Deletedpost
Updatedpost
Enabledpost
Disabledpost
Vouchers generation completedpost
Createdpost
Validation Rules
Deletedpost
Assignment deletedpost
Assignment createdpost
Updatedpost
Createdpost
Distribution
Manual_distribution_schedulepost

200Returns a reward object if a valid identifier was provided.

404Not Found. When requesting a reward that has been deleted or does not exist, the resource will not be returned.