Customer Activity Object

Customer Activity

Attributes	Description
idstring	Unique event ID, assigned by Voucherify.Example:evcus_0c150c51730c6b60b1
typestring	Event type.Available values: customer.confirmed, customer.created, customer.updated, customer.deleted, customer.referred, customer.custom_event, customer.segment.entered, customer.segment.left, customer.sms.sent, customer.sms.recovered, customer.sms.failed, customer.email.sent, customer.email.recovered, customer.email.failed, customer.activecampaign.sent, customer.activecampaign.recovered, customer.activecampaign.failed, customer.braze.sent, customer.braze.recovered, customer.braze.failed, customer.mailchimp.sent, customer.mailchimp.recovered, customer.mailchimp.failed, customer.intercom.sent, customer.intercom.recovered, customer.intercom.failed, customer.shopify.sent, customer.shopify.recovered, customer.shopify.failed, customer.klaviyo.sent, customer.klaviyo.recovered, customer.klaviyo.failed, customer.batch.sent, customer.batch.recovered, customer.batch.failed, customer.rewarded, customer.rewarded.loyalty_points, customer.voucher.gift.balance_added, customer.voucher.loyalty_card.pending_points.activated, customer.voucher.loyalty_card.pending_points.added, customer.voucher.loyalty_card.pending_points.canceled, customer.voucher.loyalty_card.pending_points.updated, customer.voucher.loyalty_card.points_activated, customer.voucher.loyalty_card.points_added, customer.voucher.loyalty_card.points_transferred, customer.voucher.loyalty_card.points_expired, customer.voucher.deleted, customer.publication.succeeded, customer.publication.failed, customer.validation.succeeded, customer.validation.failed, customer.redemption.failed, customer.redemption.succeeded, customer.redemption.rollback.failed, customer.redemption.rollback.succeeded, customer.order.canceled, customer.order.created, customer.order.fulfilled, customer.order.paid, customer.order.processing, customer.order.updated, customer.reward_redemptions.created, customer.reward_redemptions.pending, customer.reward_redemptions.completed, customer.reward_redemptions.rolledback, customer.loyalty.updated, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged, customer.loyalty.tier.expiration.changed, customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.holder.assignment.created, customer.holder.assignment.deleted
dataobject	Contains details about the event. The objects that are returned in the data attribute differ based on the context of the event type.Attributes Descriptiondata See: Customer Activity Data event_source See: Event Source
created_atstring	Timestamp representing the date and time when the customer activity occurred in ISO 8601 format.Example:2022-08-30T09:14:07.660Z
group_idstring	Unique identifier of the request that caused the event.Example:v-1f36113948e50fc4ge

Customer Activity Data

Event data object schema.

One of:

Event Customer Confirmed, Event Customer Created, Event Customer Updated, Event Customer Deleted, Event Customer Referred, Event Customer Custom Event, Event Customer Segment Entered, Event Customer Segment Left, Event Customer SMS Sent, Event Customer SMS Recovered, Event Customer SMS Failed, Event Customer Email Sent, Event Customer Email Recovered, Event Customer Email Failed, Event Customer ActiveCampaign Sent, Event Customer ActiveCampaign Recovered, Event Customer ActiveCampaign Failed, Event Customer Braze Sent, Event Customer Braze Recovered, Event Customer Braze Failed, Event Customer Mailchimp Sent, Event Customer Mailchimp Recovered, Event Customer Mailchimp Failed, Event Customer Intercom Sent, Event Customer Intercom Recovered, Event Customer Intercom Failed, Event Customer Shopify Sent, Event Customer Shopify Recovered, Event Customer Shopify Failed, Event Customer Klaviyo Sent, Event Customer Klaviyo Recovered, Event Customer Klaviyo Failed, Event Customer Batch Sent, Event Customer Batch Recovered, Event Customer Batch Failed, Event Customer Rewarded, Event Customer Rewarded Loyalty Points, Event Customer Gift Voucher Balance Added, Event Customer Loyalty Card Pending Points Activated, Event Customer Loyalty Card Pending Points Added, Event Customer Loyalty Card Pending Points Canceled, Event Customer Loyalty Card Pending Points Updated, Event Customer Loyalty Card Points Added, Event Customer Loyalty Card Points Transferred, Event Customer Loyalty Card Points Expired, Event Customer Voucher Deleted, Event Customer Publication Succeeded, Event Customer Publication Failed, Event Customer Validation Succeeded, Event Customer Validation Failed, Event Customer Redemption Succeeded, Event Customer Redemption Failed, Event Customer Redemption Rollback Succeeded, Event Customer Redemption Rollback Failed, Event Customer Order Canceled, Event Customer Order Created, Event Customer Order Fulfilled, Event Customer Order Paid, Event Customer Order Processing, Event Customer Order Updated, Event Customer Reward Redemptions Created, Event Customer Reward Redemptions Pending, Event Customer Reward Redemptions Completed, Event Customer Reward Redemptions Rolled Back, Event Customer Loyalty Updated, Event Customer Loyalty Tier Upgraded, Event Customer Loyalty Tier Downgraded, Event Customer Loyalty Tier Prolonged, Event Customer Loyalty Tier Expiration Changed, Event Customer Loyalty Tier Joined, Event Customer Loyalty Tier Left, Event Customer Holder Assignment Created, Event Customer Holder Assignment Deleted

Event Source

Attributes	Description
channelstring	Determines the channel that initiated the event.Available values: USER_PORTAL, API, CLIENT_API, INTERNAL Example:API
userobject	Determines the Voucherify user who triggered the event.Attributes Descriptionidstring Unique identifier of the user. Example: user_xyzfghSTprSTUVWXYlk6tuvXYst7FGH7
api_keyobject	Determines the API key used to initiate the event.Attributes Descriptionnamestring Channel name in the application keys. app_idstring Contains the application ID from the Voucherify API key pair. Example: 1XXXX5XX-0XXX-XXXb-X7XX-XX2XXaXXX6XX

Event Customer Confirmed

Attributes	Description
customer	See: Customer With Summary Loyalty Referrals
unconfirmed_customerobject	Attributes Descriptionidstring Example: ucust_1qa70mVfYkl11Ab0ZxDPdWNa

Event Customer Created

Attributes	Description
customer	See: Customer With Summary Loyalty Referrals

Event Customer Updated

Attributes	Description
customer	See: Customer With Summary Loyalty Referrals

Event Customer Deleted

Attributes	Description
customer	See: Customer With Summary Loyalty Referrals

Event Customer Referred

Attributes	Description
customer	See: Simple Customer
referrer	See: Simple Customer
campaign	See: Simple Campaign
voucher	See: Simple Voucher
custom_event	See: Custom Event
redemption	See: Redemption Internal

Event Customer Custom Event

Attributes	Description
event	See: Custom Event
event_schema	See: Simple Custom Event
customer	See: Simple Customer
referralobject, null	Details about the referral.Attributes Descriptionreferrer Details about the referrer. Simple Customer voucher Details about the referral code. Simple Voucher campaign Details about the referral campaign. Simple Campaign
loyaltyobject, null	Details about the loyalty activity.Attributes Descriptionvoucher Details about the loyalty code. Simple Voucher campaign Details about the loyalty campaign. Simple Campaign

Event Customer Segment Entered

Attributes	Description
customer	See: Customer With Summary Loyalty Referrals
segment	See: Simple Segment

Event Customer Segment Left

Attributes	Description
customer	See: Customer With Summary Loyalty Referrals
segment	See: Simple Segment

Event Customer SMS Sent

Event data object schema for customer.sms.sent.

Event Customer Sent

Event Customer SMS Recovered

Event data object schema for customer.sms.recovered.

Event Customer Recovered

Event Customer SMS Failed

Event data object schema for customer.sms.failed.

Event Customer Failed

Event Customer Email Sent

Event data object schema for customer.email.sent.

Event Customer Sent

Event Customer Email Recovered

Event data object schema for customer.email.recovered.

Event Customer Recovered

Event Customer Email Failed

Event data object schema for customer.email.failed.

Event Customer Failed

Event Customer ActiveCampaign Sent

Event data object schema for customer.activecampaign.sent.

Event Customer Sent

Event Customer ActiveCampaign Recovered

Event data object schema for customer.activecampaign.recovered.

Event Customer Recovered

Event Customer ActiveCampaign Failed

Event data object schema for customer.activecampaign.failed.

Event Customer Failed

Event Customer Braze Sent

Event data object schema for customer.braze.sent.

Event Customer Sent

Event Customer Braze Recovered

Event data object schema for customer.braze.recovered.

Event Customer Recovered

Event Customer Braze Failed

Event data object schema for customer.braze.failed.

Event Customer Failed

Event Customer Mailchimp Sent

Event data object schema for customer.mailchimp.sent.

Event Customer Sent

Event Customer Mailchimp Recovered

Event data object schema for customer.mailchimp.recovered.

Event Customer Recovered

Event Customer Mailchimp Failed

Event data object schema for customer.mailchimp.failed.

Event Customer Failed

Event Customer Intercom Sent

Event data object schema for customer.intercom.sent.

Event Customer Sent

Event Customer Intercom Recovered

Event data object schema for customer.intercom.recovered.

Event Customer Recovered

Event Customer Intercom Failed

Event data object schema for customer.intercom.failed.

Event Customer Failed

Event Customer Shopify Sent

Event data object schema for customer.shopify.sent.

Event Customer Sent

Event Customer Shopify Recovered

Event data object schema for customer.shopify.recovered.

Event Customer Recovered

Event Customer Shopify Failed

Event data object schema for customer.shopify.failed.

Event Customer Failed

Event Customer Klaviyo Sent

Event data object schema for customer.klaviyo.sent.

Event Customer Sent

Event Customer Klaviyo Recovered

Event data object schema for customer.klaviyo.recovered.

Event Customer Recovered

Event Customer Klaviyo Failed

Event data object schema for customer.klaviyo.failed.

Event Customer Failed

Event Customer Batch Sent

Event data object schema for customer.batch.sent.

Event Customer Sent

Event Customer Batch Recovered

Event data object schema for customer.batch.recovered.

Event Customer Recovered

Event Customer Batch Failed

Event data object schema for customer.batch.failed.

Event Customer Failed

Event Customer Rewarded

Attributes	Description
customer	See: Simple Customer
holder	See: Simple Customer
voucher	See: Simple Voucher
campaign	See: Simple Campaign
redemption	See: Redemption Internal
reward	See: Simple Redemption Reward Result
referral_tier	See: Simple Referral Tier
balanceobject, null	Balance changed by the event. The amount property details a change in a gift card. The points property details a change in a loyalty card.Attributes Descriptionamountinteger pointsinteger
custom_event	See: Custom Event
customer_eventobject, null	Attributes Descriptionsegment See: Simple Segment event_typestring Type of activity that triggered the event.

Event Customer Rewarded Loyalty Points

Attributes	Description
customer	See: Simple Customer
holder	See: Simple Customer
voucher	See: Simple Voucher
campaign	See: Simple Campaign
loyalty_tier	See: Loyalty Tier
earning_rule	See: Earning Rule
balance	See: Voucher Balance
order	All of: 1. Order Calculated No Customer Data
2.Attributes Descriptionitemsarray Array of items applied to the order. It can include up to 500 items. Array of Order Item Calculated
event	See: Simple Event

Event Customer Gift Voucher Balance Added

Attributes	Description
customer	See: Simple Customer
campaign	See: Simple Campaign
voucher	See: Simple Voucher
balance	See: Voucher Balance
transaction	All of: 1. Voucher Transaction Base
2.Attributes Descriptiondetailsobject Contains the detailed information about the transaction. Attributes Descriptionbalance See: Voucher Balance orderobject Contains information about the original order. Attributes Descriptionidstring Unique order ID. source_idstring The merchant’s order ID if it is different from the Voucherify order ID. It is really useful in case of integration between multiple systems. It can be an order ID from CRM, database or 3rd party service. eventobject Contains information about the event that triggers the point accrual. Attributes Descriptionidstring Unique event ID. typestring Type of event. earning_ruleobject Contains information about the earning rule. Attributes Descriptionidstring Unique identifier of an earning rule, assigned by Voucherify. sourceobject Contains the custom earning rule name. Attributes Descriptionbannerstring Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard. segmentobject Contains information about the segment. Attributes Descriptionidstring namestring loyalty_tierobject Contains information about the loyalty tier. Attributes Descriptionidstring Unique identifier of the loyalty tier, assigned by Voucherify. namestring User-defined name of the loyalty tier. redemptionobject Contains information about the original redemption. Attributes Descriptionidstring Unique redemption ID. rollbackobject Contains information about the redemption rollback. Attributes Descriptionidstring Unique redemption rollback ID. custom_eventobject Contains information about the custom event that triggers the point accrual. Attributes Descriptionidstring Unique event ID. typestring Type of custom event. event_schemaobject Contains information about the custom event metadata schema. Attributes Descriptionidstring Unique metadata schema ID. namestring Type of custom event. rewardobject Contains information about the pay with points reward. Attributes Descriptionidstring Unique reward ID. namestring Reward name. source_voucher Contains information on how the balance on the donor loyalty card was affected by the transaction. Simple Voucher destination_voucher Contains information on how the balance on the receiving loyalty card was affected by the transaction. Simple Voucher typestring Transaction type concerning gift card credits. Available values: CREDITS_ADDITION

Event Customer Loyalty Card Pending Points Activated

Attributes	Description
customer	See: Simple Customer
campaign	See: Simple Campaign
voucher	See: Simple Voucher
balance	See: Voucher Balance
order	See: Simple Order
transaction	See: Voucher Transaction
pending_points	See: Loyalty Pending Point Entry

Event Customer Loyalty Card Pending Points Added

Attributes	Description
customer	See: Simple Customer
campaign	See: Simple Campaign
voucher	See: Simple Voucher
voucher_pending_points_balance	See: Voucher Balance
order	See: Simple Order
pending_points	See: Loyalty Pending Point Entry

Event Customer Loyalty Card Pending Points Canceled

Attributes	Description
customer	See: Simple Customer
campaign	See: Simple Campaign
voucher	See: Simple Voucher
voucher_pending_points_balance	See: Voucher Balance
order	See: Simple Order
pending_points	See: Loyalty Pending Point Entry

