Jump to Content
Guides
Help Center
Release notes
Sign up
Guides
API Reference
Guides
Help Center
Release notes
Sign up
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
API Reference
Getting Started
Search
JUMP TO
Introduction
Introduction
Errors
Versioning
Fetching Data
Object Schemas
Voucherify API
Publications
Publication Object
List Publications
get
Create Publication
post
Create Publication
get
Qualifications
Qualification Object
Check Eligibility
post
Validations
Validation Object
Establish Validation Session
Validate Stackable Discounts
post
Validate Voucher [Deprecated]
post
Validate Promotions [Deprecated]
post
Validate Promotion Tier [Deprecated]
post
Establish Validation Session
Redemptions
Redemption Object
Rollback Redemption Object
Stackable Redemptions Object
Redeem Stackable Discounts
post
Get Redemption
get
Get Voucher's Redemptions
get
List Redemptions
get
Rollback Redemption
post
Rollback Stackable Redemptions
post
Stacking API Overview
Redeem Voucher [Deprecated]
post
Redeem Promotion [Deprecated]
post
Vouchers
Voucher Object
List Vouchers
get
Get Voucher
get
Create Voucher
post
Generate Random Code
post
Update Voucher
put
Delete Voucher
delete
Enable Voucher
post
Disable Voucher
post
Add or Remove Voucher Balance
post
List Voucher Transactions
get
Export Voucher Transactions
post
Import Vouchers
post
Import Vouchers using CSV
post
Update Vouchers in bulk
post
Update Vouchers' metadata in bulk
post
Release Validation Session
delete
Examine Qualification [Deprecated]
post
Campaigns
Campaign Object
List Campaigns
get
Get Campaign
get
Create Campaign
post
Update Campaign
put
Delete Campaign
delete
List Campaign Transactions
get
Export Campaign Transactions
post
Add Voucher to Campaign
post
Add Voucher with Specific Code to Campaign
post
Import Vouchers to Campaign
post
Import Vouchers to Campaign by CSV
post
Enable Campaign
post
Disable Campaign
post
Examine Qualification [Deprecated]
post
Promotions
Promotion Tier Object
List Promotion Tiers
get
List Promotion Tiers from Campaign
get
Add Promotion Tier to Campaign
post
Get Promotion Tier
get
Update Promotion Tier
put
Delete Promotion Tier
delete
Enable Promotion Tier
post
Disable Promotion Tier
post
List Promotion Stacks
get
List Promotion Stacks in Campaign
get
Get Promotion Stack
get
Create Promotion Stack
post
Update Promotion Stack
put
Delete Promotion Stack
delete
Templates
List Campaign Templates
get
Get Campaign Template
get
Create Campaign Template
post
Update Campaign Template
put
Delete Campaign Template
delete
Create Campaign From Template
post
Add Promotion Tier From Template
post
Rewards
Reward Object
Reward Assignment Object
List Rewards
get
Get Reward
get
Create Reward
post
Update Reward
put
Delete Reward
delete
List Reward Assignments
get
Get Reward Assignment
get
Create Reward Assignment
post
Update Reward Assignment
put
Delete Reward Assignment
delete
Loyalties
Loyalty Campaign Object
Loyalty Card Object
Loyalty Tier Object
Earning Rule Object
List Loyalty Campaigns
get
Get Loyalty Campaign
get
Create Loyalty Campaign
post
Update Loyalty Campaign
put
Delete Loyalty Campaign
delete
List Members
get
List Member Activity
get
List Member Activity
get
Get Member
get
Get Member
get
Add Member
post
Add or Remove Loyalty Card Balance
post
Add or Remove Loyalty Card Balance
post
Transfer Points
post
List Campaign Pending Points [Beta]
get
List Member Pending Points [Beta]
get
List Member Pending Points [Beta]
get
Activate Member Pending Points [Beta]
post
Adjust Member Pending Points [Beta]
post
Cancel Member Pending Points [Beta]
post
List Loyalty Campaign Transactions
get
Export Loyalty Campaign Transactions
post
List Loyalty Card Transactions
get
List Loyalty Card Transactions
get
Export Loyalty Card Transactions
post
Export Loyalty Card Transactions
post
List Loyalty Card Point Expiration
get
Export Loyalty Campaign Point Expiration
post
List Earning Rules
get
Get Earning Rule
get
Create Earning Rule
post
Update Earning Rule
put
Delete Earning Rule
delete
Enable Earning Rule
post
Disable Earning Rule
post
List Member Rewards
get
Get Reward Details
get
Redeem Reward
post
Redeem Reward
post
List Reward Assignments
get
List Reward Assignments
get
Get Reward Assignment
get
Get Reward Assignment
get
Create Reward Assignment
post
Update Reward Assignment
put
Delete Reward Assignment
delete
List Loyalty Tiers
get
Create Loyalty Tiers
post
Get Loyalty Tier
get
List Member's Loyalty Tiers
get
List Loyalty Tier Earning Rules
get
List Loyalty Tier Rewards
get
Referrals
List Referral Code Holders
get
List Referral Code Holders
get
Add Referral Code Holders
post
Add Referral Code Holders
post
Remove Referral Code Holder
delete
Remove Referral Code Holder
delete
Customers
Customer Object
Customer Activity Object
List Customers
get
Get Customer
get
List Customer Activity
get
List Customer's Segments
get
List Customer Redeemables
get
Create Customer
post
Import and Update Customers using CSV
post
Update Customer
put
Update Customers in bulk
post
Update Customers' Metadata in bulk
post
Delete Customer
delete
Delete Customer Permanently
post
List Customer Activities [Deprecated]
get
Orders
Order Object
List Orders
get
Get Order
get
Create Order
post
Update Order
put
Import Orders
post
Create Orders Export
post
Products
Product Object
SKU Object
List Products
get
Get Product
get
Create Product
post
Import Products using CSV
post
Update Product
put
Update Products in bulk
post
Update Products' Metadata in bulk
post
Delete Product
delete
List SKUs in Product
get
Get SKU
get
Create SKU
post
Import SKUs using CSV
post
Update SKU
put
Delete SKU
delete
Product Collections
Product Collection Object
List Product Collections
get
Create Product Collection
post
Get Product Collection
get
List Products in Collection
get
Delete Product Collection
delete
Validation Rules
Validation Rule Object
Validation Rule Assignment Object
List Validation Rules
get
Get Validation Rule
get
Create Validation Rules
post
Update Validation Rule
put
Delete Validation Rule
delete
List Validation Rules' Assignment(s)
get
List Validation Rule Assignments
get
Create Validation Rules Assignments
post
Delete Validation Rule Assignment
delete
Segments
Customer Segment Object
Get Segment
get
Create Segment
post
Delete Segment
delete
Events
Custom Event Object
Track Custom Event
post
Async Actions
Async Action Object
List Async Actions
get
Get Async Action
get
Exports
Export Object
List Exports
get
Get Export
get
Create Export
post
Download Export
get
Delete Export
delete
Categories
Category Object
List Categories
get
Get Category
get
Create Category
post
Update Category
put
Delete Category
delete
Metadata Schemas
Metadata Schema Object
List Metadata Schemas
get
Get Metadata Schema
get
Locations
Location Object
List Locations
get
Get Location
get
Bin
List Bin Entries
get
Delete Bin Entry
delete
Management
Create Project
post
List Projects
get
Get Project
get
Update Project
put
Delete Project
delete
Invite a New User
post
Assign User
post
List Users
get
Get User
get
Update User
put
Unassign User
delete
Create Metadata Schema
post
List Metadata Schemas
get
Get Metadata Schema
get
Update Metadata Schema
put
Delete Metadata Schema
delete
Create Custom Event Schema
post
List Custom Event Schemas
get
Get Custom Event Schema
get
Update Custom Event Schema
put
Delete Custom Event Schema
delete
Create Stacking Rules
post
List Stacking Rules
get
Get Stacking Rules
get
Update Stacking Rules
put
Delete Stacking Rules
delete
Create Webhook
post
List Webhooks
get
Get Webhook
get
Update Webhook
put
Delete Webhook
delete
Create Brand
post
List Brands
get
Get Brand
get
Update Brand
put
Delete Brand
delete
List Campaign Templates
get
Copy Campaign Template
post
OAuth
Generate OAuth 2.0 Token
post
Introspect OAuth 2.0 Token
post
Revoke OAuth 2.0 Token
post
Client-side
Create Publication (client-side)
post
Check Eligibility (client-side)
post
Validate Stackable Discounts (client-side)
post
Redeem Stackable Discounts (client-side)
post
List Promotion Tiers (client-side)
get
Track Custom Event (client-side)
post
Validate Voucher (client-side)
get
Redeem Voucher (client-side)
post
Events
Webhooks v2024-01-01
Redemption
Succeeded
post
Failed
post
Rollback succeeded
post
Rollback failed
post
Customer
Created
post
Deleted
post
Redemption succeeded
post
Redemption rollback succeeded
post
Rewarded
post
Rewarded loyalty_points
post
Reward_redemptions created
post
Reward_redemptions pending
post
Reward_redemptions completed
post
Voucher loyalty_card pending_points activated
post
Voucher loyalty_card pending_points added
post
Voucher loyalty_card pending_points canceled
post
Voucher loyalty_card pending_points updated
post
Voucher loyalty_card points_added
post
Voucher loyalty_card points_expired
post
Voucher gift balance_added
post
Segment entered
post
Segment left
post
Loyalty tier joined
post
Loyalty tier upgraded
post
Loyalty tier downgraded
post
Loyalty tier prolonged
post
Loyalty tier left
post
Holder assignment created
post
Holder assignment deleted
post
Order created
post
Order paid
post
Order updated
post
Order canceled
post
Publication succeeded
post
Custom_event
post
Publication
Succeeded
post
Voucher
Created
post
Disabled
post
Enabled
post
Updated
post
Published
post
Loyalty_card transaction created
post
Loyalty_card pending_points activated
post
Loyalty_card pending_points added
post
Loyalty_card pending_points canceled
post
Loyalty_card pending_points updated
post
Loyalty_card points_added
post
Loyalty_card points_expired
post
Gift transaction created
post
Gift balance_added
post
Deleted
post
Campaign
Created
post
Vouchers generation completed
post
Disabled
post
Enabled
post
Updated
post
Deleted
post
Promotion_tier created
post
Promotion_tier disabled
post
Promotion_tier enabled
post
Promotion_tier updated
post
Promotion_tier deleted
post
Validation Rules
Created
post
Updated
post
Assignment created
post
Assignment deleted
post
Deleted
post
Distribution
Manual_distribution_schedule
post
