Jump to Content

Guides Help Center Sign up

Guides Recipes API Reference

Guides Help Center Sign up

Introduction

Introduction
Errors
Versioning
Fetching Data

Vouchers API

The voucher object
Create Voucherpost
Get Voucherget
Update Voucherput
Delete Voucherdelete
List Vouchersget
Enable Voucherpost
Disable Voucherpost
Add Gift Voucher Balancepost
Import Voucherspost
Import Vouchers using CSVpost
Examine Qualificationpost
Update Vouchers in bulkpost
Update Vouchers' metadata in bulkpost
[deprecated] Update Vouchers' metadata in bulkpost
[deprecated] Update Vouchers in bulkpost
Release Validation Sessiondelete

Campaigns API

The campaign object
Create Campaignpost
Get Campaignget
Update Campaignput
Delete Campaigndelete
Add Vouchers to Campaignpost
Add Voucher with certain code to Campaignpost
Import Vouchers to Campaignpost
Import Vouchers to Campaign by CSVpost
List Campaignsget
Examine Qualificationpost
Disable Campaignpost
Enable Campaignpost

Promotions API

The promotion tier object
Create Promotion Campaignpost
List Promotion Tiers from Campaignget
Add Promotion Tier to Campaignpost
Update Promotion Tierput
Delete Promotion Tierdelete
List Promotion Tiersget
List Promotion Tiers (client side)get
Enable Promotion Tierpost
Disable Promotion Tierpost
List Promotion Stacksget
Get Promotion Stackget
Create Promotion Stackpost
Update Promotion Stackput
Delete Promotion Stackdelete

Rewards API

The reward object
List Rewardsget
Create Rewardpost
Get Rewardget
Update Rewardput
Delete Rewarddelete
The reward assignment object
List Reward Assignmentsget
Create Reward Assignmentpost
Update Reward Assignmentput
Delete Reward Assignmentdelete

Distributions API

Create Publicationpost
List Publicationsget

Validations API

The Validation object
Validate Voucherpost
Validate Voucher (client-side)get
Validate Promotionspost
Validation Session
Validate Promotion Tierpost

Redemptions API

The redemption object
Redeem Voucherpost
Redeem Voucher (client-side)post
List Redemptionsget
Get Voucher's Redemptionsget
The redemption rollback object
Rollback Redemptionpost
Get Redemptionget
Redeem Promotionpost

Stackable Discounts API

API overview (Beta)
Redeemables reference
Establish Validation Session
Validate Stackable Discounts (Beta)post
Validate Stackable Discounts (client-side) (Beta)post
Redeem Stackable Discounts (Beta)post
Redeem Stackable Discounts (client-side) (Beta)post
Rollback Stackable Redemptions (Beta)post

Loyalties API

Customers API

The customer object
Create Customerpost
Get Customerget
Update Customerput
Delete Customerdelete
List Customersget
Import Customers using CSVpost
Delete Customer Permanentlypost
Update Customers Metadata in bulkpost
Update Customers in bulkpost
[deprecated] Update Customers' metadata in bulkpost
[deprecated] Update Customers in bulkpost
Update Customer's consentsput
Update Customer's consents (client)put
The customer activity object
List Customer Activitiesget

Orders API

The order object
The order item object
Create Orderpost
Get Orderget
Update Orderput
List Ordersget
Create Exportpost
Download Exportget

Products API

The product object
Create Productpost
Get Productget
Update Productput
List Productsget
Delete Productdelete
Update Products Metadata in bulkpost
Update Products in bulkpost
[deprecated] Update Products metadata in bulkpost
[deprecated] Update Products in bulkpost
The SKU object
Create SKUpost
Get SKU [deprecated]get
Get SKUget
Update SKUput
List SKUsget
Delete SKUdelete
Import Products using CSVpost
Import SKUs using CSVpost

Product Collections API

The product collections object
List Product Collectionsget
Get Product Collectionget
List Products in Collectionget
Delete Product Collectiondelete

Validation Rules API

The validation rule object
Create Validation Rulespost
List Validation Rulesget
Get Validation Rulesget
Update Validation Rulesput
Delete Validation Rulesdelete
The validation rule assignment object
Create Validation Rules Assignmentpost
Delete Validation Rules Assignmentdelete
List Validation Rule Assignmentsget

Segments API

The segment object
Create Segmentpost
Get Segmentget
Delete Segmentdelete
List Segmentsget

Events API

The event object
Track Custom Eventpost
Track Custom Event (client-side)post

Consents

Get Consentsget
Get Consents (client)get

Async Actions API

List Async Actionsget
Get Async Actionget

Exports API

The Export object
Download Exportget
Create Exportpost
List Exportsget
Get Exportget
Delete Exportdelete

Powered by