Event Customer Loyalty Card Pending Points Updated

Attributes	Description
customer	See: Simple Customer
campaign	See: Simple Campaign
voucher	See: Simple Voucher
voucher_pending_points_balance	See: Voucher Balance
order	See: Simple Order
pending_points	See: Loyalty Pending Point Entry

Event Customer Loyalty Card Points Added

Attributes	Description
customer	See: Simple Customer
campaign	See: Simple Campaign
voucher	See: Simple Voucher
balance	See: Voucher Balance
transaction	All of: 1. Voucher Transaction Base
2.Attributes Descriptiondetailsobject Contains the detailed information about the transaction. Attributes Descriptionbalance See: Voucher Balance orderobject Contains information about the original order. Attributes Descriptionidstring Unique order ID. source_idstring The merchant’s order ID if it is different from the Voucherify order ID. It is really useful in case of integration between multiple systems. It can be an order ID from CRM, database or 3rd party service. eventobject Contains information about the event that triggers the point accrual. Attributes Descriptionidstring Unique event ID. typestring Type of event. earning_ruleobject Contains information about the earning rule. Attributes Descriptionidstring Unique identifier of an earning rule, assigned by Voucherify. sourceobject Contains the custom earning rule name. Attributes Descriptionbannerstring Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard. segmentobject Contains information about the segment. Attributes Descriptionidstring namestring loyalty_tierobject Contains information about the loyalty tier. Attributes Descriptionidstring Unique identifier of the loyalty tier, assigned by Voucherify. namestring User-defined name of the loyalty tier. redemptionobject Contains information about the original redemption. Attributes Descriptionidstring Unique redemption ID. rollbackobject Contains information about the redemption rollback. Attributes Descriptionidstring Unique redemption rollback ID. custom_eventobject Contains information about the custom event that triggers the point accrual. Attributes Descriptionidstring Unique event ID. typestring Type of custom event. holder_loyalty_tierobject Loyalty tier of the loyalty card holder at the moment when the transaction occurred. The loyalty tier is the tier in which the holder was before the loyalty point balance changed. Attributes Descriptionidstring Unique identifier of the loyalty tier, assigned by Voucherify. namestring User-defined name of the loyalty tier. event_schemaobject Contains information about the custom event metadata schema. Attributes Descriptionidstring Unique metadata schema ID. namestring Type of custom event. rewardobject Contains information about the pay with points reward. Attributes Descriptionidstring Unique reward ID. namestring Reward name. source_voucher Contains information on how the balance on the donor loyalty card was affected by the transaction. Simple Voucher destination_voucher Contains information on how the balance on the receiving loyalty card was affected by the transaction. Simple Voucher typestring Transaction type concerning loyalty card points. Available values: POINTS_ACCRUAL

Event Customer Loyalty Card Points Transferred

Attributes	Description
customer	See: Simple Customer
campaign	See: Simple Campaign
voucher	See: Simple Voucher
source_voucher	See: Simple Voucher
destination_voucher	See: Simple Voucher
balance	See: Voucher Balance
transaction	All of: 1. Voucher Transaction Base
2.Attributes Descriptiondetailsobject Contains the detailed information about the transaction. Attributes Descriptionbalance See: Voucher Balance orderobject Contains information about the original order. Attributes Descriptionidstring Unique order ID. source_idstring The merchant’s order ID if it is different from the Voucherify order ID. It is really useful in case of integration between multiple systems. It can be an order ID from CRM, database or 3rd party service. eventobject Contains information about the event that triggers the point accrual. Attributes Descriptionidstring Unique event ID. typestring Type of event. earning_ruleobject Contains information about the earning rule. Attributes Descriptionidstring Unique identifier of an earning rule, assigned by Voucherify. sourceobject Contains the custom earning rule name. Attributes Descriptionbannerstring Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard. segmentobject Contains information about the segment. Attributes Descriptionidstring namestring loyalty_tierobject Contains information about the loyalty tier. Attributes Descriptionidstring Unique identifier of the loyalty tier, assigned by Voucherify. namestring User-defined name of the loyalty tier. redemptionobject Contains information about the original redemption. Attributes Descriptionidstring Unique redemption ID. rollbackobject Contains information about the redemption rollback. Attributes Descriptionidstring Unique redemption rollback ID. custom_eventobject Contains information about the custom event that triggers the point accrual. Attributes Descriptionidstring Unique event ID. typestring Type of custom event. event_schemaobject Contains information about the custom event metadata schema. Attributes Descriptionidstring Unique metadata schema ID. namestring Type of custom event. holder_loyalty_tierobject Loyalty tier of the loyalty card holder at the moment when the transaction occurred. The loyalty tier is the tier in which the holder was before the loyalty point balance changed. Attributes Descriptionidstring Unique identifier of the loyalty tier, assigned by Voucherify. namestring User-defined name of the loyalty tier. rewardobject Contains information about the pay with points reward. Attributes Descriptionidstring Unique reward ID. namestring Reward name. source_voucher Contains information on how the balance on the donor loyalty card was affected by the transaction. Simple Voucher destination_voucher Contains information on how the balance on the receiving loyalty card was affected by the transaction. Simple Voucher typestring Transaction type concerning loyalty card points. Available values: POINTS_TRANSFER_IN, POINTS_TRANSFER_OUT

Event Customer Loyalty Card Points Expired

Attributes	Description
customer	See: Simple Customer
campaign	See: Simple Campaign
voucher	See: Simple Voucher
pointsinteger	The number of expired points.
bucketsarray	Array of Loyalty Point Bucket
transaction	All of: 1. Voucher Transaction Base
2.Attributes Descriptiondetailsobject Contains the detailed information about the transaction. Attributes Descriptionbalance See: Voucher Balance orderobject Contains information about the original order. Attributes Descriptionidstring Unique order ID. source_idstring The merchant’s order ID if it is different from the Voucherify order ID. It is really useful in case of integration between multiple systems. It can be an order ID from CRM, database or 3rd party service. eventobject Contains information about the event that triggers the point accrual. Attributes Descriptionidstring Unique event ID. typestring Type of event. earning_ruleobject Contains information about the earning rule. Attributes Descriptionidstring Unique identifier of an earning rule, assigned by Voucherify. sourceobject Contains the custom earning rule name. Attributes Descriptionbannerstring Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard. segmentobject Contains information about the segment. Attributes Descriptionidstring namestring loyalty_tierobject Contains information about the loyalty tier. Attributes Descriptionidstring Unique identifier of the loyalty tier, assigned by Voucherify. namestring User-defined name of the loyalty tier. redemptionobject Contains information about the original redemption. Attributes Descriptionidstring Unique redemption ID. rollbackobject Contains information about the redemption rollback. Attributes Descriptionidstring Unique redemption rollback ID. custom_eventobject Contains information about the custom event that triggers the point accrual. Attributes Descriptionidstring Unique event ID. typestring Type of custom event. event_schemaobject Contains information about the custom event metadata schema. Attributes Descriptionidstring Unique metadata schema ID. namestring Type of custom event. holder_loyalty_tierobject Loyalty tier of the loyalty card holder at the moment when the transaction occurred. The loyalty tier is the tier in which the holder was before the loyalty point balance changed. Attributes Descriptionidstring Unique identifier of the loyalty tier, assigned by Voucherify. namestring User-defined name of the loyalty tier. rewardobject Contains information about the pay with points reward. Attributes Descriptionidstring Unique reward ID. namestring Reward name. source_voucher Contains information on how the balance on the donor loyalty card was affected by the transaction. Simple Voucher destination_voucher Contains information on how the balance on the receiving loyalty card was affected by the transaction. Simple Voucher typestring Transaction type concerning loyalty card points. Available values: POINTS_EXPIRATION

Event Customer Voucher Deleted

Attributes	Description
customer	See: Simple Customer
campaign	See: Simple Campaign
voucher	See: Simple Voucher

Event Customer Publication Succeeded

Attributes	Description
customer	See: Simple Customer
campaign	See: Simple Campaign
publication	See: Valid Single Voucher

Event Customer Publication Failed

Attributes	Description
customer	See: Simple Customer
campaign	See: Simple Campaign
publication	See: Valid Single Voucher

Event Customer Validation Succeeded

Attributes	Description
customer	See: Simple Customer
validation	See: Validation Entity

Event Customer Validation Failed

Attributes	Description
customer	See: Simple Customer
validation	See: Validation Entity

Event Customer Redemption Succeeded

Event data object schema for customer.redemption.succeeded.

Event Customer Redemption

Event Customer Redemption Failed

Event data object schema for customer.redemption.failed.

Event Customer Redemption

Event Customer Redemption Rollback Succeeded

Event data object schema for customer.redemption.rollback.succeeded.

All of:

1. Event Customer Redemption

2. Attributes	Description
   redemption_rollback	See: Simple Redemption

Event Customer Redemption Rollback Failed

Event data object schema for customer.redemption.rollback.failed.

All of:

1. Event Customer Redemption

2. Attributes	Description
   redemption_rollback	See: Simple Redemption

Event Customer Order Canceled

Event data object schema for customer.order.canceled.

Event Customer Order

Event Customer Order Created

Event data object schema for customer.order.created.

Event Customer Order

Event Customer Order Fulfilled

Event data object schema for customer.order.fulfilled.

Event Customer Order

Event Customer Order Paid

Event data object schema for customer.order.paid.

Event Customer Order

Event Customer Order Processing

Event data object schema for customer.order.processing.

Event Customer Order

Event Customer Order Updated

Event data object schema for customer.order.updated.

Event Customer Order

Event Customer Reward Redemptions Created

Event data object schema for customer.reward_redemptions.created.

Event Customer Reward Redemptions

Event Customer Reward Redemptions Pending

Event data object schema for customer.reward_redemptions.pending.

Event Customer Reward Redemptions

Event Customer Reward Redemptions Completed

Event data object schema for customer.reward_redemptions.completed.

Event Customer Reward Redemptions

Event Customer Reward Redemptions Rolled Back

Event data object schema for customer.reward_redemptions.rolledback.

Event Customer Reward Redemptions

Event Customer Loyalty Updated

Attributes	Description
customer	See: Simple Customer
campaign	See: Simple Campaign
loyaltyobject
created_atstring	Example:2022-02-25T13:32:08.734Z

Event Customer Loyalty Tier Upgraded

Event data object schema for customer.loyalty.tier.upgraded.

All of:

1. Event Customer Loyalty Tier Base

2. Loyalty Tier Upgraded

   Attributes	Description
   loyalty_tier_from	See: Loyalty Tier
   loyalty_tier_to	See: Loyalty Tier
   created_atstring	Example:2022-02-25T13:32:08.734Z

Event Customer Loyalty Tier Downgraded

Event data object schema for customer.loyalty.tier.downgraded.

All of:

1. Event Customer Loyalty Tier Base

2. Loyalty Tier Downgraded

   Attributes	Description
   loyalty_tier_from	See: Loyalty Tier
   loyalty_tier_to	See: Loyalty Tier
   created_atstring	Example:2022-02-25T13:32:08.734Z

Event Customer Loyalty Tier Prolonged

Event data object schema for customer.loyalty.tier.prolonged.

All of:

1. Event Customer Loyalty Tier Base

2. Loyalty Tier Prolonged

   Attributes	Description
   loyalty_tier	See: Loyalty Tier
   created_atstring	Example:2022-02-25T13:32:08.734Z

Event Customer Loyalty Tier Expiration Changed

Event data object schema for customer.loyalty.tier.expiration.changed.

All of:

1. Event Customer Loyalty Tier Base

2. Loyalty Tier Expiration Changed

   Attributes	Description
   loyalty_tier	See: Loyalty Tier
   created_atstring	Example:2022-02-25T13:32:08.734Z
   expiration_datestring	Example:2022-02-25T13:32:08.734Z

Event Customer Loyalty Tier Joined

Event data object schema for customer.loyalty.tier.joined.

All of:

1. Event Customer Loyalty Tier Base

2. Loyalty Tier Joined

   Attributes	Description
   loyalty_tier	See: Loyalty Tier
   created_atstring	Example:2022-02-25T13:32:08.734Z

Event Customer Loyalty Tier Left

Event data object schema for customer.loyalty.tier.left.

All of:

1. Event Customer Loyalty Tier Base

2. Loyalty Tier Left

   Attributes	Description
   loyalty_tier	See: Loyalty Tier
   created_atstring	Example:2022-02-25T13:32:08.734Z

Event Customer Holder Assignment Created

Attributes	Description
holder	See: Redeemable Holder
voucher	See: Simple Voucher
campaign	See: Simple Campaign
customer	See: Simple Customer

Event Customer Holder Assignment Deleted

Attributes	Description
holder	See: Redeemable Holder
voucher	See: Simple Voucher
campaign	See: Simple Campaign
customer	See: Simple Customer

Customer With Summary Loyalty Referrals

All of:

1. Customer Response Data

   Attributes	Description
   idstring	The ID of an existing customer that will be linked to redemption in this request.
   source_idstring	A unique identifier of the customer who validates a voucher. It can be a customer ID or email from a CRM system, database, or a third-party service. If you also pass a customer ID (unique ID assigned by Voucherify), the source ID will be ignored.
   summary	Customer Summary
   loyalty	Customer Loyalty
   referrals	Customer Referrals
   system_metadataobject	Object used to store system metadata information.
   created_atstring	Timestamp representing the date and time when the customer was created. The value is shown in the ISO 8601 format.Example:2022-08-30T06:32:07.380Z
   updated_atstring	Timestamp representing the date and time when the customer was updated. The value is shown in the ISO 8601 format.Example:2022-08-31T06:32:07.380Z
   assetsobject	Contains information about the customer’s cockpit.Attributes Descriptioncockpit_urlstring Customer’s cockpit URL address.
   objectstring	The type of the object represented by JSON.Available values: customer

2. Customer Base

Simple Customer

Attributes	Description
idstring	Unique identifier of an existing customer. It is assigned by Voucherify.
namestring	Customer’s first and last name.
emailstring	Customer’s email address.
source_idstring	A unique identifier of the customer. It can be a customer ID or email from a CRM system, database, or a third-party service.
metadataobject	A set of custom key/value pairs that are attached to the customer. It stores all custom attributes assigned to the customer.
objectstring	The type of the object represented by JSON.Available values: customer

Simple Campaign

Attributes	Description
idstring	Campaign ID.
namestring	Campaign name.
campaign_typestring	Type of campaign.
typestring	Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of generic (standalone) voucherss.- AUTO_UPDATE: the campaign is dynamic, i.e. vouchers will generate based on set criteria

• STATIC: vouchers need to be manually published
• STANDALONE: campaign for single vouchersAvailable values: AUTO_UPDATE, STATIC, STANDALONE | | is_referral_codeboolean | Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM. | | voucher | See: Simple Campaign Voucher | | referral_program | See: Referral Program | | auto_joinboolean | Indicates whether customers will be able to auto-join the campaign if any earning rule is fulfilled. | | join_onceboolean | If this value is set to true, customers will be able to join the campaign only once. It is always false for generic (standalone) vouchers campaigns and it cannot be changed in them. It is always true for loyalty campaigns and it cannot be changed in them. | | activeboolean | Indicates whether the campaign is active. | | category_idstring, null | The unique category ID that this campaign belongs to. | | categorystring | Unique category name. | | categoriesarray | Contains details about the category.Array of Category | | metadataobject | A set of custom key/value pairs that you can attach to a campaign. The metadata object stores all custom attributes assigned to the campaign. | | start_datestring | Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date.Example:2022-09-20T00:00:00.000Z | | expiration_datestring | Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date.Example:2022-09-30T00:00:00.000Z | | descriptionstring | An optional field to keep extra textual information about the campaign such as a campaign description and details. | | created_atstring | Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format.Example:2024-01-01T11:11:11.111Z | | updated_atstring | Timestamp representing the date and time when the campaign was updated in the ISO 8601 format.Example:2024-01-01T11:11:11.111Z | | objectstring | The type of the object represented by JSON. This object stores information about the campaign.Available values: campaign |

Simple Voucher

Attributes	Description
idstring	A unique identifier that represents the voucher assigned by Voucherify.
codestring	Voucher code.
gift	Gift object response.Gift
discount	See: Discount
loyalty_cardobject	Defines the loyalty card details.Simple Loyalty Card
typestring	Type of the voucher.Available values: DISCOUNT_VOUCHER, LOYALTY_CARD, GIFT_VOUCHER
campaignstring	Campaign name.
campaign_idstring	Campaign unique ID.
is_referral_codeboolean	Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.
holder_idstring	Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify.Example:cust_eWgXlBBiY6THFRJwX45Iakv4
referrer_idstring	Unique identifier of the referrer assigned by Voucherify.Example:cust_nM4jqPiaXUvQdVSA6vTRUnix
category_idstring, null	Unique identifier of the category that this voucher belongs to.Example:cat_0b6152ce12414820dc
categoriesarray	Contains details about the category.Array of Category
activeboolean	Shows whether the voucher is on or off. true indicates an active voucher and false indicates an inactive voucher.
created_atstring	Timestamp representing the date and time when the order was created in the ISO 8601 format.Example:2021-12-22T10:13:06.487Z
updated_atstring	Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.Example:2024-01-01T11:11:11.111Z
redemptionobject	Defines the redemption limits on vouchers.Attributes Descriptionquantityinteger, null How many times a voucher can be redeemed. A null value means unlimited. redeemed_quantityinteger How many times a voucher has already been redeemed. Example: 1 redeemed_pointsinteger Total loyalty points redeemed.
start_datestring	Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date.Example:2021-12-01T00:00:00.000Z
expiration_datestring	Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date.Example:2021-12-31T00:00:00.000Z
metadataobject	A set of custom key/value pairs that you can attach to a voucher. The metadata object stores all custom attributes assigned to the voucher.
objectstring	The type of the object represented by JSON.Available values: voucher

Custom Event

Attributes	Description
idstring	Unique custom event ID.
objectstring	The object represented is an event.Available values: event
typestring	The event name.
customer	A simple customer objectCustomer Object Required Object Type
referralobject	Referral object.Attributes Descriptionreferrer_idstring Unique referrer ID. Example: cust_nM4jqPiaXUvQdVSA6vTRUnix codestring Voucher code. idstring Unique voucher ID.
loyaltyobject	Loyalty object.Attributes Descriptioncodestring Loyalty card code.
metadataobject	A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer object.
created_atstring	Timestamp representing the date and time when the custom event was created. The value is shown in the ISO 8601 format.Example:2021-12-22T10:13:06.487Z

Redemption Internal

Attributes	Description
idstring	Unique redemption ID.Example:r_0bc92f81a6801f9bca
objectstring	The type of the object represented by the JSON. This object stores information about the redemption.
created_atstring	Timestamp representing the date and time when the redemption was created. The value is shown in the ISO 8601 format.Example:2021-12-22T10:13:06.487Z
tracking_idstring	Hashed customer source ID.
metadataobject	The metadata object stores all custom attributes assigned to the redemption.
channel_typestring	The source of the channel for the redemption rollback. A USER corresponds to the Voucherify Dashboard and an API corresponds to the API.Available values: USER, API
channel_idstring	Unique channel ID of the user performing the redemption. This is either a user ID from a user using the Voucherify Dashboard or an X-APP-Id of a user using the API.Example:user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH
failure_codestring	If the result is FAILURE, this parameter will provide a generic reason as to why the redemption failed.Example:customer_rules_violated
failure_messagestring	If the result is FAILURE, this parameter will provide a more expanded reason as to why the redemption failed.
order	All of: 1. Order Calculated No Customer Data
2.Attributes Descriptionitemsarray Array of items applied to the order. It can include up to 500 items. Array of Order Item Calculated
previous_order	All of: 1. Order Calculated No Customer Data
2.Attributes Descriptionitemsarray Array of items applied to the order. It can include up to 500 items. Array of Order Item Calculated
reward	See: Redemption Reward Result
amountinteger	For gift cards, this is a positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the number of redeemed credits.For loyalty cards, this is the number of loyalty points used in the transaction.Example:10000
reasonstring	System generated cause for the redemption being invalid in the context of the provided parameters.
resultstring	Redemption result.Available values: SUCCESS, FAILURE
statusstring	Redemption status.Available values: SUCCEEDED, FAILED
related_redemptionsobject	Attributes Descriptionrollbacksarray Array of: Redemption Internal Related Redemptions Rollbacks Item Attributes Descriptionidstring Unique rollback redemption ID. Example: rr_0bc92f81a6801f9bca datestring Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. Example: 2021-12-22T10:13:06.487Z redemptionsarray Array of: Redemption Internal Related Redemptions Item Attributes Descriptionidstring Unique redemption ID. Example: r_0bc92f81a6801f9bca datestring Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format. Example: 2021-12-22T10:13:06.487Z
parent_redemption_idstring	Unique redemption ID of the parent redemption.Example:r_0c656311b5878a2031
redemptionstring	Unique redemption ID of the parent redemption.Example:r_0c656311b5878a2031
customer	See: Simple Customer
customer_idstring, null	Unique customer ID of the redeeming customer.Example:cust_i8t5Tt6eiKG5K79KQlJ0Vs64
related_object_typestring	Defines the related object.Available values: voucher, promotion_tier
related_object_idstring	Unique related object ID assigned by Voucherify, i.e. v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno for a voucher.
related_object_parent_idstring	Unique related parent object ID assigned by Voucherify, i.e. v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno for a voucher.
campaign_namestring	Campaign name
voucher	Defines the details of the voucher being redeemed.All of: 1. Voucher
2. Voucher Holder
promotion_tier	Contains details of the promotion tier and the parent campaign.Promotion Tier

Simple Custom Event

Attributes	Description
idstring	Unique identifier of the custom event.
namestring	Name of the custom event.

Simple Segment

Attributes	Description
idstring	Unique segment ID.Example:seg_DNAOhUtJffvX0f57ajLMFBYR
namestring	Segment name.
objectstring	The type of the object represented by the ID.Available values: segment

Event Customer Sent

Attributes	Description
customer	See: Simple Customer
distributionobject
sent_atstring	Timestamp representing the date and time when the distribution was sent in ISO 8601 format.Example:2021-12-22T10:13:06.487Z

Event Customer Recovered

Attributes	Description
customer	See: Simple Customer
distributionobject
recovered_atstring	Timestamp representing the date and time when the distribution was recovered in ISO 8601 format.Example:2021-12-22T10:13:06.487Z

Event Customer Failed

Attributes	Description
customer	See: Simple Customer
distributionobject
failed_atstring	Timestamp representing the date and time when the distribution failed in ISO 8601 format.Example:2021-12-22T10:13:06.487Z

Simple Redemption Reward Result

Attributes	Description
customer	See: Simple Customer
assignment_idstring	Unique reward assignment ID assigned by Voucherify.
voucher	Simple Voucher
product	Simple Product
sku	Simple Sku
loyalty_tier_idstring	Unique loyalty tier ID assigned by Voucherify.
idstring	Unique reward ID, assigned by Voucherify.Example:rew_nIy4gHpQHle2c3pNMwuj7G6j
objectstring	The type of the object represented by the JSON. This object stores information about the reward.Available values: reward
namestring	Reward name.
created_atstring	Timestamp representing the date and time when the reward was created. The value is shown in the ISO 8601 format.Example:2024-01-01T11:11:11.111Z
updated_atstring, null	Timestamp representing the date and time when the reward was updated. The value is shown in the ISO 8601 format.Example:2024-01-01T11:11:11.111Z
parametersobject	Defines how the reward is generated.Reward type
metadataobject	A set of custom key/value pairs that you can attach to a reward. The metadata object stores all custom attributes assigned to the reward.
typestring	Reward type.Available values: CAMPAIGN, COIN, MATERIAL

Simple Referral Tier

Attributes	Description
idstring	Unique referral tier ID.Example:seg_DNAOhUtJffvX0f57ajLMFBYR
campaign_idstring	Campaign Id.
bannerstring	Text to be displayed to your customers on your website.
parametersobject	Referral tier parameters

Loyalty Tier

All of:

1. Loyalty Tier Base

2. Attributes	Description
   idstring	Unique loyalty tier ID.
   campaign_idstring	Unique parent campaign ID.
   metadataobject, null	The metadata object stores all custom attributes assigned to the loyalty tier. A set of key/value pairs that you can attach to a loyalty tier object. It can be useful for storing additional information about the loyalty tier in a structured format.
   created_atstring	Timestamp representing the date and time when the loyalty tier was created. The value is shown in the ISO 8601 format.
   updated_atstring, null	Timestamp representing the date and time when the loyalty tier was updated. The value is shown in the ISO 8601 format.
   configobject	Defines loyalty tier range in points.Attributes Descriptionpointsobject Defines range of loyalty tier in points. Attributes Descriptionfrominteger Bottom points threshold value. tointeger Top points threshold value.
   expiration	See: Loyalty Tier Expiration
   objectstring	The type of the object represented by JSON. This object stores information about the loyalty.Available values: loyalty_tier

Earning Rule

All of:

1. EarningRuleBase

2. Attributes	Description
   validation_rule_idstring, null	A unique validation rule identifier assigned by the Voucherify API. The validation rule is verified before points are added to the balance.
   updated_atstring, null	Timestamp representing the date and time when the earning rule was last updated in ISO 8601 format.
   activeboolean	A flag to toggle the earning rule on or off. You can disable an earning rule even though it’s within the active period defined by the start_date and expiration_date of the campaign or the earning rule’s own start_date and expiration_date.- true indicates an active earning rule

   • false indicates an inactive earning rule |

Voucher Balance

Attributes	Description
typestring	The type of voucher whose balance is being adjusted due to the transaction.Available values: loyalty_card, gift_voucher
totalinteger	The number of all points or credits accumulated on the card as affected by add or subtract operations.
objectstring	The type of the object represented by the JSON.Available values: balance
pointsinteger	Points added or subtracted in the transaction of a loyalty card.
balanceinteger	The available points or credits on the card after the transaction as affected by redemption or rollback.
operation_typestring	The type of the operation being performed. The operation type is AUTOMATIC if it is an automatic redemption.Available values: MANUAL, AUTOMATIC
related_objectobject	Defines the resource that is being modified with the values that are returned in the balance object.Attributes Descriptionidstring Identifies the voucher that is being modified. The ID is assigned by the Voucherify API. typestring The object being modified, i.e. voucher. Available values: voucher

Order Calculated No Customer Data

Attributes	Description
idstring	Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request.
source_idstring, null	Unique source ID of an existing order that will be linked to the redemption of this request.
statusstring	The order status.Available values: CREATED, PAID, CANCELED, FULFILLED
amountinteger	This is the sum of the order items’ amounts. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
initial_amountinteger	This is the sum of the order items’ amounts before any discount or other effect (e.g. add missing units) is applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
discount_amountinteger	Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
items_discount_amountinteger	Sum of all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
total_discount_amountinteger	Sum of all order-level AND all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
total_amountinteger	Order amount after undoing all the discounts through the rollback redemption. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
applied_discount_amountinteger	This field shows the order-level discount applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
items_applied_discount_amountinteger	Sum of all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).sum(items, i => i.applied_discount_amount)
total_applied_discount_amountinteger	Sum of all order-level AND all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).total_applied_discount_amount = applied_discount_amount + items_applied_discount_amount
metadataobject	A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.
objectstring	The type of the object represented by JSON.Available values: order
created_atstring	Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.Example:2021-12-22T10:13:06.487Z
updated_atstring, null	Timestamp representing the date and time when the order was last updated in ISO 8601 format.Example:2021-12-22T10:14:45.316Z
customer_idstring, null	Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify.Example:cust_7iUa6ICKyU6gH40dBU25kQU1
referrer_idstring, null	Unique referrer ID.Example:cust_nM4jqPiaXUvQdVSA6vTRUnix
customer	Customer Id
referrer	Referrer Id
redemptionsobject	Attributes Description[propertyName] See: Order Redemptions

Order Item Calculated