Introduction

Introduction
Errors
Versioning
Fetching Data

Vouchers API

The voucher object
Create Voucherpost
Get Voucherget
Update Voucherput
Delete Voucherdelete
List Vouchersget
Enable Voucherpost
Disable Voucherpost
Add Gift Voucher Balancepost
Import Voucherspost
Import Vouchers using CSVpost
Examine Qualificationpost
Update Vouchers in bulkpost
Update Vouchers' metadata in bulkpost
[deprecated] Update Vouchers' metadata in bulkpost
[deprecated] Update Vouchers in bulkpost
Release Validation Sessiondelete

Campaigns API

The campaign object
Create Campaignpost
Get Campaignget
Update Campaignput
Delete Campaigndelete
Add Vouchers to Campaignpost
Add Voucher with certain code to Campaignpost
Import Vouchers to Campaignpost
Import Vouchers to Campaign by CSVpost
List Campaignsget
Examine Qualificationpost
Disable Campaignpost
Enable Campaignpost

Promotions API

The promotion tier object
Create Promotion Campaignpost
List Promotion Tiers from Campaignget
Add Promotion Tier to Campaignpost
Update Promotion Tierput
Delete Promotion Tierdelete
List Promotion Tiersget
List Promotion Tiers (client side)get
Enable Promotion Tierpost
Disable Promotion Tierpost
List Promotion Stacksget
Get Promotion Stackget
Create Promotion Stackpost
Update Promotion Stackput
Delete Promotion Stackdelete

Rewards API

The reward object
List Rewardsget
Create Rewardpost
Get Rewardget
Update Rewardput
Delete Rewarddelete
The reward assignment object
List Reward Assignmentsget
Create Reward Assignmentpost
Update Reward Assignmentput
Delete Reward Assignmentdelete

Distributions API

Create Publicationpost
List Publicationsget

Validations API

The Validation object
Validate Voucherpost
Validate Voucher (client-side)get
Validate Promotionspost
Validation Session
Validate Promotion Tierpost

Redemptions API

The redemption object
Redeem Voucherpost
Redeem Voucher (client-side)post
List Redemptionsget
Get Voucher's Redemptionsget
The redemption rollback object
Rollback Redemptionpost
Get Redemptionget
Redeem Promotionpost

Stackable Discounts API

API overview (Beta)
Redeemables reference
Establish Validation Session
Validate Stackable Discounts (Beta)post
Validate Stackable Discounts (client-side) (Beta)post
Redeem Stackable Discounts (Beta)post
Redeem Stackable Discounts (client-side) (Beta)post
Rollback Stackable Redemptions (Beta)post

Loyalties API

Customers API

The customer object
Create Customerpost
Get Customerget
Update Customerput
Delete Customerdelete
List Customersget
Import Customers using CSVpost
Delete Customer Permanentlypost
Update Customers Metadata in bulkpost
Update Customers in bulkpost
[deprecated] Update Customers' metadata in bulkpost
[deprecated] Update Customers in bulkpost
Update Customer's consentsput
Update Customer's consents (client)put
The customer activity object
List Customer Activitiesget

Orders API

The order object
The order item object
Create Orderpost
Get Orderget
Update Orderput
List Ordersget
Create Exportpost
Download Exportget

Products API

The product object
Create Productpost
Get Productget
Update Productput
List Productsget
Delete Productdelete
Update Products Metadata in bulkpost
Update Products in bulkpost
[deprecated] Update Products metadata in bulkpost
[deprecated] Update Products in bulkpost
The SKU object
Create SKUpost
Get SKU [deprecated]get
Get SKUget
Update SKUput
List SKUsget
Delete SKUdelete
Import Products using CSVpost
Import SKUs using CSVpost

Product Collections API

The product collections object
List Product Collectionsget
Get Product Collectionget
List Products in Collectionget
Delete Product Collectiondelete

Validation Rules API

The validation rule object
Create Validation Rulespost
List Validation Rulesget
Get Validation Rulesget
Update Validation Rulesput
Delete Validation Rulesdelete
The validation rule assignment object
Create Validation Rules Assignmentpost
Delete Validation Rules Assignmentdelete
List Validation Rule Assignmentsget

Segments API

The segment object
Create Segmentpost
Get Segmentget
Delete Segmentdelete
List Segmentsget

Events API

The event object
Track Custom Eventpost
Track Custom Event (client-side)post

Consents

Get Consentsget
Get Consents (client)get

Async Actions API

List Async Actionsget
Get Async Actionget

Exports API

The Export object
Download Exportget
Create Exportpost
List Exportsget
Get Exportget
Delete Exportdelete

Powered by

List Exports

get https://api.voucherify.io/v1/exports

Language

Click Try It! to start a request and see the response here!