Attributes	Description
idstring	Unique identifier of the order line item.
sku_idstring	Unique identifier of the SKU. It is assigned by Voucherify.
product_idstring	Unique identifier of the product. It is assigned by Voucherify.
related_objectstring	Used along with the source_id property, can be set to either sku or product.Available values: product, sku
source_idstring	The merchant’s product/SKU ID (if it is different from the Voucherify product/SKU ID). It is useful in the integration between multiple systems. It can be an ID from an eCommerce site, a database, or a third-party service.
quantityinteger	The quantity of the particular item in the cart.
discount_quantityinteger	Number of dicounted items.
initial_quantityinteger	A positive integer in the smallest unit quantity representing the total amount of the order; this is the sum of the order items’ quantity.
amountinteger	The total amount of the order item (price * quantity).
discount_amountinteger	Sum of all order-item-level discounts applied to the order.
applied_discount_amountinteger	This field shows the order-level discount applied.
applied_discount_quantityinteger	Number of the discounted items applied in the transaction.
applied_quantityinteger	Quantity of items changed by the application of a new quantity items. It can be positive when an item is added or negative if an item is replaced.
applied_quantity_amountinteger	Amount for the items changed by the application of a new quantity items. It can be positive when an item is added or negative if an item is replaced.
initial_amountinteger	A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items’ amounts.
priceinteger	Unit price of an item. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.
subtotal_amountinteger	Final order item amount after the applied item-level discount. If there are no item-level discounts applied, this item is equal to the amount.subtotal_amount=amount-applied_discount_amount
productobject	An object containing details of the related product.Attributes Descriptionidstring A unique identifier that represents the product and is assigned by Voucherify. source_idstring The merchant’s product ID (if it is different than Voucherify’s product ID). It is really useful in case of integration between multiple systems. It can be an ID from an eCommerce site, a database or a 3rd party service. overrideboolean The override set to true is used to store the product information in the system. If the product does not exist, it will be created with a source_id; if it does exist, the provided values for the name, price, and metadata will replace those already stored in the system. namestring Product name. metadataobject A set of custom key/value pairs that you can attach to a product. It can be useful for storing additional information about the product in a structured format. It can be used to create product collections. pricenumber Product price. A positive integer in the smallest currency unit (e.g. 100 cents for $1.00).
skuobject	An object containing details of the related SKU.Attributes Descriptionidstring A unique identifier that represents the SKU and is assigned by Voucherify. source_idstring The merchant’s SKU ID (if it is different than Voucherify’s SKU ID). It is really useful in case of integration between multiple systems. It can be an ID from an eCommerce site, a database or a 3rd party service. overrideboolean The override set to true is used to store the product information in the system. If the product does not exist, it will be created with a source_id; if it does exist, the provided values for the name, price, and metadata will replace those already stored in the system. skustring The SKU name. pricenumber SKU price. A positive integer in the smallest currency unit (e.g. 100 cents for $1.00). metadataobject A set of custom key/value pairs that you can attach to an SKU. It can be useful for storing additional information about the SKU in a structured format. It can be used to create product collections.
objectstring	The type of the object represented by JSON.Available values: order_item
metadataobject	A set of custom key/value pairs that you can attach to an item object. It can be useful for storing additional information about the item in a structured format. It can be used to define business validation rules or discount formulas.

Simple Event

Attributes	Description
idstring	Unique identifier assigned by Voucherify that will be linked to the this event.Example:evcus_0e3070fef399b70b00
typestring	Type of the triggering event.Example:customer.order.paid
categorystring	Type of the event.Available values: EFFECT, ACTION
entity_idstring	ID of the entity that initiated the event.Example:cust_ADqZIwGvWFvugWXVbrHwXRHO
created_atstring	Timestamp representing the date and time when the event was created in the ISO 8601 format.Example:2024-01-01T11:11:11.111Z
group_idstring	Unique identifier of the request that triggered the event.Example:v-1f36113948e50fc4ge

Voucher Transaction Base

Attributes	Description
idstring	Unique transaction ID.
source_idstring, null	The merchant’s transaction ID if it is different from the Voucherify transaction ID. It is really useful in case of an integration between multiple systems. It can be a transaction ID from a CRM system, database or 3rd-party service. In case of a redemption, this value is null.
voucher_idstring	Unique voucher ID.
campaign_idstring	Unqiue campaign ID of the voucher’s parent campaign if it is part of campaign that generates bulk codes.
sourcestring, null	The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null.
reasonstring, null	Reason why the transaction occurred. In case of a redemption, this value is null.
related_transaction_idstring, null	The related transaction ID on the receiving card.
created_atstring	Timestamp representing the date and time when the transaction was created. The value is shown in the ISO 8601 format.

Simple Order

Attributes	Description
idstring	Unique identifier of an existing order that will be linked to the redemption of this request.
source_idstring	Unique source identifier of an existing order that will be linked to the redemption of this request.
statusstring	The order status.Available values: CREATED, PAID, CANCELED, FULFILLED
customer_idstring, null	Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify.Example:cust_7iUa6ICKyU6gH40dBU25kQU1
referrer_idstring, null	Unique identifier of the referrer assigned by Voucherify.Example:cust_nM4jqPiaXUvQdVSA6vTRUnix
amountinteger	A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items’ amounts.
discount_amountinteger	Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
applied_discount_amountinteger	This field shows the order-level discount applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
items_discount_amountinteger	Sum of all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
items_applied_discount_amountinteger	Sum of all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).sum(items, i => i.applied_discount_amount)
total_discount_amountinteger	Sum of all order-level AND all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
total_applied_discount_amountinteger	Sum of all order-level AND all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).total_applied_discount_amount = applied_discount_amount + items_applied_discount_amount
total_amountinteger	Order amount after undoing all the discounts through the rollback redemption. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
itemsarray	Array of items applied to the order. It can include up to 500 items.Array of Simple Order Item
metadataobject	A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.
objectstring	The type of the object represented by JSON.Available values: order

Voucher Transaction

All of:

1. Voucher Transaction Base

2. Attributes	Description
   detailsobject	Contains the detailed information about the transaction.Attributes Descriptionbalance See: Voucher Balance orderobject Contains information about the original order. Attributes Descriptionidstring Unique order ID. source_idstring The merchant’s order ID if it is different from the Voucherify order ID. It is really useful in case of integration between multiple systems. It can be an order ID from CRM, database or 3rd party service. eventobject Contains information about the event that triggers the point accrual. Attributes Descriptionidstring Unique event ID. typestring Type of event. earning_ruleobject Contains information about the earning rule. Attributes Descriptionidstring Unique identifier of an earning rule, assigned by Voucherify. sourceobject Contains the custom earning rule name. Attributes Descriptionbannerstring Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard. segmentobject Contains information about the segment. Attributes Descriptionidstring Unique identifier of the segment. namestring Name of the segment. loyalty_tierobject Contains information about the loyalty tier that is mapped for the earning rule and used in the transaction. Attributes Descriptionidstring Unique identifier of the loyalty tier, assigned by Voucherify. namestring User-defined name of the loyalty tier. redemptionobject Contains information about the original redemption. Attributes Descriptionidstring Unique redemption ID. rollbackobject Contains information about the redemption rollback. Attributes Descriptionidstring Unique identifier of the redemption rollback. custom_eventobject Contains information about the custom event that triggers the point accrual. Attributes Descriptionidstring Unique identifier of the event. typestring Type of the custom event. event_schemaobject Contains information about the custom event metadata schema. Attributes Descriptionidstring Unique identifier of the metadata schema. namestring Type of the custom event. holder_loyalty_tierobject Loyalty tier of the loyalty card holder at the moment when the transaction occurred. The loyalty tier is the tier in which the holder was before the loyalty point balance changed. Attributes Descriptionidstring Unique identifier of the loyalty tier, assigned by Voucherify. namestring User-defined name of the loyalty tier. pending_points See: Loyalty Pending Point Entry rewardobject Contains information about the pay with points reward. Attributes Descriptionidstring Unique reward ID. namestring Reward name. source_voucher Contains information on how the balance on the donor loyalty card was affected by the transaction. Simple Voucher destination_voucher Contains information on how the balance on the receiving loyalty card was affected by the transaction. Simple Voucher
   type	One of: Gift Card Transactions Type, Loyalty Card Transactions Type

Loyalty Pending Point Entry

Attributes	Description
idstring	Unique identifier of the pending point entry, assigned by Voucherify.Example:lopp_0ffd593d5ad207ba6b
voucher_idstring	Unique identifier of the loyalty card, assigned by Voucherify.Example:v_abCdEfghI1JKLMNPqRS2Tu3vWXyza4bc
campaign_idstring	Unique campaign identifier, assigned by Voucherify.Example:camp_weer1c3p5ZgktqfW56RfoNaG
customer_idstring	Unique customer identifier, assigned by Voucherify.Example:cust_IdgAFZxYwwHctOk9ppZMu319
order_idstring	Unique order identifier, assigned by Voucherify.Example:ord_0ffc0fa65f15d2df17
pointsinteger	Number of points in the pending state.
activates_atstring	Date when the pending points are activated and added to the customer’s loyalty card.
details	See: Pending Point Details
created_atstring	Timestamp representing the date and time when the pending point entry was created. The value is shown in the ISO 8601 format.
updated_atstring	Timestamp representing the date and time when the pending point entry was modified. The value is shown in the ISO 8601 format.

Loyalty Point Bucket

Attributes	Description
idstring	Unique identifier of the loyalty points bucket.
voucher_idstring	Unique identifier of the parent loyalty card.
campaign_idstring	Unique identifier of the parent campaign.
bucketobject	Defines the number of points stored in this loyalty point bucket.Attributes Descriptiontotal_pointsinteger Total number of points in the loyalty point bucket.
statusstring	Loyalty point point bucket status.
expires_atstring	Date when the number of points defined in the bucket object are due to expire.
created_atstring	Timestamp representing the date and time when the loyalty point bucket object was created in ISO 8601 format.
updated_atstring	Timestamp representing the date and time when the loyalty point bucket object was updated in ISO 8601 format.
objectstring	The type of the object represented by JSON. This object stores information about the loyalty point bucket.Available values: loyalty_points_bucket

Valid Single Voucher

All of:

1. List Publications Item Base

2. Attributes	Description
   resultstring	Status of the publication attempt.Available values: SUCCESS
   voucher	See: List Publications Item Voucher

Validation Entity

Attributes	Description
idstring	Unique validation id.
session_idstring	Unique session id.
statusstring	The validation statusAvailable values: VALID, INVALID
created_atstring	Timestamp representing the date and time when the validation was created. The value is shown in the ISO 8601 format.Example:2021-12-22T10:13:06.487Z
customer_idstring	Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify.Example:cust_7iUa6ICKyU6gH40dBU25kQU1
redeemablesarray	Lists validation results of each redeemable.Array of:Attributes Descriptionidstring Unique identifier of the redeemable, assigned by Voucherify. typestring Type of the redeemable. Available values: voucher, promotion_tier
skipped_redeemablesarray	Lists validation results of each redeemable.Array of:Attributes Descriptionidstring Unique identifier of the redeemable, assigned by Voucherify. typestring Type of the redeemable. Available values: voucher, promotion_tier
inapplicable_redeemablesarray	Lists validation results of each redeemable.Array of:Attributes Descriptionidstring Unique identifier of the redeemable, assigned by Voucherify. typestring Type of the redeemable. Available values: voucher, promotion_tier

Event Customer Redemption

Attributes	Description
customer	See: Simple Customer
order	See: Simple Order
campaign	See: Simple Campaign
voucher	See: Simple Voucher
holder	See: Simple Customer
promotion_tier	See: Simple Promotion Tier
promotion_stack	See: Simple Promotion Stack
redemption	See: Simple Redemption

Simple Redemption

Attributes	Description
idstring	Unique redemption ID.Example:r_0bc92f81a6801f9bca
customer_idstring, null	Unique customer ID of the redeeming customer.Example:cust_i8t5Tt6eiKG5K79KQlJ0Vs64
tracking_idstring	Hashed customer source ID.
datestring	Timestamp representing the date and time when the redemption was created in the ISO 8601 format.Example:2021-12-22T10:13:06.487Z
amountinteger	For gift cards, this is a positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the number of redeemed credits.For loyalty cards, this is the number of loyalty points used in the transaction.In the case of redemption rollback, the numbers are expressed as negative integers.Example:10000
order	See: Simple Order
reward	See: Simple Redemption Reward Result
customer	See: Simple Customer
resultstring	Redemption result.Available values: SUCCESS, FAILURE
statusstring, null	Available values: SUCCEEDED, FAILED, ROLLED BACK
voucher	Defines the details of the voucher being redeemed.Simple Voucher
promotion_tier	See: Simple Promotion Tier
redemptionstring	Unique redemption ID of the parent redemption.Example:r_0c656311b5878a2031
metadataobject	The metadata object stores all custom attributes in the form of key/value pairs assigned to the redemption.
failure_codestring	If the result is FAILURE, this parameter will provide a generic reason as to why the redemption failed.Example:customer_rules_violated
failure_messagestring	If the result is FAILURE, this parameter will provide an expanded reason as to why the redemption failed.
reasonstring	The reason for the redemption rollback.
channelobject	Defines the details of the channel through which the redemption was issued.Attributes Descriptionchannel_idstring Unique channel ID of the user performing the redemption. This is either a user ID from a user using the Voucherify Dashboard, an X-APP-Id of a user using the API, or the reward assignment ID for automatic reward redemption. channel_typestring The source of the channel for the redemption:USER - the redemption was made in the Voucherify Dashboard by a user,API - redemption was made through the API,AUTO_REDEEM - the redemption was made automatically for a reward. Available values: API, AUTO_REDEEM, USER
objectstring	The type of the object represented by the JSON. This object stores information about the redemption.

Event Customer Order

Attributes	Description
customer	See: Simple Customer
referrer	See: Simple Customer
order	All of: 1. Order Calculated No Customer Data
2.Attributes Descriptionitemsarray Array of items applied to the order. It can include up to 500 items. Array of Order Item Calculated
redemption	See: Redemption Internal

Event Customer Reward Redemptions

Attributes	Description
customer	See: Simple Customer
holder	See: Simple Customer
voucher	See: Simple Voucher
campaign	See: Simple Campaign
reward_redemptionobject
reward	See: Simple Redemption Reward Result
reward_assignment	See: Reward Assignment
sourcestring
balanceinteger

Event Customer Loyalty Tier Base

Attributes	Description
customer	See: Simple Customer
campaign	See: Simple Campaign

Redeemable Holder

Attributes	Description
idstring	Unique identifier of the redeemable holder.Example:rh_0e7b8db4700106a852
created_atstring	Timestamp representing the date and time when the redeemable was assigned. The value is shown in the ISO 8601 format.Example:2024-03-22T17:48:25.910Z
redeemable_idstring	Identifier of the redeemable item.Example:v_GXVguPhq2khgFxH7GrRXWA91gDr1LiA1
redeemable_objectstring	Type of the redeemable.Available values: voucher Example:voucher
campaign_idstring	Unique identifier of the campaign as assigned by Voucherify.Example:camp_weer1c3p5ZgktqfW56RfoNaG
campaign_typestring	Defines the type of the campaign.Available values: REFERRAL_PROGRAM Example:REFERRAL_PROGRAM
voucher_typestring	Defines the type of the voucher.Available values: GIFT_VOUCHER, DISCOUNT_VOUCHER, LOYALTY_CARD Example:DISCOUNT_VOUCHER
publication_idstring, null	Unique identifier of the publication.
customer_idstring	Unique identifier of the customer.Example:cust_p1ufreYbVbwZ1x70nFkH9rF9
holder_rolestring	Role of the holder.Available values: OWNER, REFERRER, REFEREE Example:REFERRER
objectstring	The type of the object represented by JSON.Available values: redeemable_holder

Customer Summary

Attributes	Description
redemptions	See: Customer Summary Redemptions
orders	See: Customer Summary Orders

Customer Loyalty

Attributes	Description
pointsinteger	Customer’s loyalty points minus expired for all loyalty cards which the customer has.
referred_customersinteger	Total number of customers referred by the customer.
campaignsobject	Contains campaigns with details about point balances and how many customers were referred by the customer.Attributes Description[propertyName]object Contains details about the point balances left on loyalty cards and the number of referred customers in each campaign. Attributes Descriptionpointsinteger Remaining point balance in campaign. loyalty_tierstring Customer’s loyalty tier within the campaign. Example: ltr_UJ5Q54Q0OvEhua87Qfv2Ki5x referred_customersinteger Number of customers referred by the customer in campaign.

Customer Referrals

Attributes	Description
totalinteger	Total number of times this customer received a referral, i.e. was referred by another customer.
campaignsarray	Contains an array of campaigns that served as the source of a referral for the customer.Array of:### Customer Referrals Campaigns ItemAttributes Descriptioncampaign_idstring Unique campaign ID, assigned by Voucherify. Example: camp_rRsfatlwN7unSeUIJDCYedal referrer_idstring Unique referrer ID, assigned by Voucherify. This is the customer ID of a customer that is referring this customer. Example: cust_sehkNIi8Uq2qQuRqSr7xn4Zi related_object_idstring Related object id Example: r_0b9d4cc4aa164dd073 related_object_typestring Related object type, i.e. redemption. datestring Timestamp representing the date and time when the customer was referred in ISO 8601 format. Example: 2022-08-30T10:19:39.196Z

Customer Base

Attributes	Description
namestring	Customer’s first and last name.
descriptionstring	An arbitrary string that you can attach to a customer object.
emailstring	Customer’s email address.
phonestring	Customer’s phone number. This parameter is mandatory when you try to send out codes to customers via an SMS channel.
birthdaystring	Deprecated. Customer’s birthdate; format YYYY-MM-DD.
birthdatestring	Customer’s birthdate; format YYYY-MM-DD.
addressobject, null	Customer’s address.Attributes Descriptioncitystring City statestring State line_1string First line of address. line_2string Second line of address. countrystring Country. postal_codestring Postal code.
metadataobject	A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments.

Simple Campaign Voucher

Attributes	Description
typestring	Type of the voucher.Available values: DISCOUNT_VOUCHER, LOYALTY_CARD, GIFT_VOUCHER
discount	Defines the voucher discount type and details.Discount
gift	Defines the voucher gift details.Gift
loyalty_card	Defines the voucher loyalty card details.Campaign Loyalty Card
redemptionobject	Defines the redemption limits on vouchers.Attributes Descriptionquantityinteger, null How many times a voucher can be redeemed. A null value means unlimited. redeemed_quantityinteger How many times a voucher has already been redeemed. Example: 1
code_config	Code Config

Referral Program

Attributes	Description
conversion_event_typestring	Define how a referral is triggered.Available values: redemption, custom_event
custom_eventobject	Contains details about the custom event.Attributes Descriptionidstring Unique custom event ID. Example: ms_Ll9enAm2BCN0M1s4VxWobLFM namestring Custom event name.
referee_rewardobject	Defines the referee reward.Attributes Descriptionrelated_object_parentobject Details of the resource from which the reward originates. Attributes Descriptionidstring Unique ID of the reward source. Example: camp_kdxp3vf1clQ9CFs1jpqv3tZe namestring Name of the reward source. objectstring Type of resource represented by the source of the reward. Available values: CAMPAIGN typestring Type of reward. Available values: LOYALTY_CARD, GIFT_VOUCHER amountstring Define the number of points to add to a loyalty card or credits to the balance on a gift card. In case of the gift card, the value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000.

Category

Attributes	Description
idstring	Unique category ID assigned by Voucherify.
namestring	Category name.
hierarchyinteger	Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value.
objectstring	The type of the object represented by the JSON. This object stores information about the category.Available values: category
created_atstring	Timestamp representing the date and time when the category was created. The value is shown in the ISO 8601 format.Example:2022-07-14T10:45:13.156Z
updated_atstring	Timestamp representing the date and time when the category was updated. The value is shown in the ISO 8601 format.Example:2022-08-16T10:52:08.094Z

Gift

Attributes	Description
amountnumber	Total gift card income over the lifetime of the card. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.
subtracted_amountinteger	Total amount of subtracted credits over the gift card lifetime.
balancenumber	Available funds. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00. balance = amount - subtracted_amount - redemption.redeemed_amount.
effectstring	Defines how the credits are applied to the customer’s order.Available values: APPLY_TO_ORDER, APPLY_TO_ITEMS

Discount

Contains information about discount.

One of:

Amount, Unit, Unit Multiple, Percent, Fixed

Simple Loyalty Card

Attributes	Description
pointsinteger	Total number of points added to the loyalty card over its lifespan.
balanceinteger	Points available for reward redemption. This is calculated as follows: balance = points - expired_points - subtracted_points - redemption.redeemed_points.
next_expiration_datestring	The next closest date when the next set of points are due to expire.
next_expiration_pointsinteger	The amount of points that are set to expire next.
pending_pointsinteger	Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually.
expired_pointsinteger	Shows the total number of expired points over the lifetime of the loyalty card.
subtracted_pointsinteger	Shows the total number of subtracted points over the lifetime of the loyalty card.

Customer Object Required Object Type

Attributes	Description
idstring	The unique ID of a customer that is assigned by Voucherify.Example:cust_CSnYd37MXmrbS19XCrghjBsv
source_idstring	The merchant’s customer ID if it is different from the Voucherify customer ID. It is really useful in case of an integration between multiple systems. It can be a customer ID from a CRM system, database or 3rd-party service.
namestring	Customer’s first and last name.
emailstring	Customer’s email address.
metadataobject	A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments.
objectstring	The type of the object represented by the JSON. This object stores information about the customer.

Redemption Reward Result

Attributes	Description
customer	Simple Customer
assignment_idstring, null	Unique reward assignment ID assigned by Voucherify.
voucher	Voucher
product	Product
sku	SKU Object
loyalty_tier_idstring, null	Unique loyalty tier ID assigned by Voucherify.
idstring	Unique reward ID.Example:rew_0bc92f81a6801f9bca
namestring	Name of the reward.Example:Reward Name
objectstring	The type of the object represented by the JSONAvailable values: reward
created_atstring	Timestamp representing the date and time when the redemption was created. The value is shown in the ISO 8601 format.Example:2021-12-22T10:13:06.487Z
updated_atstring	Timestamp in ISO 8601 format indicating when the reward was updated.Example:2022-10-03T12:24:58.008Z
parametersobject	These are parameters representing a material reward.Attributes Descriptioncampaignobject Defines the product redeemed as a reward. Attributes Descriptionidstring Campaign unique ID. Example: camp_13BbZ0kQsNinhqsX3wUts2UP balanceinteger Points available for reward redemption. This is calculated as follows: balance = points - expired_points - subtracted_points - redemption.redeemed_points. typestring Defines the type of the campaign. productobject Defines the product redeemed as a reward. Attributes Descriptionidstring Unique product ID, assigned by Voucherify. Example: prod_0b7d7dfb05cbe5c616 sku_idstring Unique identifier of the SKU. It is assigned by Voucherify. Example: sku_0a41e31c7b41c28358 coinobject Defines the ratio by mapping the number of loyalty points in points_ratio to a predefined cash amount in exchange_ratio. Attributes Descriptionexchange_ratiointeger 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.
metadataobject	A set of custom key/value pairs that you can attach to a reward. The metadata object stores all custom attributes assigned to the reward.
typestring	Reward type.Available values: CAMPAIGN, COIN, MATERIAL

Voucher

This is an object representing a voucher with categories and validation rules assignments.

All of:

1. Voucher Base

2. Attributes	Description
   categoriesarray	Contains details about the category.Array of Category
   validation_rules_assignments	See: Validation Rules Assignments List

Voucher Holder

Attributes	Description
holder	See: Simple Customer

Promotion Tier

Attributes	Description
idstring	Unique promotion tier ID.Example:promo_63fYCt81Aw0h7lzyRkrGZh9p
created_atstring	Timestamp representing the date and time when the promotion tier was created. The value is shown in the ISO 8601 format.Example:2021-12-15T11:34:01.333Z
updated_atstring	Timestamp representing the date and time when the promotion tier was updated. The value is shown in the ISO 8601 format.Example:2022-02-09T09:20:05.603Z
namestring	Name of the promotion tier.
bannerstring	Text to be displayed to your customers on your website.
actionobject	Contains details about the discount applied by the promotion tier.Attributes Descriptiondiscount See: Discount
metadataobject	The metadata object stores all custom attributes assigned to the promotion tier. A set of key/value pairs that you can attach to a promotion tier object. It can be useful for storing additional information about the promotion tier in a structured format.
hierarchyinteger	The promotions hierarchy defines the order in which the discounts from different tiers will be applied to a customer’s order. If a customer qualifies for discounts from more than one tier, discounts will be applied in the order defined in the hierarchy.
promotion_idstring	Promotion unique ID.
campaignobject	Contains details about promotion tier’s parent campaign.Attributes Descriptionidstring Unique campaign ID. start_datestring Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date. Example: 2022-09-22T00:00:00.000Z expiration_datestring Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date. Example: 2022-09-30T00:00:00.000Z validity_timeframe See: Validity Timeframe validity_day_of_week See: Validity Day Of Week validity_hours See: Validity Hours activeboolean A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it’s within the active period defined by the start_date and expiration_date using the Disable Campaign endpoint. true indicates an active campaign false indicates an inactive campaign category_idstring Unique category ID that this campaign belongs to. Example: cat_0b688929a2476386a6 objectstring The type of the object represented by the campaign object. This object stores information about the campaign.
campaign_idstring	Promotion tier’s parent campaign’s unique ID.
activeboolean	A flag to toggle the promotion tier on or off. You can disable a promotion tier even though it’s within the active period defined by the start_date and expiration_date.- true indicates an active promotion tier

• false indicates an inactive promotion tier | | start_datestring | Activation timestamp defines when the promotion tier starts to be active in ISO 8601 format. Promotion tier is inactive before this date.Example:2022-09-23T00:00:00.000Z | | expiration_datestring | Activation timestamp defines when the promotion tier expires in ISO 8601 format. Promotion tier is inactive after this date.Example:2022-09-26T00:00:00.000Z | | validity_timeframe | See: Validity Timeframe | | validity_day_of_week | See: Validity Day Of Week | | validity_hours | See: Validity Hours | | summaryobject | Contains statistics about promotion tier redemptions and orders.Attributes Descriptionredemptionsobject

  Contains statistics about promotion tier redemptions.

  Attributes Descriptiontotal_redeemedinteger

  Number of times the promotion tier was redeemed.

  ordersobject

  Contains statistics about orders related to the promotion tier.

  Attributes Descriptiontotal_amountinteger

  Sum of order totals.

  total_discount_amountinteger

  Sum of total discount applied using the promotion tier. | | objectstring | The type of the object represented by JSON. This object stores information about the promotion tier. | | validation_rule_assignments | See: Validation Rule Assignments List | | category_idstring | Promotion tier category ID.Example:cat_0c9da30e7116ba6bba | | categoriesarray | Array of Category |

Simple Product

Attributes	Description
idstring	Unique product ID.
source_idstring	Product source id.
namestring	Product name.

Simple Sku

Attributes	Description
idstring	Unique sku ID.
source_idstring	Sku source id.
skustring	Sku name.

Reward type

One of:

Digital, Pay with Points, Material

Loyalty Tier Base

Attributes	Description
namestring	Loyalty Tier name.
earning_rulesobject	Contains a list of earning rule IDs and their points mapping for the given earning rule.Attributes Description[propertyName] See: MappingPoints
rewardsobject	Contains a list of reward IDs and their points mapping for the given reward.Attributes Description[propertyName] See: MappingPoints
pointsobject	Defines range of loyalty tier in points.Attributes Descriptionfrominteger Bottom points threshold value. tointeger Top points threshold value.

Loyalty Tier Expiration

Attributes	Description
customer_idstring	Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify.Example:cust_7iUa6ICKyU6gH40dBU25kQU1
campaign_idstring	Unique campaign ID, assigned by Voucherify.Example:camp_rRsfatlwN7unSeUIJDCYedal
tier_idstring	Unique tier ID, assigned by Voucherify.
start_datestring	Activation timestamp defines when the loyalty tier starts to be active in ISO 8601 format. Loyalty tier is inactive before this date.
expiration_datestring	Expiration timestamp defines when the loyalty tier expires in ISO 8601 format. Loyalty tier is inactive after this date.
created_atstring	Timestamp representing the date and time when the loyalty tier was created. The value is shown in the ISO 8601 format.Example:2021-12-22T10:13:06.487Z
updated_atstring	Timestamp representing the date and time when the loyalty tier was updated. The value is shown in the ISO 8601 format.Example:2021-12-22T10:13:06.487Z

EarningRuleBase

Attributes	Description
idstring	Assigned by the Voucherify API, identifies the earning rule object.
created_atstring	Timestamp representing the date and time when the earning rule was created. The value is shown in the ISO 8601 format.
loyalty	One of: Define fixed amount of points, Calculate points proportionally
event	Defines the event which triggers the earning rule to add points to a loyalty card.Earning Rule Event
custom_eventobject	Contains details about the custom event.Attributes Descriptionschema_idstring Unique identifier of the custom event schema
segmentobject	Contains the ID of a customer segment. Required for the customer.segment.entered option in the event.Attributes Descriptionidstring Contains a unique identifier of a customer segment. Assigned by the Voucherify API.
loyalty_tierobject	Defines the tier associated with the earning rule definition.Attributes Descriptionidstring Unique loyalty tier ID associated with the earning rule. ANY: any loyalty tier within the campaign Example: ltr_pudTGWasuIqxdiDM0go31OV1
pending_pointsobject	Defines the configuration for pending points. Pending points can be used only with the order.paid event.Attributes Descriptionperiod_typestring Defines the type of the period during which the points are in the pending state. Currently, only DAY value is accepted. Available values: DAY period_valueinteger Defines for how long the points are in the pending state. The minimum value is 1, maximum is 90.
sourceobject	Contains the custom earning rule name and parent campaign.Attributes Descriptionbannerstring Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard. object_idstring A unique campaign identifier assigned by the Voucherify API. object_typestring Defines the object associated with the earning rule. Defaults to campaign. Available values: campaign
objectstring	The type of the object represented by JSON. Default is earning_rule.Available values: earning_rule
automation_idstring	For internal use by Voucherify.
start_datestring	Start date defines when the earning rule starts to be active. Activation timestamp is presented in the ISO 8601 format. The earning rule is inactive before this date. If you do not define the start date for an earning rule, it will inherit the campaign start date by default.
expiration_datestring	Expiration date defines when the earning rule expires. Expiration timestamp is presented in the ISO 8601 format. The earning rule is inactive after this date. If you do not define the expiration date for an earning rule, it will inherit the campaign expiration date by default.
validity_timeframe	See: Validity Timeframe
validity_day_of_week	See: Validity Day Of Week
validity_hours	See: Validity Hours
metadataobject	The metadata object stores all custom attributes assigned to the earning rule. A set of key/value pairs that you can attach to an earning rule object. It can be useful for storing additional information about the earning rule in a structured format.
expiration_rules	See: Earning Rule Expiration Rules

Customer Id

Attributes	Description
idstring	A unique identifier of an existing customer.
objectstring	The type of the object represented by JSON.Available values: customer

Referrer Id

Customer Id

Order Redemptions

Attributes	Description
datestring	Timestamp representing the date and time when the redemption was created. The value is shown in the ISO 8601 format.Example:2022-09-02T17:06:56.649Z
rollback_idstring	Unique ID of the redemption rollback.Example:rr_0c63c84eb78ee0a6c0
rollback_datestring	Timestamp representing the date and time when the redemption rollback was created. The value is shown in the ISO 8601 format.Example:2023-01-31T14:18:37.150Z
related_object_typestring	The source of the incentive.
related_object_idstring	Unique ID of the parent redemption.Example:r_0ba186c4824e4881e1
related_object_parent_idstring	Represent’s the campaign ID of the voucher if the redemption was based on a voucher that was part of bulk codes generated within a campaign. In case of a promotion tier, this represents the campaign ID of the promotion tier’s parent campaign.
stackedarray	Contains a list of unique IDs of child redemptions, which belong to the stacked incentives.
rollback_stackedarray	Lists the rollback redemption IDs of the particular child redemptions.

Simple Order Item

Attributes	Description
idstring	Unique identifier of the order line item.
objectstring	The type of the object represented by JSON. This object stores information about the order_item.Available values: order_item
source_idstring	The merchant’s product/SKU ID (if it is different from the Voucherify product/SKU ID). It is useful in the integration between multiple systems. It can be an ID from an eCommerce site, a database, or a third-party service.
related_objectstring	Used along with the source_id property, can be set to either SKU or product.Available values: product, sku
product_idstring	Unique identifier of the product. It is assigned by Voucherify.
sku_idstring	Unique identifier of the SKU. It is assigned by Voucherify.
quantityinteger	Quantity of the particular item in the cart.
applied_quantityinteger	Quantity of items changed by the application of a new quantity items. It can be positive when an item is added or negative if an item is replaced.
applied_quantity_amountinteger	Amount for the items changed by the application of a new quantity items. It can be positive when an item is added or negative if an item is replaced.
discount_quantityinteger	Number of discounted items.
applied_discount_quantityinteger	Number of the discounted items applied in the transaction.
amountinteger	Total amount of the order item (price * quantity).
discount_amountinteger	Sum of all order-item-level discounts applied to the order.
applied_discount_amountinteger	Order-level discount amount applied in the transaction.
priceinteger	Unit price of an item. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.
subtotal_amountinteger	Final order item amount after the applied item-level discount. If there are no item-level discounts applied, this item is equal to the amount.subtotal_amount=amount-discount_amount

Gift Card Transactions Type

Transaction types concerning gift card credits.

Available values: CREDITS_REDEMPTION, CREDITS_REFUND, CREDITS_ADDITION, CREDITS_REMOVAL

Loyalty Card Transactions Type

Transaction types concerning loyalty points.

Available values: PENDING_POINTS_ACTIVATION, POINTS_ACCRUAL, POINTS_REDEMPTION, POINTS_REFUND, POINTS_ADDITION, POINTS_REMOVAL, POINTS_EXPIRATION, POINTS_TRANSFER_IN, POINTS_TRANSFER_OUT

Pending Point Details

Attributes	Description
loyalty_tierobject	The loyalty tier that is mapped for the earning rule and used in the pending point transaction.Attributes Descriptionidstring Unique identifier of the loyalty tier, assigned by Voucherify. namestring User-defined name of the loyalty tier.
holder_loyalty_tierobject	Loyalty tier of the loyalty card holder at the moment when the transaction occurred. The loyalty tier is the tier in which the holder was at the moment pending points were created.Attributes Descriptionidstring Unique identifier of the loyalty tier, assigned by Voucherify. namestring User-defined name of the loyalty tier.
eventobject	Details about the event that created pending points.Attributes Descriptionidstring Unique event identifier, assigned by Voucherify. typestring Type of the event that triggered the creation of pending points. Available values: customer.order.paid group_idstring Unique identifier of the request that triggered the event, assigned by Voucherify. entity_idstring Unique identifier of the entity that triggered the event, assigned by Voucherify. For pending points, it is the customer_id of the customer who paid for the order. created_atstring Timestamp representing the date and time when the event occurred. The value is shown in the ISO 8601 format. categorystring Type of the event. Available values: ACTION, EFFECT event_source See: Event Source
earning_ruleobject	Contains information about the earning rule.Attributes Descriptionidstring Unique identifier of an earning rule, assigned by Voucherify. sourceobject Contains the custom earning rule name. Attributes Descriptionbannerstring Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard.
orderobject	Details about the order that caused adding pending points.Attributes Descriptionidstring Unique order identifier, assigned by Voucherify. source_idstring, null User-defined order identifier.

List Publications Item Base

Attributes	Description
idstring	Unique publication ID, assigned by Voucherify.Example:pub_BbjAXnmm8e0SIm3zG8qvvFCP0KuLywtp
objectstring	The type of the object represented by the JSON. This object stores information about the publication.Available values: publication
created_atstring	Timestamp representing the date and time when the publication was created. The value is shown in the ISO 8601 format.Example:2022-09-23T09:57:00.434Z
customer_idstring	Unique customer ID of the customer receiving the publication.Example:cust_eWgXlBBiY6THFRJwX45Iakv4
tracking_idstring	Customer’s source_id.
metadataobject	The metadata object stores all custom attributes assigned to the publication. A set of key/value pairs that you can attach to a publication object. It can be useful for storing additional information about the publication in a structured format.Attributes Descriptionsource_typestring Defines the type of the distribution source. source_idstring Unique identifier of the distribution source. distribution_idstring Unique identifier of the distribution.
channelstring	How the publication was originated. It can be your own custom channel or an example value provided here.
source_idstring, null	The merchant’s publication ID if it is different from the Voucherify publication ID. It’s an optional tracking identifier of a publication. It is really useful in case of an integration between multiple systems. It can be a publication ID from a CRM system, database or 3rd-party service.
customer	See: Customer With Summary Loyalty Referrals
vouchersarray	Contains the voucher IDs that was assigned by Voucherify.
vouchers_idarray	Contains the unique internal voucher IDs that was assigned by Voucherify.

List Publications Item Voucher

Attributes	Description
codestring	Voucher code.
objectstring	The type of the object represented by JSON.Available values: voucher
campaignstring	Campaign name
gift	Gift object responseGift
loyalty_cardobject	Defines the loyalty card details.
discount	See: Discount
is_referral_codeboolean	Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.

Simple Promotion Tier

Attributes	Description
idstring	Unique promotion tier ID.Example:promo_63fYCt81Aw0h7lzyRkrGZh9p
namestring	Name of the promotion tier.
bannerstring	Text to be displayed to your customers on your website.
campaignobject	Contains details about promotion tier’s parent campaign.Attributes Descriptionidstring Unique campaign ID.
metadataobject	A set of custom key/value pairs that you can attach to a promotion tier. The metadata object stores all custom attributes assigned to the promotion tier.

Simple Promotion Stack

Attributes	Description
idstring	Unique identifier of the promotion stack.
namestring	Name of the promotion stack.
category_idstring	Unique identifier of the category of the promotion stack.
campaignobject	Represents simplified promotion stack campaign data.Attributes Descriptionidstring Unique identifier of the campaign.
tiersobject	Contains the tier configuration. A promotion stack can include up to 30 tiers.Attributes Descriptionidsarray Contains the list of tiers in a pre-defined sequence. hierarchy_modestring Available values: MANUAL

Reward Assignment

All of:

1. Reward Assignment Base
2. Digital or Material Reward - Parameters

Customer Summary Redemptions

Attributes	Description
total_redeemedinteger	Total number of redemptions made by the customer.
total_failedinteger	Total number of redemptions that failed.
total_succeededinteger	Total number of redemptions that succeeded.
total_rolled_backinteger	Total number of redemptions that were rolled back for the customer.
total_rollback_failedinteger	Total number of redemption rollbacks that failed.
total_rollback_succeededinteger	Total number of redemption rollbacks that succeeded.
giftobject	Summary of gift card credits.Attributes Descriptionredeemed_amountinteger Total amount of gift card credits redeemed by customer. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for 100.00.


amount\_to\_gointeger 

Remaining gift card balance across all gift cards. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for 100.00.
loyalty_cardobject	Summary of loyalty points.Attributes Descriptionredeemed_pointsinteger Total number of loyalty points redeemed by the customer. points_to_gointeger Sum of remaining available point balance across all loyalty cards.

Customer Summary Orders

Attributes	Description
total_amountinteger	The total amount spent by the customer. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.
total_countinteger	Total number of orders made by the customer.
average_amountinteger	Average amount spent on orders. total_amount ÷ total_count. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.
last_order_amountinteger	Amount spent on last order. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.
last_order_datestring	Timestamp representing the date and time of the customer’s last order in ISO 8601 format.Example:2022-08-30T11:51:08.029Z

Campaign Loyalty Card

Attributes	Description
pointsinteger	The initial number of points to assign to the loyalty card. This is the current loyalty card score i.e. the number of loyalty points on the card.
expiration_rulesobject	Defines the loyalty point expiration rule. This expiration rule applies when there are no expiration_rules defined for an earning rule.Attributes Descriptionperiod_typestring Type of period. Can be set for MONTH or FIXED_DAY_OF_YEAR. MONTH requires the period_value field. FIXED_DAY_OF_YEAR requires the fixed_month and fixed_day fields. Available values: FIXED_DAY_OF_YEAR, MONTH period_valueinteger Value of the period. Required for the period_type: MONTH. rounding_typestring Type of rounding of the expiration period. Optional for the period_type: MONTH. Available values: END_OF_MONTH, END_OF_QUARTER, END_OF_HALF_YEAR, END_OF_YEAR, PARTICULAR_MONTH rounding_valueinteger Value of rounding of the expiration period. Required for the rounding_type. fixed_monthinteger Determines the month when the points expire; 1 is January, 2 is February, and so on. Required for the period_type: FIXED_DAY_OF_YEAR. fixed_dayinteger Determines the day of the month when the points expire. Required for the period_type: FIXED_DAY_OF_YEAR.

Code Config

Attributes	Description
lengthnumber	Number of characters in a generated code (excluding prefix and postfix).
charsetstring	Characters that can appear in the code.Examples:- Alphanumeric: 0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ

• Alphabetic: abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ
• Alphabetic Lowercase: abcdefghijklmnopqrstuvwxyz
• Alphabetic Uppercase: ABCDEFGHIJKLMNOPQRSTUVWXYZ
• Numbers: 0123456789
• Custom: a custom character set | | prefixstring | A text appended before the code. | | postfixstring | A text appended after the code. | | patternstring | A pattern for codes where hashes (#) will be replaced with random characters. Overrides length. | | initial_countinteger | Internal value, does not change anything if provided. |

Amount

Attributes	Description
typestring	Defines the type of the voucher.Available values: AMOUNT
amount_offnumber	Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000.
amount_off_formulastring	Formula used to dynamically calculate the discount.
aggregated_amount_limitinteger	Maximum discount amount per order.
effect	Defines how the discount is applied to the customer’s order.Discount Amount Vouchers Effect Types
is_dynamicboolean	Flag indicating whether the discount was calculated using a formula.

Unit

Attributes	Description
typestring	Discount type.Available values: UNIT
unit_offinteger	Number of units to be granted a full value discount.
unit_off_formulastring	Formula used to dynamically calculate the number of units.
effect	Defines how the unit is added to the customer’s order.Discount Unit Vouchers Effect Types
unit_typestring	The product deemed as free, chosen from product inventory (e.g. time, items).
product	Contains information about the product.Simple Product Discount Unit
sku	See: Simple Sku Discount Unit
is_dynamicboolean	Flag indicating whether the discount was calculated using a formula.

Unit Multiple

Attributes	Description
typestring	Discount type.Available values: UNIT
effectstring	Defines how the discount is applied to the customer’s order.Available values: ADD_MANY_ITEMS
unitsarray	Array of One Unit

Percent

Attributes	Description
typestring	Defines the type of the voucher.Available values: PERCENT
percent_offnumber	The percent discount that the customer will receive.
percent_off_formulastring	Formula used to dynamically calculate the discount.
amount_limitnumber	Upper limit allowed to be applied as a discount. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600.
aggregated_amount_limitinteger	Maximum discount amount per order.
effect	Defines how the discount is applied to the customer’s order.Discount Percent Vouchers Effect Types
is_dynamicboolean	Flag indicating whether the discount was calculated using a formula.

Fixed

Attributes	Description
typestring	Defines the type of the voucher.Available values: FIXED
fixed_amountnumber	Sets a fixed value for an order total or the item price. The value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000. If the fixed amount is calculated by the formula, i.e. the fixed_amount_formula parameter is present in the fixed amount definition, this value becomes the fallback value. As a result, if the formula cannot be calculated due to missing metadata, for example, this value will be used as the fixed value.
fixed_amount_formulastring	Formula used to dynamically calculate the discount.
effect	Defines how the discount is applied to the customer’s order.Discount Fixed Vouchers Effect Types
is_dynamicboolean	Flag indicating whether the discount was calculated using a formula.

Product

This is an object representing a product.

This entity should be used to map product items from your inventory management system. The aim of products is to build which reflect product-specific campaigns.

All of:

1. Product without Skus Object

2. Attributes	Description
   skus	See: Skus List For Product

SKU Object

Attributes	Description
idstring	A unique identifier that represents the SKU and is assigned by Voucherify.Example:sku_0b1621b319d248b79f
source_idstring, null	A unique SKU identifier from your inventory system.Example:sku_source_id_4
product_idstring	The parent product’s unique ID.Example:prod_0b15f6b9f650c16990
skustring, null	Unique user-defined SKU name.Example:Large Pink Shirt
priceinteger, null	Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as $100.00 being expressed as 10000.
currencystring, null	SKU price currency.Example:USD
attributesobject	The attributes object stores values for all custom attributes inherited by the SKU from the parent product. A set of key/value pairs that are attached to a SKU object and are unique to each SKU within a product family.
image_urlstring, null	The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image.
metadataobject	The metadata object stores all custom attributes assigned to the SKU. A set of key/value pairs that you can attach to a SKU object. It can be useful for storing additional information about the SKU in a structured format. It can be used to create product collections.
created_atstring	Timestamp representing the date and time when the SKU was created. The value is shown in the ISO 8601 format.Example:2022-05-17T10:36:30.187Z
updated_atstring, null	Timestamp representing the date and time when the SKU was updated. The value is shown in the ISO 8601 format.Example:2022-05-17T10:55:09.137Z
objectstring	The type of the object represented by JSON. This object stores information about the SKU.Available values: sku

Voucher Base

Attributes	Description
idstring	Assigned by the Voucherify API, identifies the voucher.Example:v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV
codestring	A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters.Example:WVPblOYX
campaignstring	A unique campaign name, identifies the voucher’s parent campaign.Example:Gift Card Campaign
campaign_idstring	Assigned by the Voucherify API, identifies the voucher’s parent campaign.Example:camp_FNYR4jhqZBM9xTptxDGgeNBV
categorystring	Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint.
category_idstring	Unique category ID assigned by Voucherify.Example:cat_0bb343dee3cdb5ec0c
typestring	Defines the type of the voucher.Available values: GIFT_VOUCHER, DISCOUNT_VOUCHER, LOYALTY_CARD
discount	See: Discount
giftobject	Object representing gift parameters. Child attributes are present only if type is GIFT_VOUCHER. Defaults to null.Attributes Descriptionamountinteger Total gift card income over the lifetime of the card. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for 100.00.

Example:

10000


subtracted\_amountinteger 

Total amount of subtracted credits over the gift card lifetime. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for 100.00. balanceinteger Available funds. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00. Example: 500 effectstring Defines how the credits are applied to the customer’s order. Available values: APPLY_TO_ORDER, APPLY_TO_ITEMS
loyalty_cardobject	Object representing loyalty card parameters. Child attributes are present only if type is LOYALTY_CARD. Defaults to null.Attributes Descriptionpointsinteger Total number of points added to the loyalty card over its lifespan. Example: 7000 balanceinteger Points available for reward redemption. This is calculated as follows: balance = points - expired_points - subtracted_points - redemption.redeemed_points. Example: 6970 next_expiration_datestring The next closest date when the next set of points are due to expire. Example: 2023-05-30 next_expiration_pointsinteger The amount of points that are set to expire next. pending_pointsinteger Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually. expired_pointsinteger Shows the total number of expired points over the lifetime of the loyalty card. subtracted_pointsinteger Shows the total number of subtracted points over the lifetime of the loyalty card.
start_datestring	Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date.Example:2021-12-01T00:00:00.000Z
expiration_datestring	Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date.Example:2021-12-31T00:00:00.000Z
validity_timeframe	See: Validity Timeframe
validity_day_of_week	See: Validity Day Of Week
validity_hours	See: Validity Hours
activeboolean, null	A flag to toggle the voucher on or off. You can disable a voucher even though it’s within the active period defined by the start_date and expiration_date.- true indicates an active voucher

• false indicates an inactive voucher | | additional_infostring | An optional field to keep any extra textual information about the code such as a code description and details. | | metadataobject | The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format. | | assets | See: Voucher Assets | | is_referral_codeboolean, null | Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM. | | created_atstring | Timestamp representing the date and time when the voucher was created. The value is shown in the ISO 8601 format.Example:2021-12-22T10:13:06.487Z | | updated_atstring | Timestamp representing the date and time when the voucher was last updated in ISO 8601 format.Example:2021-12-22T10:14:45.316Z | | holder_idstring | Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify.Example:cust_eWgXlBBiY6THFRJwX45Iakv4 | | referrer_idstring | Unique identifier of the referring person.Example:cust_Vzck5i8U3OhcEUFY6MKhN9Rv | | objectstring | The type of the object represented by JSON. Default is voucher. | | publishobject | Stores a summary of publication events: an event counter and endpoint to return details of each event. Publication is an assignment of a code to a customer, e.g. through a distribution.Attributes Descriptionobjectstring

  The type of the object represented is by default list. To get this list, you need to make a call to the endpoint returned in the url attribute.

  countinteger

  Publication events counter.

  Example:

  0

  urlstring

  The endpoint where this list of publications can be accessed using a GET method. /v1/vouchers/{voucher_code}/publications

  Example:

  /v1/vouchers/WVPblOYX/publications?page=1&limit=10 | | redemptionobject | Stores a summary of redemptions that have been applied to the voucher.Attributes Descriptionquantityinteger

  How many times a voucher can be redeemed. A null value means unlimited.

  redeemed_quantityinteger

  How many times a voucher has already been redeemed.

  Example:

  1

  redeemed_pointsinteger

  Total loyalty points redeemed.

  Example:

  100000

  objectstring

  The type of the object represented is by default list. To get this list, you need to make a call to the endpoint returned in the url attribute.

  urlstring

  The endpoint where this list of redemptions can be accessed using a GET method. /v1/vouchers/{voucher_code}/redemptions

  Example:

  /v1/vouchers/WVPblOYX/redemptions?page=1&limit=10 |

Validation Rules Assignments List

Attributes	Description
objectstring	The type of the object represented by JSON. This object stores information about validation rules assignments.Available values: list
data_refstring	Identifies the name of the attribute that contains the array of validation rules assignments.Available values: data
dataarray	Contains array of validation rules assignments.Array of Business Validation Rule Assignment
totalinteger	Total number of validation rules assignments.

Validity Timeframe

Attributes	Description
durationstring	Defines the amount of time an earning rule will be active in ISO 8601 format. For example, an earning rule with a duration of PT1H will be valid for a duration of one hour.Example:PT1H
intervalstring	Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, an earning rule with an interval of P2D will be valid every other day.Example:P2D

Validity Day Of Week

Integer array corresponding to the particular days of the week in which the voucher is valid.

• 0 Sunday
• 1 Monday
• 2 Tuesday
• 3 Wednesday
• 4 Thursday
• 5 Friday
• 6 Saturday

Validity Hours

Attributes

Description

dailyarray

Defines the reccuring period(s) when the resource is active. The periods should not overlap.Array of:Attributes Descriptionstart_timestring Defines the starting hour of validity in the HH:mm format. The resource is inactive before this time. Example: 12:00 days_of_weekarray Integer array corresponding to the particular days of the week in which the resource is valid. 0 Sunday 1 Monday 2 Tuesday 3 Wednesday 4 Thursday 5 Friday 6 Saturday expiration_timestring Defines the ending hour of validity in the HH:mm format. The resource is inactive after this time. Example: 14:00

Validation Rule Assignments List

Attributes	Description
objectstring	The type of the object represented by JSON. This object stores information about validation rule assignments.
data_refstring	Identifies the name of the JSON property that contains the array of validation rule assignments.
dataarray	A dictionary that contains an array of validation rule assignments.Array of Validation Rule Assignment
totalinteger	Total number of validation rule assignments.

Digital

Attributes

Description

campaignobject

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
coinobject	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
productobject	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

MappingPoints

One of:

MappingMultiply, MappingFixed

Define fixed amount of points

Attributes	Description
typestring	The number of points to be added to the loyalty card.Available values: FIXED
pointsinteger	Defines how the points will be added to the loyalty card. FIXED adds a fixed number of points.
points_formulastring	Formula used to dynamically calculate the rewarded points.

Calculate points proportionally

One of:

Define amount of points proportional to the order, Define amount of points proportional to order items, Define amount of points proportional to customer metadata, Earning Rule Proportional Custom Event

Earning Rule Event

Earning Rule Expiration Rules

Attributes	Description
period_typestring	Type of period. Can be set for MONTH or FIXED_DAY_OF_YEAR. MONTH requires the period_value field. FIXED_DAY_OF_YEAR requires the fixed_month and fixed_day fields.Available values: FIXED_DAY_OF_YEAR, MONTH
period_valueinteger	Value of the period. Required for the period_type: MONTH.
rounding_typestring	Type of rounding of the expiration period. Optional for the period_type: MONTH.Available values: END_OF_MONTH, END_OF_QUARTER, END_OF_HALF_YEAR, END_OF_YEAR, PARTICULAR_MONTH
rounding_valueinteger	Value of rounding of the expiration period. Required for the rounding_type.
fixed_monthinteger	Determines the month when the points expire; 1 is January, 2 is February, and so on. Required for the period_type: FIXED_DAY_OF_YEAR.
fixed_dayinteger	Determines the day of the month when the points expire. Required for the period_type: FIXED_DAY_OF_YEAR.

Reward Assignment Base

Attributes	Description
idstring	Unique reward assignment ID, assigned by Voucherify.Example:rewa_PbIRoMXpwe5QhobW4JKu0VjH
reward_idstring	Associated reward ID.Example:rew_C7wS9eHFDN4CIbXI5PpLSkGY
created_atstring	Timestamp representing the date and time when the reward assignment was created. The value is shown in the ISO 8601 format.Example:2022-08-11T14:49:22.586Z
updated_atstring, null	Timestamp representing the date and time when the reward assignment was updated. The value is shown in the ISO 8601 format.Example:2022-08-11T16:01:34.885Z
objectstring	The type of the object represented by the JSON. This object stores information about the reward assignment.Available values: reward_assignment
related_object_idstring	Related object ID to which the reward was assigned.Example:camp_wciTvaOfYmAa3EmIIW3QpXXZ
related_object_typestring	Related object type to which the reward was assigned.Available values: campaign

Digital or Material Reward - Parameters

Attributes

Description

parametersobject

Defines the cost of the reward.Attributes Descriptionloyaltyobject Defines the equivalent points value of the reward. Attributes Descriptionpointsinteger The number of points required to redeem the reward. auto_redeemboolean, null Determines if the reward is redeemed automatically when the customer reaches the sufficient number of points to redeem it. Value true means that the automatic reward redemption is active. Only one reward can be set to be redeemed automatically in a loyalty campaign, i.e. only one can have the value true.

Discount Amount Vouchers Effect Types

Available values: APPLY_TO_ORDER, APPLY_TO_ITEMS, APPLY_TO_ITEMS_PROPORTIONALLY, APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY, APPLY_TO_ITEMS_BY_QUANTITY

Discount Unit Vouchers Effect Types

Available values: ADD_MISSING_ITEMS, ADD_NEW_ITEMS, ADD_MANY_ITEMS

Simple Product Discount Unit

Attributes	Description
idstring	Unique product ID, assigned by Voucherify.
source_idstring	Product’s source ID.
namestring	Product name.

Simple Sku Discount Unit

Attributes	Description
idstring	Unique SKU ID, assigned by Voucherify.
source_idstring	Product variant’s source ID.
namestring	Sku name

One Unit

Attributes	Description
unit_offnumber	Number of units to be granted a full value discount.
unit_off_formulastring	Formula used to dynamically calculate the number of units.
effectstring	Defines how the unit is added to the customer’s order.Available values: ADD_NEW_ITEMS, ADD_MISSING_ITEMS
unit_typestring	The product deemed as free, chosen from product inventory (e.g. time, items).
product	Contains information about the product.Simple Product Discount Unit
sku	Contains information about the sku.Simple Sku Discount Unit

Discount Percent Vouchers Effect Types

Available values: APPLY_TO_ORDER, APPLY_TO_ITEMS

Discount Fixed Vouchers Effect Types

Available values: APPLY_TO_ORDER, APPLY_TO_ITEMS

Product without Skus Object

Attributes	Description
idstring	Unique product ID assigned by Voucherify.Example:prod_0b1da8105693710357
source_idstring, null	Unique product source ID.Example:productSourceID16
namestring, null	Unique user-defined product name.Example:T-shirt
priceinteger, null	Unit price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as $100.00 being expressed as 10000.
attributesarray	A list of product attributes whose values you can customize for given SKUs: ["color","size","ranking"]. Each child SKU can have a unique value for a given attribute.
metadataobject	The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format. It can be used to create product collections.
image_urlstring, null	The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image.Example:https://images.com/original.jpg
created_atstring	Timestamp representing the date and time when the product was created. The value is shown in the ISO 8601 format.Example:2022-05-23T06:52:55.008Z
updated_atstring, null	Timestamp representing the date and time when the product was updated. The value is shown in the ISO 8601 format.Example:2022-05-23T09:24:07.405Z
objectstring	The type of the object represented by JSON. This object stores information about the product.Available values: product

Skus List For Product

Attributes	Description
objectstring	The type of the object represented by JSON. This object stores information about SKUs.
data_refstring	Identifies the name of the JSON property that contains the array of SKUs.
dataarray	A dictionary that contains an array of SKUs.Array of SKU Object
totalinteger	Total number of SKUs in the product.

Voucher Assets

Attributes	Description
qrobject	Stores Quick Response (QR) representation of encrypted code.Attributes Descriptionidstring Encrypted voucher code ID. Example: U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK+t4pp7U7oFzjGJzj9q/bmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg+BaZk5QwXMf8k/OzSlOEVybpwSq+AiqPoNtjeuqtIgkDyvT6Q== urlstring URL to QR code Optional: Attach query parameters to base URL to customize the image of the encrypted voucher code. size: integer value from 1 to 100 format: string, either png (default) or svg Example: https://dev.dl.voucherify.io/api/v1/assets/qr/U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK%2Bt4pp7U7oFzjGJzj9q%2FbmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg%2BBaZk5QwXMf8k%2FOzSlOEVybpwSq%2BAiqPoNtjeuqtIgkDyvT6Q%3D%3D
barcodeobject	Stores barcode representation of encrypted code.Attributes Descriptionidstring Encrypted voucher code ID. Example: U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ== urlstring URL to barcode Optional: Attach query parameters to base URL to customize the image of the encrypted voucher code. size: integer value from 1 to 100 format: string, either png (default) or svg Example: https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D

Business Validation Rule Assignment

Attributes	Description
idstring	The unique identifier for a assignment
rule_idstring	The unique identifier for a rule
related_object_idstring	The unique identifier for a related object
related_object_typestring	The type of related object
created_atstring	Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format.Example:2022-03-09T11:19:04.819Z
updated_atstring	Timestamp representing the date and time when the object was last updated in ISO 8601 format.Example:2022-03-09T11:19:04.819Z
objectstring	The type of the object represented by JSON.Available values: validation_rules_assignment
validation_statusstring	The validation status of the assignmentAvailable values: VALID, PARTIALLY_VALID, INVALID
validation_omitted_rulesarray	The list of omitted rules

Validation Rule Assignment

Attributes	Description
idstring	Validation rule assignment ID.Example:asgm_74F7QZoYbUoljwQO
rule_idstring	Validation rule ID.Example:val_4j7DCRm2IS59
related_object_idstring	The resource ID to which the validation rule was assigned.Example:v_JtWunK6jUo7X2qOFj0SyRHq4p9tgENlT
related_object_typestring	The type of resource to which the validation rule was assigned.Available values: voucher, campaign, earning_rule, reward_assignment, promotion_tier, distribution
created_atstring	Timestamp representing the date and time when the validation rule assignment was created. The value is shown in the ISO 8601 format.Example:2022-02-17T08:18:15.085Z
objectstring	The type of the object represented by the ID.Available values: validation_rules_assignment

MappingMultiply

Attributes	Description
typestring	Type of calculation.Available values: MULTIPLY
multipliernumber	Multiplication factor used to multiply the points to obtain the mapped points.

MappingFixed

Attributes	Description
typestring	Type of calculation.Available values: CUSTOM
pointsinteger	Fixed number of points to be applied.

Define amount of points proportional to the order

One of:

Order Amount, Order Total Amount, Order Metadata

Define amount of points proportional to order items

One of:

Order Items Quantity, Order Items Amount, Order Items Subtotal Amount

Define amount of points proportional to customer metadata

Attributes	Description
typestring	Defines how the points will be added to the loyalty card.PROPORTIONAL adds points based on a pre-defined ratio.Available values: PROPORTIONAL
calculation_typestring	CUSTOMER_METADATA: Customer Metadata (X points for every Y in metadata attribute, defined in the property key under the customer.metadata object)Available values: CUSTOMER_METADATA
customerobject	Attributes Descriptionmetadataobject Defines the ratio based on the property defined in the calculation_type parameter. For every given increment of value (1, 10, etc) defined in the every parameter for the property defined in calculation_type, give the customer the number of points defined in the points parameter. In other words, for every order metadata property value, give points. Attributes Descriptioneveryinteger For how many increments of the customer metadata property to grant points for. pointsinteger Number of points to be awarded, i.e. how many points to be added to the loyalty card. points_formulastring Formula used to dynamically calculate the rewarded points. propertystring Customer metadata property.

Earning Rule Proportional Custom Event

Attributes	Description
typestring	Defines how the points will be added to the loyalty card.PROPORTIONAL adds points based on a pre-defined ratio.Available values: PROPORTIONAL
calculation_typestring	CUSTOM_EVENT_METADATA: Custom event metadata (X points for every Y in metadata attribute).Available values: CUSTOM_EVENT_METADATA
custom_eventobject	Attributes Descriptionmetadataobject Defines the ratio based on the property defined in the calculation_type parameter. For every given increment of value (1, 10, etc) defined in the every parameter for the property defined in calculation_type, give the customer the number of points defined in the points parameter. In other words, for every order metadata property value, give points. Attributes Descriptioneveryinteger For how many increments of the customer metadata property to grant points for. pointsinteger Number of points to be awarded, i.e. how many points to be added to the loyalty card. points_formulastring Formula used to dynamically calculate the rewarded points. propertystring Custom event metadata property.

Order Amount

Attributes	Description
typestring	Defines how the points will be added to the loyalty card.PROPORTIONAL adds points based on a pre-defined ratio.Available values: PROPORTIONAL
calculation_typestring	ORDER_AMOUNT: Pre-discount order amount (X points for every Y spent excluding discounts)Available values: ORDER_AMOUNT
orderobject	Attributes Descriptionamountobject Defines the ratio based on the property defined in the calculation_type parameter. For every set of value (1, 10, etc) defined in the every parameter for the property defined in calculation_type, give the customer the number of points defined in the points parameter. In other words, for every calculation_type, give points. Attributes Descriptioneveryinteger Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 order amount is written as 1000. pointsinteger Number of points to be awarded, i.e. how many points to be added to the loyalty card. points_formulastring Formula used to dynamically calculate the rewarded points.

Order Total Amount

Attributes	Description
typestring	Defines how the points will be added to the loyalty card.PROPORTIONAL adds points based on a pre-defined ratio.Available values: PROPORTIONAL
calculation_typestring	ORDER_TOTAL_AMOUNT: Total order amount (X points for every Y spent including discount)Available values: ORDER_TOTAL_AMOUNT
orderobject	Attributes Descriptiontotal_amountobject Defines the ratio based on the property defined in the calculation_type parameter. For every set of value (1, 10, etc) defined in the every parameter for the property defined in calculation_type, give the customer the number of points defined in the points parameter. In other words, for every calculation_type, give points. Attributes Descriptioneveryinteger Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 order amount is written as 1000. pointsinteger Number of points to be awarded, i.e. how many points to be added to the loyalty card. points_formulastring Formula used to dynamically calculate the rewarded points.

Order Metadata

Attributes	Description
typestring	Defines how the points will be added to the loyalty card.PROPORTIONAL adds points based on a pre-defined ratio.Available values: PROPORTIONAL
calculation_typestring	ORDER_METADATA: Order Metadata (X points for every Y in metadata attribute, defined in the property key under the order.metadata object)Available values: ORDER_METADATA
orderobject	Defines the formula for calculating points proportionally.Attributes Descriptionmetadataobject Defines the ratio based on the property defined in the calculation_type parameter. For every given increment of value (1, 10, etc) defined in the every parameter for the property defined in calculation_type, give the customer the number of points defined in the points parameter. In other words, for every order metadata property value, give points. Attributes Descriptioneveryinteger For how many increments of the order metadata property to grant points for. pointsinteger Number of points to be awarded, i.e. how many points to be added to the loyalty card. points_formulastring Formula used to dynamically calculate the rewarded points. propertystring Order metadata property.

Order Items Quantity

Attributes	Description
typestring	Defines how the points will be added to the loyalty card.PROPORTIONAL adds points based on a pre-defined ratio.Available values: PROPORTIONAL
calculation_typestring	ORDER_ITEMS_QUANTITY: Quantity of items defined in the order_items.quantity.applicable_to array or order_items.quantity.object & .id (X points for every Y items excluding free items).Available values: ORDER_ITEMS_QUANTITY
order_itemsobject	Attributes Descriptionquantityobject Defines the ratio based on the property defined in the calculation_type parameter. For every set of value (1, 10, etc) defined in the every parameter for the property defined in calculation_type, give the customer the number of points defined in the points parameter. In other words, for every calculation_type, give points. Attributes Descriptioneveryinteger Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 order amount is written as 1000. pointsinteger Number of points to be awarded, i.e. how many points to be added to the loyalty card. points_formulastring Formula used to dynamically calculate the rewarded points. objectstring Type of object which will be covered by the earning rule. This is required together with id. Can be replaced by the applicable_to array. In response, the value of the first object is returned even if applicable_to array was used. Available values: products_collection, product, sku idstring Unique ID of the resource assigned by Voucherify. This is required together with object. Can be replaced by the applicable_to array. In response, the value of the first object is returned even if applicable_to array was used. Values are, for example, pc_75U0dHlr7u75BJodrW1AE3t6 for product collection, prod_0bae32322150fd0546 for a product, or sku_0b7d7dfb090be5c619 for a SKU. applicable_toarray Defines products, SKUs, or product collections covered by the earning rule. Can be replaced by object and id to define only one object. Array of: Attributes Descriptionobjectstring Type of object which will be covered by the earning rule. Available values: products_collection, product, sku idstring Unique ID of the resource assigned by Voucherify. Values are, for example, pc_75U0dHlr7u75BJodrW1AE3t6 for product collection, prod_0bae32322150fd0546 for a product, or sku_0b7d7dfb090be5c619 for a SKU.

Order Items Amount

Attributes	Description
typestring	Defines how the points will be added to the loyalty card.PROPORTIONAL adds points based on a pre-defined ratio.Available values: PROPORTIONAL
calculation_typestring	ORDER_ITEMS_AMOUNT; Pre-discount amount spent on items defined in the order_items.quantity.applicable_to array or order_items.quantity.object & .id (X points for every Y spent on items excluding discounts)Available values: ORDER_ITEMS_AMOUNT
order_itemsobject	Attributes Descriptionamountobject Defines the ratio based on the property defined in the calculation_type parameter. For every set of value (1, 10, etc) defined in the every parameter for the property defined in calculation_type, give the customer the number of points defined in the points parameter. In other words, for every calculation_type, give points. Attributes Descriptioneveryinteger Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 order amount is written as 1000. pointsinteger Number of points to be awarded, i.e. how many points to be added to the loyalty card. points_formulastring Formula used to dynamically calculate the rewarded points. objectstring Type of object which will be covered by the earning rule. This is required together with id. Can be replaced by the applicable_to array. In response, the value of the first object is returned even if applicable_to array was used. Available values: products_collection, product, sku idstring Unique ID of the resource assigned by Voucherify. This is required together with object. Can be replaced by the applicable_to array. In response, the value of the first object is returned even if applicable_to array was used. Values are, for example, pc_75U0dHlr7u75BJodrW1AE3t6 for product collection, prod_0bae32322150fd0546 for a product, or sku_0b7d7dfb090be5c619 for a SKU. applicable_toarray Defines products, SKUs, or product collections covered by the earning rule. Can be replaced by object and id to define only one object. Array of: Attributes Descriptionobjectstring Type of object which will be covered by the earning rule. Available values: products_collection, product, sku idstring Unique ID of the resource assigned by Voucherify. Values are, for example, pc_75U0dHlr7u75BJodrW1AE3t6 for product collection, prod_0bae32322150fd0546 for a product, or sku_0b7d7dfb090be5c619 for a SKU.

Order Items Subtotal Amount

Attributes	Description
typestring	Defines how the points will be added to the loyalty card.PROPORTIONAL adds points based on a pre-defined ratio.Available values: PROPORTIONAL
calculation_typestring	ORDER_ITEMS_SUBTOTAL_AMOUNT; Amount spent on items defined in the order_items.subtotal_amount.object & .id (X points for every Y spent on items including discounts)Available values: ORDER_ITEMS_SUBTOTAL_AMOUNT
order_itemsobject	Attributes Descriptionsubtotal_amountobject Defines the ratio based on the property defined in the calculation_type parameter. For every set of value (1, 10, etc) defined in the every parameter for the property defined in calculation_type, give the customer the number of points defined in the points parameter. In other words, for every calculation_type, give points. Attributes Descriptioneveryinteger Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 order amount is written as 1000. pointsinteger Number of points to be awarded, i.e. how many points to be added to the loyalty card. points_formulastring Formula used to dynamically calculate the rewarded points. objectstring Type of object which will be covered by the earning rule. This is required together with id. Can be replaced by the applicable_to array. In response, the value of the first object is returned even if applicable_to array was used. Available values: products_collection, product, sku idstring Unique ID of the resource assigned by Voucherify. This is required together with object. Can be replaced by the applicable_to array. In response, the value of the first object is returned even if applicable_to array was used. Values are, for example, pc_75U0dHlr7u75BJodrW1AE3t6 for product collection, prod_0bae32322150fd0546 for a product, or sku_0b7d7dfb090be5c619 for a SKU. applicable_toarray Defines products, SKUs, or product collections covered by the earning rule. Can be replaced by object and id to define only one object. Array of: Attributes Descriptionobjectstring Type of object which will be covered by the earning rule. Available values: products_collection, product, sku idstring Unique ID of the resource assigned by Voucherify. Values are, for example, pc_75U0dHlr7u75BJodrW1AE3t6 for product collection, prod_0bae32322150fd0546 for a product, or sku_0b7d7dfb090be5c619 for a SKU.