Customer Activity

Attributes Description

id
string

Unique event ID, assigned by Voucherify.

Example: evcus\_0c150c51730c6b60b1

type
string

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

data
object

Contains details about the event. The objects that are returned in the data attribute differ based on the context of the event type.

Attributes	Description
data	See: Customer Activity Data
event\_source	See: Event Source

created\_at
string

Timestamp representing the date and time when the customer activity occurred in ISO 8601 format.

Example: 2022-08-30T09:14:07.660Z

group\_id
string

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

channel
string

Determines the channel that initiated the event.

Available values: USER\_PORTAL, API, CLIENT\_API, INTERNAL

Example: API

user
object

Determines the Voucherify user who triggered the event.

Attributes Description

id
string

Unique identifier of the user.

Example: user\_xyzfghSTprSTUVWXYlk6tuvXYst7FGH7

api\_key
object

Determines the API key used to initiate the event.

Attributes Description

name
string

Channel name in the application keys.

app\_id
string

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\_customer
object

Attributes	Description
id `string`	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

referral
object, null

Details about the referral.

Attributes	Description
referrer	Details about the referrer. Simple Customer
voucher	Details about the referral code. Simple Voucher
campaign	Details about the referral campaign. Simple Campaign

loyalty
object, null

Details about the loyalty activity.

Attributes	Description
voucher	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

balance
object, 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	Description
amount `integer`
points `integer`

custom\_event

See: Custom Event

customer\_event
object, null

Attributes	Description
segment	See: Simple Segment
event\_type `string`	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:

Order Calculated No Customer Data

Attributes	Description
items `array`	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:

Voucher Transaction Base

Attributes Description

details
object

Contains the detailed information about the transaction.

Attributes Description

balance

See: Voucher Balance

order
object

Contains information about the original order.

Attributes	Description
id `string`	Unique order ID.
source\_id `string`	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.

event
object

Contains information about the event that triggers the point accrual.

Attributes	Description
id `string`	Unique event ID.
type `string`	Type of event.

earning\_rule
object

Contains information about the earning rule.

Attributes Description

id
string

Unique identifier of an earning rule, assigned by Voucherify.

source
object

Contains the custom earning rule name.

Attributes	Description
banner `string`	Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard.

segment
object

Contains information about the segment.

Attributes	Description
id `string`
name `string`

loyalty\_tier
object

Contains information about the loyalty tier.

Attributes	Description
id `string`	Unique identifier of the loyalty tier, assigned by Voucherify.
name `string`	User-defined name of the loyalty tier.

redemption
object

Contains information about the original redemption.

Attributes	Description
id `string`	Unique redemption ID.

rollback
object

Contains information about the redemption rollback.

Attributes	Description
id `string`	Unique redemption rollback ID.

custom\_event
object

Contains information about the custom event that triggers the point accrual.

Attributes	Description
id `string`	Unique event ID.
type `string`	Type of custom event.

event\_schema
object

Contains information about the custom event metadata schema.

Attributes	Description
id `string`	Unique metadata schema ID.
name `string`	Type of custom event.

reward
object

Contains information about the pay with points reward.

Attributes	Description
id `string`	Unique reward ID.
name `string`	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
string

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:

Voucher Transaction Base

Attributes Description

details
object

Contains the detailed information about the transaction.

Attributes Description

balance

See: Voucher Balance

order
object

Contains information about the original order.

Attributes	Description
id `string`	Unique order ID.
source\_id `string`	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.

event
object

Contains information about the event that triggers the point accrual.

Attributes	Description
id `string`	Unique event ID.
type `string`	Type of event.

earning\_rule
object

Contains information about the earning rule.

Attributes Description

id
string

Unique identifier of an earning rule, assigned by Voucherify.

source
object

Contains the custom earning rule name.

Attributes	Description
banner `string`	Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard.

segment
object

Contains information about the segment.

Attributes	Description
id `string`
name `string`

loyalty\_tier
object

Contains information about the loyalty tier.

Attributes	Description
id `string`	Unique identifier of the loyalty tier, assigned by Voucherify.
name `string`	User-defined name of the loyalty tier.

redemption
object

Contains information about the original redemption.

Attributes	Description
id `string`	Unique redemption ID.

rollback
object

Contains information about the redemption rollback.

Attributes	Description
id `string`	Unique redemption rollback ID.

custom\_event
object

Contains information about the custom event that triggers the point accrual.

Attributes	Description
id `string`	Unique event ID.
type `string`	Type of custom event.

holder\_loyalty\_tier
object

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	Description
id `string`	Unique identifier of the loyalty tier, assigned by Voucherify.
name `string`	User-defined name of the loyalty tier.

event\_schema
object

Contains information about the custom event metadata schema.

Attributes	Description
id `string`	Unique metadata schema ID.
name `string`	Type of custom event.

reward
object

Contains information about the pay with points reward.

Attributes	Description
id `string`	Unique reward ID.
name `string`	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
string

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:

Voucher Transaction Base

Attributes Description

details
object

Contains the detailed information about the transaction.

Attributes Description

balance

See: Voucher Balance

order
object

Contains information about the original order.

Attributes	Description
id `string`	Unique order ID.
source\_id `string`	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.

event
object

Contains information about the event that triggers the point accrual.

Attributes	Description
id `string`	Unique event ID.
type `string`	Type of event.

earning\_rule
object

Contains information about the earning rule.

Attributes Description

id
string

Unique identifier of an earning rule, assigned by Voucherify.

source
object

Contains the custom earning rule name.

Attributes	Description
banner `string`	Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard.

segment
object

Contains information about the segment.

Attributes	Description
id `string`
name `string`

loyalty\_tier
object

Contains information about the loyalty tier.

Attributes	Description
id `string`	Unique identifier of the loyalty tier, assigned by Voucherify.
name `string`	User-defined name of the loyalty tier.

redemption
object

Contains information about the original redemption.

Attributes	Description
id `string`	Unique redemption ID.

rollback
object

Contains information about the redemption rollback.

Attributes	Description
id `string`	Unique redemption rollback ID.

custom\_event
object

Contains information about the custom event that triggers the point accrual.

Attributes	Description
id `string`	Unique event ID.
type `string`	Type of custom event.

event\_schema
object

Contains information about the custom event metadata schema.

Attributes	Description
id `string`	Unique metadata schema ID.
name `string`	Type of custom event.

holder\_loyalty\_tier
object

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	Description
id `string`	Unique identifier of the loyalty tier, assigned by Voucherify.
name `string`	User-defined name of the loyalty tier.

reward
object

Contains information about the pay with points reward.

Attributes	Description
id `string`	Unique reward ID.
name `string`	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
string

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

points
integer

The number of expired points.

buckets
array

Array of Loyalty Point Bucket

transaction

All of:

Voucher Transaction Base

Attributes Description

details
object

Contains the detailed information about the transaction.

Attributes Description

balance

See: Voucher Balance

order
object

Contains information about the original order.

Attributes	Description
id `string`	Unique order ID.
source\_id `string`	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.

event
object

Contains information about the event that triggers the point accrual.

Attributes	Description
id `string`	Unique event ID.
type `string`	Type of event.

earning\_rule
object

Contains information about the earning rule.

Attributes Description

id
string

Unique identifier of an earning rule, assigned by Voucherify.

source
object

Contains the custom earning rule name.

Attributes	Description
banner `string`	Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard.

segment
object

Contains information about the segment.

Attributes	Description
id `string`
name `string`

loyalty\_tier
object

Contains information about the loyalty tier.

Attributes	Description
id `string`	Unique identifier of the loyalty tier, assigned by Voucherify.
name `string`	User-defined name of the loyalty tier.

redemption
object

Contains information about the original redemption.

Attributes	Description
id `string`	Unique redemption ID.

rollback
object

Contains information about the redemption rollback.

Attributes	Description
id `string`	Unique redemption rollback ID.

custom\_event
object

Contains information about the custom event that triggers the point accrual.

Attributes	Description
id `string`	Unique event ID.
type `string`	Type of custom event.

event\_schema
object

Contains information about the custom event metadata schema.

Attributes	Description
id `string`	Unique metadata schema ID.
name `string`	Type of custom event.

holder\_loyalty\_tier
object

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	Description
id `string`	Unique identifier of the loyalty tier, assigned by Voucherify.
name `string`	User-defined name of the loyalty tier.

reward
object

Contains information about the pay with points reward.

Attributes	Description
id `string`	Unique reward ID.
name `string`	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
string

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:

Event Customer Redemption

Attributes	Description
redemption\_rollback	See: Simple Redemption

Event Customer Redemption Rollback Failed

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

All of:

Event Customer Redemption

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
loyalty `object`
created\_at `string`	Example: 2022-02-25T13:32:08.734Z

Event Customer Loyalty Tier Upgraded

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

All of:

Event Customer Loyalty Tier Base

Loyalty Tier Upgraded

Attributes	Description
loyalty\_tier\_from	See: Loyalty Tier
loyalty\_tier\_to	See: Loyalty Tier
created\_at `string`	Example: 2022-02-25T13:32:08.734Z

Event Customer Loyalty Tier Downgraded

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

All of:

Event Customer Loyalty Tier Base

Loyalty Tier Downgraded

Attributes	Description
loyalty\_tier\_from	See: Loyalty Tier
loyalty\_tier\_to	See: Loyalty Tier
created\_at `string`	Example: 2022-02-25T13:32:08.734Z

Event Customer Loyalty Tier Prolonged

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

All of:

Event Customer Loyalty Tier Base

Loyalty Tier Prolonged

Attributes	Description
loyalty\_tier	See: Loyalty Tier
created\_at `string`	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:

Event Customer Loyalty Tier Base

Loyalty Tier Expiration Changed

Attributes	Description
loyalty\_tier	See: Loyalty Tier
created\_at `string`	Example: 2022-02-25T13:32:08.734Z
expiration\_date `string`	Example: 2022-02-25T13:32:08.734Z

Event Customer Loyalty Tier Joined

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

All of:

Event Customer Loyalty Tier Base

Loyalty Tier Joined

Attributes	Description
loyalty\_tier	See: Loyalty Tier
created\_at `string`	Example: 2022-02-25T13:32:08.734Z

Event Customer Loyalty Tier Left

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

All of:

Event Customer Loyalty Tier Base

Loyalty Tier Left

Attributes	Description
loyalty\_tier	See: Loyalty Tier
created\_at `string`	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:

Customer Response Data

Attributes Description

id
string

The ID of an existing customer that will be linked to redemption in this request.

source\_id
string

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\_metadata
object

Object used to store system metadata information.

created\_at
string

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\_at
string

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

assets
object

Contains information about the customer's cockpit.

⚠️ Warning: Customer cockpits were removed. The customer cockpit URLs redirect to customer preference center.

Attributes	Description
cockpit\_url `string`	URL address to customer preference center. Previously, a customer's cockpit URL address.
cockpit\_preference\_center\_url `string`	URL address to customer preference center.

object
string

The type of the object represented by JSON.

Available values: customer

Customer Base

Simple Customer

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

Simple Campaign

Attributes	Description
id `string`	Campaign ID.
name `string`	Campaign name.
campaign\_type `string`	Type of campaign.
type `string`	Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of generic (standalone) vouchers. `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 vouchers Available values: `AUTO\_UPDATE`, `STATIC`, `STANDALONE`
is\_referral\_code `boolean`	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\_join `boolean`	Indicates whether customers will be able to auto-join the campaign if any earning rule is fulfilled.
join\_once `boolean`	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.
active `boolean`	Indicates whether the campaign is active.
category\_id `string`, `null`	The unique category ID that this campaign belongs to.
category `string`	Unique category name.
categories `array`	Contains details about the category. Array of Category
metadata `object`	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\_date `string`	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\_date `string`	Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date. Example: 2022-09-30T00:00:00.000Z
description `string`	An optional field to keep extra textual information about the campaign such as a campaign description and details.
created\_at `string`	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\_at `string`	Timestamp representing the date and time when the campaign was updated in the ISO 8601 format. Example: 2024-01-01T11:11:11.111Z
object `string`	The type of the object represented by JSON. This object stores information about the campaign. Available values: `campaign`

Simple Voucher

Attributes Description

id
string

A unique identifier that represents the voucher assigned by Voucherify.

code
string

Voucher code.

gift

Gift object response.

Gift

discount

See: Discount

loyalty\_card
object

Defines the loyalty card details.

Simple Loyalty Card

type
string

Type of the voucher.

Available values: DISCOUNT\_VOUCHER, LOYALTY\_CARD, GIFT\_VOUCHER

campaign
string

Campaign name.

campaign\_id
string

Campaign unique ID.

is\_referral\_code
boolean

Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL\_PROGRAM.

holder\_id
string

Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify.

Example: cust\_eWgXlBBiY6THFRJwX45Iakv4

referrer\_id
string

Unique identifier of the referrer assigned by Voucherify.

Example: cust\_nM4jqPiaXUvQdVSA6vTRUnix

category\_id
string, null

Unique identifier of the category that this voucher belongs to.

Example: cat\_0b6152ce12414820dc

categories
array

Contains details about the category.

Array of Category

active
boolean

Shows whether the voucher is on or off. true indicates an active voucher and false indicates an inactive voucher.

created\_at
string

Timestamp representing the date and time when the order was created in the ISO 8601 format.

Example: 2021-12-22T10:13:06.487Z

updated\_at
string

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

redemption
object

Defines the redemption limits on vouchers.

Attributes Description

quantity
integer, null

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

redeemed\_quantity
integer

How many times a voucher has already been redeemed.

Example: 1

redeemed\_points
integer

Total loyalty points redeemed.

start\_date
string

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\_date
string

Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date.

Example: 2021-12-31T00:00:00.000Z

metadata
object

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.

object
string

The type of the object represented by JSON.

Available values: voucher

Custom Event

Attributes Description

id
string

Unique custom event ID.

object
string

The object represented is an event.

Available values: event

type
string

The event name.

customer

A simple customer object

Customer Object Required Object Type

referral
object

Referral object.

Attributes Description

referrer\_id
string

Unique referrer ID.

Example: cust\_nM4jqPiaXUvQdVSA6vTRUnix

code
string

Voucher code.

id
string

Unique voucher ID.

loyalty
object

Loyalty object.

Attributes	Description
code `string`	Loyalty card code.

metadata
object

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\_at
string

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

id
string

Unique redemption ID.

Example: r\_0bc92f81a6801f9bca

object
string

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

created\_at
string

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\_id
string

Hashed customer source ID.

metadata
object

The metadata object stores all custom attributes assigned to the redemption.

channel\_type
string

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\_id
string

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\_code
string

If the result is FAILURE, this parameter will provide a generic reason as to why the redemption failed.

Example: customer\_rules\_violated

failure\_message
string

If the result is FAILURE, this parameter will provide a more expanded reason as to why the redemption failed.

order

All of:

Order Calculated No Customer Data

Attributes	Description
items `array`	Array of items applied to the order. It can include up to 500 items. Array of Order Item Calculated

previous\_order

All of:

Order Calculated No Customer Data

Attributes	Description
items `array`	Array of items applied to the order. It can include up to 500 items. Array of Order Item Calculated

reward

See: Redemption Reward Result

amount
integer

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

reason
string

System generated cause for the redemption being invalid in the context of the provided parameters.

result
string

Redemption result.

Available values: SUCCESS, FAILURE

status
string

Redemption status.

Available values: SUCCEEDED, FAILED

related\_redemptions
object

Attributes Description

rollbacks
array

Array of:

Redemption Internal Related Redemptions Rollbacks Item

Attributes Description

id
string

Unique rollback redemption ID.

Example: rr\_0bc92f81a6801f9bca

date
string

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

redemptions
array

Array of:

Redemption Internal Related Redemptions Item

Attributes Description

id
string

Unique redemption ID.

Example: r\_0bc92f81a6801f9bca

date
string

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\_id
string

Unique redemption ID of the parent redemption.

Example: r\_0c656311b5878a2031

redemption
string

Unique redemption ID of the parent redemption.

Example: r\_0c656311b5878a2031

customer

See: Simple Customer

customer\_id
string, null

Unique customer ID of the redeeming customer.

Example: cust\_i8t5Tt6eiKG5K79KQlJ0Vs64

related\_object\_type
string

Defines the related object.

Available values: voucher, promotion\_tier

related\_object\_id
string

Unique related object ID assigned by Voucherify, i.e. v\_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno for a voucher.

related\_object\_parent\_id
string

Unique related parent object ID assigned by Voucherify, i.e. v\_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno for a voucher.

campaign\_name
string

Campaign name

voucher

Defines the details of the voucher being redeemed.

All of:

Voucher
Voucher Holder

promotion\_tier

Contains details of the promotion tier and the parent campaign.

Promotion Tier

Simple Custom Event

Attributes	Description
id `string`	Unique identifier of the custom event.
name `string`	Name of the custom event.

Simple Segment

Attributes Description

id
string

Unique segment ID.

Example: seg\_DNAOhUtJffvX0f57ajLMFBYR

name
string

Segment name.

object
string

The type of the object represented by the ID.

Available values: segment

Event Customer Sent

Attributes Description

customer

See: Simple Customer

distribution
object

sent\_at
string

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

distribution
object

recovered\_at
string

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

distribution
object

failed\_at
string

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\_id `string`	Unique reward assignment ID assigned by Voucherify.
voucher	Simple Voucher
product	Simple Product
sku	Simple Sku
loyalty\_tier\_id `string`	Unique loyalty tier ID assigned by Voucherify.
id `string`	Unique reward ID, assigned by Voucherify. Example: rew\_nIy4gHpQHle2c3pNMwuj7G6j
object `string`	The type of the object represented by the JSON. This object stores information about the reward. Available values: `reward`
name `string`	Reward name.
created\_at `string`	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\_at `string`, `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
parameters `object`	Defines how the reward is generated. Reward type
metadata `object`	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.
type `string`	Reward type. Available values: `CAMPAIGN`, `COIN`, `MATERIAL`

Simple Referral Tier

Attributes	Description
id `string`	Unique referral tier ID. Example: seg\_DNAOhUtJffvX0f57ajLMFBYR
campaign\_id `string`	Campaign Id.
banner `string`	Text to be displayed to your customers on your website.
parameters `object`	Referral tier parameters

Loyalty Tier

All of:

Loyalty Tier Base

Attributes Description

id
string

Unique loyalty tier ID.

campaign\_id
string

Unique parent campaign ID.

metadata
object, 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\_at
string

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

updated\_at
string, null

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

config
object

Defines loyalty tier range in points.

Attributes Description

points
object

Defines range of loyalty tier in points.

Attributes	Description
from `integer`	Bottom points threshold value.
to `integer`	Top points threshold value.

expiration

See: Loyalty Tier Expiration

object
string

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

Available values: loyalty\_tier

Earning Rule

All of:

EarningRuleBase

Attributes Description

validation\_rule\_id
string, null

A unique validation rule identifier assigned by the Voucherify API. The validation rule is verified before points are added to the balance.

updated\_at
string, null

Timestamp representing the date and time when the earning rule was last updated in ISO 8601 format.

active
boolean

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

type
string

The type of voucher whose balance is being adjusted due to the transaction.

Available values: loyalty\_card, gift\_voucher

total
integer

The number of all points or credits accumulated on the card as affected by add or subtract operations.

object
string

The type of the object represented by the JSON.

Available values: balance

amount
integer

Credits added or subtracted on a gift card.

points
integer

Points added or subtracted in the transaction of a loyalty card.

balance
integer

The available points or credits on the card after the transaction as affected by redemption or rollback.

operation\_type
string

The type of the operation being performed. The operation type is AUTOMATIC if it is an automatic redemption.

Available values: MANUAL, AUTOMATIC

related\_object
object

Defines the resource that is being modified with the values that are returned in the balance object.

Attributes Description

id
string

Identifies the voucher that is being modified. The ID is assigned by the Voucherify API.

type
string

The object being modified, i.e. voucher.

Available values: voucher

Order Calculated No Customer Data

Attributes Description

id
string

Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request.

source\_id
string, null

Unique source ID of an existing order that will be linked to the redemption of this request.

status
string

The order status.

Available values: CREATED, PAID, CANCELED, FULFILLED

amount
integer

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\_amount
integer

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\_amount
integer

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\_amount
integer

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\_amount
integer

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\_amount
integer

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\_amount
integer

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\_amount
integer

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\_amount
integer

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

metadata
object

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.

object
string

The type of the object represented by JSON.

Available values: order

created\_at
string

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\_at
string, 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\_id
string, null

Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify.

Example: cust\_7iUa6ICKyU6gH40dBU25kQU1

referrer\_id
string, null

Unique referrer ID.

Example: cust\_nM4jqPiaXUvQdVSA6vTRUnix

customer

Customer Id

referrer

Referrer Id

redemptions
object

Attributes	Description
\[propertyName]	See: Order Redemptions

Order Item Calculated

Attributes Description

id
string

Unique identifier of the order line item.

sku\_id
string

Unique identifier of the SKU. It is assigned by Voucherify.

product\_id
string

Unique identifier of the product. It is assigned by Voucherify.

related\_object
string

Used along with the source\_id property, can be set to either sku or product.

Available values: product, sku

source\_id
string

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.

quantity
integer

The quantity of the particular item in the cart.

discount\_quantity
integer

Number of dicounted items.

initial\_quantity
integer

A positive integer in the smallest unit quantity representing the total amount of the order; this is the sum of the order items' quantity.

amount
integer

The total amount of the order item (price \* quantity).

discount\_amount
integer

Sum of all order-item-level discounts applied to the order.

applied\_discount\_amount
integer

This field shows the order-level discount applied.

applied\_discount\_quantity
integer

Number of the discounted items applied in the transaction.

applied\_quantity
integer

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\_amount
integer

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\_amount
integer

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.

price
integer

Unit price of an item. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for \$100.00.

subtotal\_amount
integer

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

product
object

An object containing details of the related product.

Attributes	Description
id `string`	A unique identifier that represents the product and is assigned by Voucherify.
source\_id `string`	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.
override `boolean`	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.
name `string`	Product name.
metadata `object`	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.
price `number`	Product price. A positive integer in the smallest currency unit (e.g. 100 cents for \$1.00).

sku
object

An object containing details of the related SKU.

Attributes	Description
id `string`	A unique identifier that represents the SKU and is assigned by Voucherify.
source\_id `string`	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.
override `boolean`	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.
sku `string`	The SKU name.
price `number`	SKU price. A positive integer in the smallest currency unit (e.g. 100 cents for \$1.00).
metadata `object`	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.

object
string

The type of the object represented by JSON.

Available values: order\_item

metadata
object

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
id `string`	Unique identifier assigned by Voucherify that will be linked to the this event. Example: evcus\_0e3070fef399b70b00
type `string`	Type of the triggering event. Example: customer.order.paid
category `string`	Type of the event. Available values: `EFFECT`, `ACTION`
entity\_id `string`	ID of the entity that initiated the event. Example: cust\_ADqZIwGvWFvugWXVbrHwXRHO
created\_at `string`	Timestamp representing the date and time when the event was created in the ISO 8601 format. Example: 2024-01-01T11:11:11.111Z
group\_id `string`	Unique identifier of the request that triggered the event. Example: v-1f36113948e50fc4ge

Voucher Transaction Base

Attributes	Description
id `string`	Unique transaction ID.
source\_id `string`, `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\_id `string`	Unique voucher ID.
campaign\_id `string`	Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes.
source `string`, `null`	The channel through which the transaction took place, whether through the API or the Dashboard. In case of a redemption, this value is null.
reason `string`, `null`	Reason why the transaction occurred. In case of a redemption, this value is null.
related\_transaction\_id `string`, `null`	The related transaction ID on the receiving card.
created\_at `string`	Timestamp representing the date and time when the transaction was created. The value is shown in the ISO 8601 format.

Simple Order

Attributes	Description
id `string`	Unique identifier of an existing order that will be linked to the redemption of this request.
source\_id `string`	Unique source identifier of an existing order that will be linked to the redemption of this request.
status `string`	The order status. Available values: `CREATED`, `PAID`, `CANCELED`, `FULFILLED`
customer\_id `string`, `null`	Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify. Example: cust\_7iUa6ICKyU6gH40dBU25kQU1
referrer\_id `string`, `null`	Unique identifier of the referrer assigned by Voucherify. Example: cust\_nM4jqPiaXUvQdVSA6vTRUnix
amount `integer`	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\_amount `integer`	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\_amount `integer`	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\_amount `integer`	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\_amount `integer`	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\_amount `integer`	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\_amount `integer`	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\_amount `integer`	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).
items `array`	Array of items applied to the order. It can include up to 500 items. Array of Simple Order Item
metadata `object`	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.
object `string`	The type of the object represented by JSON. Available values: `order`

Voucher Transaction

All of:

Voucher Transaction Base

Attributes Description

details
object

Contains the detailed information about the transaction.

Attributes Description

balance

See: Voucher Balance

order
object

Contains information about the original order.

Attributes	Description
id `string`	Unique order ID.
source\_id `string`	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.

event
object

Contains information about the event that triggers the point accrual.

Attributes	Description
id `string`	Unique event ID.
type `string`	Type of event.

earning\_rule
object

Contains information about the earning rule.

Attributes Description

id
string

Unique identifier of an earning rule, assigned by Voucherify.

source
object

Contains the custom earning rule name.

Attributes	Description
banner `string`	Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard.

segment
object

Contains information about the segment.

Attributes	Description
id `string`	Unique identifier of the segment.
name `string`	Name of the segment.

loyalty\_tier
object

Contains information about the loyalty tier that is mapped for the earning rule and used in the transaction.

Attributes	Description
id `string`	Unique identifier of the loyalty tier, assigned by Voucherify.
name `string`	User-defined name of the loyalty tier.

redemption
object

Contains information about the original redemption.

Attributes	Description
id `string`	Unique redemption ID.

rollback
object

Contains information about the redemption rollback.

Attributes	Description
id `string`	Unique identifier of the redemption rollback.

custom\_event
object

Contains information about the custom event that triggers the point accrual.

Attributes	Description
id `string`	Unique identifier of the event.
type `string`	Type of the custom event.

event\_schema
object

Contains information about the custom event metadata schema.

Attributes	Description
id `string`	Unique identifier of the metadata schema.
name `string`	Type of the custom event.

holder\_loyalty\_tier
object

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	Description
id `string`	Unique identifier of the loyalty tier, assigned by Voucherify.
name `string`	User-defined name of the loyalty tier.

pending\_points

See: Loyalty Pending Point Entry

reward
object

Contains information about the pay with points reward.

Attributes	Description
id `string`	Unique reward ID.
name `string`	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
id `string`	Unique identifier of the pending point entry, assigned by Voucherify. Example: lopp\_0ffd593d5ad207ba6b
voucher\_id `string`	Unique identifier of the loyalty card, assigned by Voucherify. Example: v\_abCdEfghI1JKLMNPqRS2Tu3vWXyza4bc
campaign\_id `string`	Unique campaign identifier, assigned by Voucherify. Example: camp\_weer1c3p5ZgktqfW56RfoNaG
customer\_id `string`	Unique customer identifier, assigned by Voucherify. Example: cust\_IdgAFZxYwwHctOk9ppZMu319
order\_id `string`	Unique order identifier, assigned by Voucherify. Example: ord\_0ffc0fa65f15d2df17
points `integer`	Number of points in the pending state.
activates\_at `string`	Date when the pending points are activated and added to the customer's loyalty card.
details	See: Pending Point Details
created\_at `string`	Timestamp representing the date and time when the pending point entry was created. The value is shown in the ISO 8601 format.
updated\_at `string`	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

id
string

Unique identifier of the loyalty points bucket.

voucher\_id
string

Unique identifier of the parent loyalty card.

campaign\_id
string

Unique identifier of the parent campaign.

bucket
object

Defines the number of points stored in this loyalty point bucket.

Attributes	Description
total\_points `integer`	Total number of points in the loyalty point bucket.

status
string

Loyalty point bucket status.

expires\_at
string

Date when the number of points defined in the bucket object are due to expire.

created\_at
string

Timestamp representing the date and time when the loyalty point bucket object was created in ISO 8601 format.

updated\_at
string

Timestamp representing the date and time when the loyalty point bucket object was updated in ISO 8601 format.

object
string

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:

List Publications Item Base

Attributes Description

result
string

Status of the publication attempt.

Available values: SUCCESS

voucher

See: List Publications Item Voucher

Validation Entity

Attributes Description

id
string

Unique validation id.

session\_id
string

Unique session id.

status
string

The validation status

Available values: VALID, INVALID

created\_at
string

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\_id
string

Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify.

Example: cust\_7iUa6ICKyU6gH40dBU25kQU1

redeemables
array

Lists validation results of each redeemable.

Array of:

Attributes Description

id
string

Unique identifier of the redeemable, assigned by Voucherify.

type
string

Type of the redeemable.

Available values: voucher, promotion\_tier

skipped\_redeemables
array

Lists validation results of each redeemable.

Array of:

Attributes Description

id
string

Unique identifier of the redeemable, assigned by Voucherify.

type
string

Type of the redeemable.

Available values: voucher, promotion\_tier

inapplicable\_redeemables
array

Lists validation results of each redeemable.

Array of:

Attributes Description

id
string

Unique identifier of the redeemable, assigned by Voucherify.

type
string

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

id
string

Unique redemption ID.

Example: r\_0bc92f81a6801f9bca

customer\_id
string, null

Unique customer ID of the redeeming customer.

Example: cust\_i8t5Tt6eiKG5K79KQlJ0Vs64

tracking\_id
string

Hashed customer source ID.

date
string

Timestamp representing the date and time when the redemption was created in the ISO 8601 format.

Example: 2021-12-22T10:13:06.487Z

amount
integer

Example: 10000

order

See: Simple Order

reward

See: Simple Redemption Reward Result

customer

See: Simple Customer

result
string

Redemption result.

Available values: SUCCESS, FAILURE

status
string, null

Available values: SUCCEEDED, FAILED, ROLLED BACK

voucher

Defines the details of the voucher being redeemed.

Simple Voucher

promotion\_tier

See: Simple Promotion Tier

redemption
string

Unique redemption ID of the parent redemption.

Example: r\_0c656311b5878a2031

metadata
object

The metadata object stores all custom attributes in the form of key/value pairs assigned to the redemption.

failure\_code
string

If the result is FAILURE, this parameter will provide a generic reason as to why the redemption failed.

Example: customer\_rules\_violated

failure\_message
string

If the result is FAILURE, this parameter will provide an expanded reason as to why the redemption failed.

reason
string

The reason for the redemption rollback.

channel
object

Defines the details of the channel through which the redemption was issued.

Attributes Description

channel\_id
string

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\_type
string

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

object
string

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:

Order Calculated No Customer Data

Attributes	Description
items `array`	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\_redemption `object`
reward	See: Simple Redemption Reward Result
reward\_assignment	See: Reward Assignment
source `string`
balance `integer`

Event Customer Loyalty Tier Base

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

Redeemable Holder

Attributes	Description
id `string`	Unique identifier of the redeemable holder. Example: rh\_0e7b8db4700106a852
created\_at `string`	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\_id `string`	Identifier of the redeemable item. Example: v\_GXVguPhq2khgFxH7GrRXWA91gDr1LiA1
redeemable\_object `string`	Type of the redeemable. Available values: `voucher` Example: voucher
campaign\_id `string`	Unique identifier of the campaign as assigned by Voucherify. Example: camp\_weer1c3p5ZgktqfW56RfoNaG
campaign\_type `string`	Defines the type of the campaign. Available values: `REFERRAL\_PROGRAM` Example: REFERRAL\_PROGRAM
voucher\_type `string`	Defines the type of the voucher. Available values: `GIFT\_VOUCHER`, `DISCOUNT\_VOUCHER`, `LOYALTY\_CARD` Example: DISCOUNT\_VOUCHER
publication\_id `string`, `null`	Unique identifier of the publication.
customer\_id `string`	Unique identifier of the customer. Example: cust\_p1ufreYbVbwZ1x70nFkH9rF9
holder\_role `string`	Role of the holder. Available values: `OWNER`, `REFERRER`, `REFEREE` Example: REFERRER
object `string`	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

points
integer

Customer's loyalty points minus expired for all loyalty cards which the customer has.

referred\_customers
integer

Total number of customers referred by the customer.

campaigns
object

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 Description

points
integer

Remaining point balance in campaign.

loyalty\_tier
string

Customer's loyalty tier within the campaign.

Example: ltr\_UJ5Q54Q0OvEhua87Qfv2Ki5x

referred\_customers
integer

Number of customers referred by the customer in campaign.

Customer Referrals

Attributes Description

total
integer

Total number of times this customer received a referral, i.e. was referred by another customer.

campaigns
array

Contains an array of campaigns that served as the source of a referral for the customer.

Array of:

Customer Referrals Campaigns Item

Attributes	Description
campaign\_id `string`	Unique campaign ID, assigned by Voucherify. Example: camp\_rRsfatlwN7unSeUIJDCYedal
referrer\_id `string`	Unique referrer ID, assigned by Voucherify. This is the customer ID of a customer that is referring this customer. Example: cust\_sehkNIi8Uq2qQuRqSr7xn4Zi
related\_object\_id `string`	Related object id Example: r\_0b9d4cc4aa164dd073
related\_object\_type `string`	Related object type, i.e. `redemption`.
date `string`	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

name
string

Customer's first and last name.

description
string

An arbitrary string that you can attach to a customer object.

email
string

Customer's email address.

phone
string

Customer's phone number. This parameter is mandatory when you try to send out codes to customers via an SMS channel.

birthday
string

Deprecated. ~~Customer's birthdate; format YYYY-MM-DD~~.

birthdate
string

Customer's birthdate; format YYYY-MM-DD.

address
object, null

Customer's address.

Attributes	Description
city `string`	City
state `string`	State
line\_1 `string`	First line of address.
line\_2 `string`	Second line of address.
country `string`	Country.
postal\_code `string`	Postal code.

metadata
object

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

type
string

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

redemption
object

Defines the redemption limits on vouchers.

Attributes Description

quantity
integer, null

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

redeemed\_quantity
integer

How many times a voucher has already been redeemed.

Example: 1

code\_config

Code Config

Referral Program

Attributes Description

conversion\_event\_type
string

Define how a referral is triggered.

Available values: redemption, custom\_event

custom\_event
object

Contains details about the custom event.

Attributes Description

id
string

Unique custom event ID.

Example: ms\_Ll9enAm2BCN0M1s4VxWobLFM

name
string

Custom event name.

referee\_reward
object

Defines the referee reward.

Attributes Description

related\_object\_parent
object

Details of the resource from which the reward originates.

Attributes Description

id
string

Unique ID of the reward source.

Example: camp\_kdxp3vf1clQ9CFs1jpqv3tZe

name
string

Name of the reward source.

object
string

Type of resource represented by the source of the reward.

Available values: CAMPAIGN

type
string

Type of reward.

Available values: LOYALTY\_CARD, GIFT\_VOUCHER

amount
integer

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.

Gift

Attributes	Description
amount `number`	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\_amount `integer`	Total amount of subtracted credits over the gift card lifetime.
balance `number`	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`.
effect `string`	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
points `integer`	Total number of points added to the loyalty card over its lifespan.
balance `integer`	Points available for reward redemption. This is calculated as follows: `balance` \= `points` \- `expired\_points` \- `subtracted\_points` \- `redemption.redeemed\_points`.
next\_expiration\_date `string`	The next closest date when the next set of points are due to expire.
next\_expiration\_points `integer`	The amount of points that are set to expire next.
pending\_points `integer`	Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually.
expired\_points `integer`	Shows the total number of expired points over the lifetime of the loyalty card.
subtracted\_points `integer`	Shows the total number of subtracted points over the lifetime of the loyalty card.

Customer Object Required Object Type

Attributes	Description
id `string`	The unique ID of a customer that is assigned by Voucherify. Example: cust\_CSnYd37MXmrbS19XCrghjBsv
source\_id `string`	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.
name `string`	Customer's first and last name.
email `string`	Customer's email address.
metadata `object`	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.
object `string`	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\_id
string, null

Unique reward assignment ID assigned by Voucherify.

voucher

Voucher

product

Product

sku

SKU Object

loyalty\_tier\_id
string, null

Unique loyalty tier ID assigned by Voucherify.

id
string

Unique reward ID.

Example: rew\_0bc92f81a6801f9bca

name
string

Name of the reward.

Example: Reward Name

object
string

The type of the object represented by the JSON

Available values: reward

created\_at
string

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\_at
string

Timestamp in ISO 8601 format indicating when the reward was updated.

Example: 2022-10-03T12:24:58.008Z

parameters
object

These are parameters representing a material reward.

Attributes Description

campaign
object

Defines the product redeemed as a reward.

Attributes Description

id
string

Campaign unique ID.

Example: camp\_13BbZ0kQsNinhqsX3wUts2UP

balance
integer

Points available for reward redemption. This is calculated as follows: balance \= points \- expired\_points \- subtracted\_points \- redemption.redeemed\_points.

type
string

Defines the type of the campaign.

product
object

Defines the product redeemed as a reward.

Attributes Description

id
string

Unique product ID, assigned by Voucherify.

Example: prod\_0b7d7dfb05cbe5c616

sku\_id
string

Unique identifier of the SKU. It is assigned by Voucherify.

Example: sku\_0a41e31c7b41c28358

coin
object

Defines the ratio by mapping the number of loyalty points in points\_ratio to a predefined cash amount in exchange\_ratio.

Attributes	Description
exchange\_ratio `integer`	The cash equivalent of the points defined in the `points\_ratio` property.
points\_ratio `integer`	The number of loyalty points that will map to the predefined cash amount defined by the `exchange\_ratio` property.

metadata
object

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.

type
string

Reward type.

Available values: CAMPAIGN, COIN, MATERIAL

Voucher

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

All of:

Voucher Base

Attributes	Description
categories `array`	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

id
string

Unique promotion tier ID.

Example: promo\_63fYCt81Aw0h7lzyRkrGZh9p

created\_at
string

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\_at
string

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

name
string

Name of the promotion tier.

banner
string

Text to be displayed to your customers on your website.

action
object

Contains details about the discount applied by the promotion tier.

Attributes	Description
discount	See: Discount

metadata
object

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.

hierarchy
integer

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\_id
string

Promotion unique ID.

campaign
object

Contains details about promotion tier's parent campaign.

Attributes	Description
id `string`	Unique campaign ID.
start\_date `string`	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\_date `string`	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
active `boolean`	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\_id `string`	Unique category ID that this campaign belongs to. Example: cat\_0b688929a2476386a6
object `string`	The type of the object represented by the campaign object. This object stores information about the campaign.

campaign\_id
string

Promotion tier's parent campaign's unique ID.

active
boolean

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\_date
string

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\_date
string

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

summary
object

Contains statistics about promotion tier redemptions and orders.

Attributes Description

redemptions
object

Contains statistics about promotion tier redemptions.

Attributes	Description
total\_redeemed `integer`	Number of times the promotion tier was redeemed.

orders
object

Contains statistics about orders related to the promotion tier.

Attributes	Description
total\_amount `integer`	Sum of order totals.
total\_discount\_amount `integer`	Sum of total discount applied using the promotion tier.

object
string

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\_id
string

Promotion tier category ID.

Example: cat\_0c9da30e7116ba6bba

categories
array

Array of Category

Simple Product

Attributes	Description
id `string`	Unique product ID.
source\_id `string`	Product source id.
name `string`	Product name.

Simple Sku

Attributes	Description
id `string`	Unique sku ID.
source\_id `string`	Sku source id.
sku `string`	Sku name.

Reward type

One of:

Digital
Pay with Points
Material

Loyalty Tier Base

Attributes Description

name
string

Loyalty Tier name.

earning\_rules
object

Contains a list of earning rule IDs and their points mapping for the given earning rule.

Attributes	Description
\[propertyName]	See: MappingPoints

rewards
object

Contains a list of reward IDs and their points mapping for the given reward.

Attributes	Description
\[propertyName]	See: MappingPoints

points
object

Defines range of loyalty tier in points.

Attributes	Description
from `integer`	Bottom points threshold value.
to `integer`	Top points threshold value.

Loyalty Tier Expiration

Attributes	Description
customer\_id `string`	Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify. Example: cust\_7iUa6ICKyU6gH40dBU25kQU1
campaign\_id `string`	Unique campaign ID, assigned by Voucherify. Example: camp\_rRsfatlwN7unSeUIJDCYedal
tier\_id `string`	Unique tier ID, assigned by Voucherify.
start\_date `string`	Activation timestamp defines when the loyalty tier starts to be active in ISO 8601 format. Loyalty tier is inactive before this date.
expiration\_date `string`	Expiration timestamp defines when the loyalty tier expires in ISO 8601 format. Loyalty tier is inactive after this date.
created\_at `string`	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\_at `string`	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

id
string

Assigned by the Voucherify API, identifies the earning rule object.

created\_at
string

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\_event
object

Contains details about the custom event.

Attributes	Description
schema\_id `string`	Unique identifier of the custom event schema

segment
object

Contains the ID of a customer segment. Required for the customer.segment.entered option in the event.

Attributes	Description
id `string`	Contains a unique identifier of a customer segment. Assigned by the Voucherify API.

loyalty\_tier
object

Defines the tier associated with the earning rule definition.

Attributes Description

id
string

Unique loyalty tier ID associated with the earning rule.

**ANY** : any loyalty tier within the campaign

Example: ltr\_pudTGWasuIqxdiDM0go31OV1

pending\_points
object

Defines the configuration for pending points. Pending points can be used only with the order.paid event.

Attributes Description

period\_type
string

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\_value
integer

Defines for how long the points are in the pending state. The minimum value is 1, maximum is 90.

source
object

Contains the custom earning rule name and parent campaign.

Attributes Description

banner
string

Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard.

object\_id
string

A unique campaign identifier assigned by the Voucherify API.

object\_type
string

Defines the object associated with the earning rule. Defaults to campaign.

Available values: campaign

object
string

The type of the object represented by JSON. Default is earning\_rule.

Available values: earning\_rule

automation\_id
string

For internal use by Voucherify.

start\_date
string

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\_date
string

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

metadata
object

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

id
string

A unique identifier of an existing customer.

object
string

The type of the object represented by JSON.

Available values: customer

Referrer Id

Customer Id

Order Redemptions

Attributes	Description
date `string`	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\_id `string`	Unique ID of the redemption rollback. Example: rr\_0c63c84eb78ee0a6c0
rollback\_date `string`	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\_type `string`	The source of the incentive.
related\_object\_id `string`	Unique ID of the parent redemption. Example: r\_0ba186c4824e4881e1
related\_object\_parent\_id `string`	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.
stacked `array`	Contains a list of unique IDs of child redemptions, which belong to the stacked incentives.
rollback\_stacked `array`	Lists the rollback redemption IDs of the particular child redemptions.

Simple Order Item

Attributes	Description
id `string`	Unique identifier of the order line item.
object `string`	The type of the object represented by JSON. This object stores information about the `order\_item`. Available values: `order\_item`
source\_id `string`	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\_object `string`	Used along with the `source\_id` property, can be set to either SKU or product. Available values: `product`, `sku`
product\_id `string`	Unique identifier of the product. It is assigned by Voucherify.
sku\_id `string`	Unique identifier of the SKU. It is assigned by Voucherify.
quantity `integer`	Quantity of the particular item in the cart.
applied\_quantity `integer`	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\_amount `integer`	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\_quantity `integer`	Number of discounted items.
applied\_discount\_quantity `integer`	Number of the discounted items applied in the transaction.
amount `integer`	Total amount of the order item (price \* quantity).
discount\_amount `integer`	Sum of all order-item-level discounts applied to the order.
applied\_discount\_amount `integer`	Order-level discount amount applied in the transaction.
price `integer`	Unit price of an item. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `\$100.00`.
subtotal\_amount `integer`	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\_tier
object

The loyalty tier that is mapped for the earning rule and used in the pending point transaction.

Attributes	Description
id `string`	Unique identifier of the loyalty tier, assigned by Voucherify.
name `string`	User-defined name of the loyalty tier.

holder\_loyalty\_tier
object

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	Description
id `string`	Unique identifier of the loyalty tier, assigned by Voucherify.
name `string`	User-defined name of the loyalty tier.

event
object

Details about the event that created pending points.

Attributes	Description
id `string`	Unique event identifier, assigned by Voucherify.
type `string`	Type of the event that triggered the creation of pending points. Available values: `customer.order.paid`
group\_id `string`	Unique identifier of the request that triggered the event, assigned by Voucherify.
entity\_id `string`	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\_at `string`	Timestamp representing the date and time when the event occurred. The value is shown in the ISO 8601 format.
category `string`	Type of the event. Available values: `ACTION`, `EFFECT`
event\_source	See: Event Source

earning\_rule
object

Contains information about the earning rule.

Attributes Description

id
string

Unique identifier of an earning rule, assigned by Voucherify.

source
object

Contains the custom earning rule name.

Attributes	Description
banner `string`	Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard.

order
object

Details about the order that caused adding pending points.

Attributes	Description
id `string`	Unique order identifier, assigned by Voucherify.
source\_id `string`, `null`	User-defined order identifier.

List Publications Item Base

Attributes Description

id
string

Unique publication ID, assigned by Voucherify.

Example: pub\_BbjAXnmm8e0SIm3zG8qvvFCP0KuLywtp

object
string

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

Available values: publication

created\_at
string

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\_id
string

Unique customer ID of the customer receiving the publication.

Example: cust\_eWgXlBBiY6THFRJwX45Iakv4

tracking\_id
string

Customer's source\_id.

metadata
object

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	Description
source\_type `string`	Defines the type of the distribution source.
source\_id `string`	Unique identifier of the distribution source.
distribution\_id `string`	Unique identifier of the distribution.

channel
string

How the publication was originated. It can be your own custom channel or an example value provided here.

source\_id
string, 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

vouchers
array

Contains the voucher IDs that was assigned by Voucherify.

vouchers\_id
array

Contains the unique internal voucher IDs that was assigned by Voucherify.

List Publications Item Voucher

Attributes	Description
code `string`	Voucher code.
object `string`	The type of the object represented by JSON. Available values: `voucher`
campaign `string`	Campaign name
gift	Gift object response Gift
loyalty\_card `object`	Defines the loyalty card details.
discount	See: Discount
is\_referral\_code `boolean`	Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL\_PROGRAM`.

Simple Promotion Tier

Attributes Description

id
string

Unique promotion tier ID.

Example: promo\_63fYCt81Aw0h7lzyRkrGZh9p

name
string

Name of the promotion tier.

banner
string

Text to be displayed to your customers on your website.

campaign
object

Contains details about promotion tier's parent campaign.

Attributes	Description
id `string`	Unique campaign ID.

metadata
object

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

id
string

Unique identifier of the promotion stack.

name
string

Name of the promotion stack.

category\_id
string

Unique identifier of the category of the promotion stack.

campaign
object

Represents simplified promotion stack campaign data.

Attributes	Description
id `string`	Unique identifier of the campaign.

tiers
object

Contains the tier configuration. A promotion stack can include up to 30 tiers.

Attributes	Description
ids `array`	Contains the list of tiers in a pre-defined sequence.
hierarchy\_mode `string`	Available values: `MANUAL`

Reward Assignment

All of:

Reward Assignment Base
Digital or Material Reward - Parameters

Customer Summary Redemptions

Attributes Description

total\_redeemed
integer

Total number of redemptions made by the customer.

total\_failed
integer

Total number of redemptions that failed.

total\_succeeded
integer

Total number of redemptions that succeeded.

total\_rolled\_back
integer

Total number of redemptions that were rolled back for the customer.

total\_rollback\_failed
integer

Total number of redemption rollbacks that failed.

total\_rollback\_succeeded
integer

Total number of redemption rollbacks that succeeded.

gift
object

Summary of gift card credits.

Attributes	Description
redeemed\_amount `integer`	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\_go `integer`	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\_card
object

Summary of loyalty points.

Attributes	Description
redeemed\_points `integer`	Total number of loyalty points redeemed by the customer.
points\_to\_go `integer`	Sum of remaining available point balance across all loyalty cards.

Customer Summary Orders

Attributes	Description
total\_amount `integer`	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\_count `integer`	Total number of orders made by the customer.
average\_amount `integer`	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\_amount `integer`	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\_date `string`	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

points
integer

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\_rules
object

Defines the loyalty point expiration rule. This expiration rule applies when there are no expiration\_rules defined for an earning rule.

Attributes	Description
period\_type `string`	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\_value `integer`	Value of the period. Required for the `period\_type: MONTH`.
rounding\_type `string`	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\_value `integer`	Value of rounding of the expiration period. Required for the `rounding\_type`.
fixed\_month `integer`	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\_day `integer`	Determines the day of the month when the points expire. Required for the `period\_type: FIXED\_DAY\_OF\_YEAR`.

Code Config

Attributes	Description
length `number`	Number of characters in a generated code (excluding prefix and postfix).
charset `string`	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
prefix `string`	A text appended before the code.
postfix `string`	A text appended after the code.
pattern `string`	A pattern for codes where hashes (#) will be replaced with random characters. Overrides `length`.
initial\_count `integer`	Internal value, does not change anything if provided.

Amount

Attributes	Description
type `string`	Defines the type of the voucher. Available values: `AMOUNT`
amount\_off `number`	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\_formula `string`	Formula used to dynamically calculate the discount.
aggregated\_amount\_limit `integer`	Maximum discount amount per order.
effect	Defines how the discount is applied to the customer's order. Discount Amount Vouchers Effect Types
is\_dynamic `boolean`	Flag indicating whether the discount was calculated using a formula.

Unit

Attributes	Description
type `string`	Discount type. Available values: `UNIT`
unit\_off `integer`	Number of units to be granted a full value discount.
unit\_off\_formula `string`	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\_type `string`	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\_dynamic `boolean`	Flag indicating whether the discount was calculated using a formula.

Unit Multiple

Attributes Description

type
string

Discount type.

Available values: UNIT

effect
string

Defines how the discount is applied to the customer's order.

Available values: ADD\_MANY\_ITEMS

units
array

Array of One Unit

Percent

Attributes	Description
type `string`	Defines the type of the voucher. Available values: `PERCENT`
percent\_off `number`	The percent discount that the customer will receive.
percent\_off\_formula `string`	Formula used to dynamically calculate the discount.
amount\_limit `number`	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\_limit `integer`	Maximum discount amount per order.
effect	Defines how the discount is applied to the customer's order. Discount Percent Vouchers Effect Types
is\_dynamic `boolean`	Flag indicating whether the discount was calculated using a formula.

Fixed

Attributes	Description
type `string`	Defines the type of the voucher. Available values: `FIXED`
fixed\_amount `number`	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\_formula `string`	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\_dynamic `boolean`	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:

Product without Skus Object

Attributes	Description
skus	See: Skus List For Product

SKU Object

Attributes	Description
id `string`	A unique identifier that represents the SKU and is assigned by Voucherify. Example: sku\_0b1621b319d248b79f
source\_id `string`, `null`	A unique SKU identifier from your inventory system. Example: sku\_source\_id\_4
product\_id `string`	The parent product's unique ID. Example: prod\_0b15f6b9f650c16990
sku `string`, `null`	Unique user-defined SKU name. Example: Large Pink Shirt
price `integer`, `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`.
currency `string`, `null`	SKU price currency. Example: USD
attributes `object`	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\_url `string`, `null`	The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image.
metadata `object`	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\_at `string`	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\_at `string`, `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
object `string`	The type of the object represented by JSON. This object stores information about the `SKU`. Available values: `sku`

Voucher Base

Attributes Description

id
string

Assigned by the Voucherify API, identifies the voucher.

Example: v\_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV

code
string

A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters.

Example: WVPblOYX

campaign
string

A unique campaign name, identifies the voucher's parent campaign.

Example: Gift Card Campaign

campaign\_id
string

Assigned by the Voucherify API, identifies the voucher's parent campaign.

Example: camp\_FNYR4jhqZBM9xTptxDGgeNBV

category
string

Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint.

category\_id
string

Unique category ID assigned by Voucherify.

Example: cat\_0bb343dee3cdb5ec0c

type
string

Defines the type of the voucher.

Available values: GIFT\_VOUCHER, DISCOUNT\_VOUCHER, LOYALTY\_CARD

discount

See: Discount

gift
object

Object representing gift parameters. Child attributes are present only if type is GIFT\_VOUCHER. Defaults to null.

Attributes	Description
amount `integer`	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\_amount `integer`	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`.
balance `integer`	Available funds. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `\$100.00`. Example: 500
effect `string`	Defines how the credits are applied to the customer's order. Available values: `APPLY\_TO\_ORDER`, `APPLY\_TO\_ITEMS`

loyalty\_card
object

Object representing loyalty card parameters. Child attributes are present only if type is LOYALTY\_CARD. Defaults to null.

Attributes	Description
points `integer`	Total number of points added to the loyalty card over its lifespan. Example: 7000
balance `integer`	Points available for reward redemption. This is calculated as follows: `balance` \= `points` \- `expired\_points` \- `subtracted\_points` \- `redemption.redeemed\_points`. Example: 6970
next\_expiration\_date `string`	The next closest date when the next set of points are due to expire. Example: 2023-05-30
next\_expiration\_points `integer`	The amount of points that are set to expire next.
pending\_points `integer`	Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually.
expired\_points `integer`	Shows the total number of expired points over the lifetime of the loyalty card.
subtracted\_points `integer`	Shows the total number of subtracted points over the lifetime of the loyalty card.

start\_date
string

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\_date
string

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

active
boolean, 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\_info
string

An optional field to keep any extra textual information about the code such as a code description and details.

metadata
object

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\_code
boolean, null

Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL\_PROGRAM.

created\_at
string

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\_at
string

Timestamp representing the date and time when the voucher was last updated in ISO 8601 format.

Example: 2021-12-22T10:14:45.316Z

holder\_id
string

Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify.

Example: cust\_eWgXlBBiY6THFRJwX45Iakv4

referrer\_id
string

Unique identifier of the referring person.

Example: cust\_Vzck5i8U3OhcEUFY6MKhN9Rv

object
string

The type of the object represented by JSON. Default is voucher.

publish
object

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 Description

object
string

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.

count
integer

Publication events counter.

Example: 0

url
string

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

redemption
object

Stores a summary of redemptions that have been applied to the voucher.

Attributes	Description
quantity `integer`	How many times a voucher can be redeemed. A `null` value means unlimited.
redeemed\_quantity `integer`	How many times a voucher has already been redeemed. Example: 1
redeemed\_points `integer`	Total loyalty points redeemed. Example: 100000
object `string`	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.
url `string`	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
object `string`	The type of the object represented by JSON. This object stores information about validation rules assignments. Available values: `list`
data\_ref `string`	Identifies the name of the attribute that contains the array of validation rules assignments. Available values: `data`
data `array`	Contains array of validation rules assignments. Array of Business Validation Rule Assignment
total `integer`	Total number of validation rules assignments.

Validity Timeframe

Attributes Description

duration
string

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

interval
string

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

daily
array

Defines the recurring period(s) when the resource is active. The periods should not overlap.

Array of:

Attributes Description

start\_time
string

Defines the starting hour of validity in the HH:mm format. The resource is inactive before this time.

Example: 12:00

days\_of\_week
array

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\_time
string

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
object `string`	The type of the object represented by JSON. This object stores information about validation rule assignments.
data\_ref `string`	Identifies the name of the JSON property that contains the array of validation rule assignments.
data `array`	A dictionary that contains an array of validation rule assignments. Array of Validation Rule Assignment
total `integer`	Total number of validation rule assignments.

Digital

Attributes Description

campaign
object

Objects stores information about the campaign related to the reward.

Attributes Description

id
string

Unique campaign ID, assigned by Voucherify.

balance
integer

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.

type
string

Campaign type.

Available values: DISCOUNT\_COUPONS, GIFT\_VOUCHERS, LOYALTY\_PROGRAM

Pay with Points

Attributes Description

coin
object

Defines the ratio by mapping the number of loyalty points in points\_ratio to a predefined cash amount in exchange\_ratio.

Attributes	Description
exchange\_ratio `number`	The cash equivalent of the points defined in the points\_ratio property.
points\_ratio `integer`	The number of loyalty points that will map to the predefined cash amount defined by the exchange\_ratio property.

Material

Attributes Description

product
object

Contains information about the product given as a reward.

Attributes Description

id
string

Unique product ID, assigned by Voucherify.

Example: prod\_0b7d7dfb05cbe5c616

sku\_id
string, 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

type
string

The number of points to be added to the loyalty card.

Available values: FIXED

points
integer

Defines how the points will be added to the loyalty card. FIXED adds a fixed number of points.

points\_formula
string

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\_type `string`	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\_value `integer`	Value of the period. Required for the `period\_type: MONTH`.
rounding\_type `string`	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\_value `integer`	Value of rounding of the expiration period. Required for the `rounding\_type`.
fixed\_month `integer`	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\_day `integer`	Determines the day of the month when the points expire. Required for the `period\_type: FIXED\_DAY\_OF\_YEAR`.

Reward Assignment Base

Attributes	Description
id `string`	Unique reward assignment ID, assigned by Voucherify. Example: rewa\_PbIRoMXpwe5QhobW4JKu0VjH
reward\_id `string`	Associated reward ID. Example: rew\_C7wS9eHFDN4CIbXI5PpLSkGY
created\_at `string`	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\_at `string`, `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
object `string`	The type of the object represented by the JSON. This object stores information about the reward assignment. Available values: `reward\_assignment`
related\_object\_id `string`	Related object ID to which the reward was assigned. Example: camp\_wciTvaOfYmAa3EmIIW3QpXXZ
related\_object\_type `string`	Related object type to which the reward was assigned. Available values: `campaign`

Digital or Material Reward - Parameters

Attributes Description

parameters
object

Defines the cost of the reward.

Attributes Description

loyalty
object

Defines the equivalent points value of the reward.

Attributes	Description
points `integer`	The number of points required to redeem the reward.
auto\_redeem `boolean`, `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, ADD\_SAME\_ITEMS

Simple Product Discount Unit

Attributes	Description
id `string`	Unique product ID, assigned by Voucherify.
source\_id `string`	Product's source ID.
name `string`	Product name.

Simple Sku Discount Unit

Attributes	Description
id `string`	Unique SKU ID, assigned by Voucherify.
source\_id `string`	Product variant's source ID.
name `string`	Sku name

One Unit

Attributes	Description
unit\_off `number`	Number of units to be granted a full value discount.
unit\_off\_formula `string`	Formula used to dynamically calculate the number of units.
effect `string`	Defines how the unit is added to the customer's order. Available values: `ADD\_NEW\_ITEMS`, `ADD\_MISSING\_ITEMS`
unit\_type `string`	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
id `string`	Unique product ID assigned by Voucherify. Example: prod\_0b1da8105693710357
source\_id `string`, `null`	Unique product source ID. Example: productSourceID16
name `string`, `null`	Unique user-defined product name. Example: T-shirt
price `integer`, `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`.
attributes `array`	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.
metadata `object`	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\_url `string`, `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](https://images.com/original.jpg)
created\_at `string`	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\_at `string`, `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
object `string`	The type of the object represented by JSON. This object stores information about the product. Available values: `product`

Skus List For Product

Attributes	Description
object `string`	The type of the object represented by JSON. This object stores information about SKUs.
data\_ref `string`	Identifies the name of the JSON property that contains the array of SKUs.
data `array`	A dictionary that contains an array of SKUs. Array of SKU Object
total `integer`	Total number of SKUs in the product.

Voucher Assets

Attributes Description

qr
object

Stores Quick Response (QR) representation of encrypted code.

Attributes Description

id
string

Encrypted voucher code ID.

Example: U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK+t4pp7U7oFzjGJzj9q/bmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg+BaZk5QwXMf8k/OzSlOEVybpwSq+AiqPoNtjeuqtIgkDyvT6Q==

url
string

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](https://dev.dl.voucherify.io/api/v1/assets/qr/U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK%2Bt4pp7U7oFzjGJzj9q%2FbmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg%2BBaZk5QwXMf8k%2FOzSlOEVybpwSq%2BAiqPoNtjeuqtIgkDyvT6Q%3D%3D)

barcode
object

Stores barcode representation of encrypted code.

Attributes Description

id
string

Encrypted voucher code ID.

Example: U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ==

url
string

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](https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D)

Business Validation Rule Assignment

Attributes	Description
id `string`	The unique identifier for a assignment
rule\_id `string`	The unique identifier for a rule
related\_object\_id `string`	The unique identifier for a related object
related\_object\_type `string`	The type of related object
created\_at `string`	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\_at `string`	Timestamp representing the date and time when the object was last updated in ISO 8601 format. Example: 2022-03-09T11:19:04.819Z
object `string`	The type of the object represented by JSON. Available values: `validation\_rules\_assignment`
validation\_status `string`	The validation status of the assignment Available values: `VALID`, `PARTIALLY\_VALID`, `INVALID`
validation\_omitted\_rules `array`	The list of omitted rules

Validation Rule Assignment

Attributes	Description
id `string`	Validation rule assignment ID. Example: asgm\_74F7QZoYbUoljwQO
rule\_id `string`	Validation rule ID. Example: val\_4j7DCRm2IS59
related\_object\_id `string`	The resource ID to which the validation rule was assigned. Example: v\_JtWunK6jUo7X2qOFj0SyRHq4p9tgENlT
related\_object\_type `string`	The type of resource to which the validation rule was assigned. Available values: `voucher`, `campaign`, `earning\_rule`, `reward\_assignment`, `promotion\_tier`, `distribution`
created\_at `string`	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
object `string`	The type of the object represented by the ID. Available values: `validation\_rules\_assignment`

MappingMultiply

Attributes Description

type
string

Type of calculation.

Available values: MULTIPLY

multiplier
number

Multiplication factor used to multiply the points to obtain the mapped points.

MappingFixed

Attributes Description

type
string

Type of calculation.

Available values: CUSTOM

points
integer

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

type
string

Defines how the points will be added to the loyalty card.PROPORTIONAL adds points based on a pre-defined ratio.

Available values: PROPORTIONAL

calculation\_type
string

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

customer
object

Attributes Description

metadata
object

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	Description
every `integer`	For how many increments of the customer metadata property to grant points for.
points `integer`	Number of points to be awarded, i.e. how many points to be added to the loyalty card.
points\_formula `string`	Formula used to dynamically calculate the rewarded points.
property `string`	Customer metadata property.

Earning Rule Proportional Custom Event

Attributes Description

type
string

Defines how the points will be added to the loyalty card.PROPORTIONAL adds points based on a pre-defined ratio.

Available values: PROPORTIONAL

calculation\_type
string

CUSTOM\_EVENT\_METADATA: Custom event metadata (X points for every Y in metadata attribute).

Available values: CUSTOM\_EVENT\_METADATA

custom\_event
object

Attributes Description

metadata
object

Attributes	Description
every `integer`	For how many increments of the customer metadata property to grant points for.
points `integer`	Number of points to be awarded, i.e. how many points to be added to the loyalty card.
points\_formula `string`	Formula used to dynamically calculate the rewarded points.
property `string`	Custom event metadata property.

Order Amount

Attributes Description

type
string

Defines how the points will be added to the loyalty card.PROPORTIONAL adds points based on a pre-defined ratio.

Available values: PROPORTIONAL

calculation\_type
string

ORDER\_AMOUNT : Pre-discount order amount (X points for every Y spent excluding discounts)

Available values: ORDER\_AMOUNT

order
object

Attributes Description

amount
object

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	Description
every `integer`	Value is multiplied by 100 to precisely represent 2 decimal places. For example, a \$10 order amount is written as 1000.
points `integer`	Number of points to be awarded, i.e. how many points to be added to the loyalty card.
points\_formula `string`	Formula used to dynamically calculate the rewarded points.

Order Total Amount

Attributes Description

type
string

Defines how the points will be added to the loyalty card.PROPORTIONAL adds points based on a pre-defined ratio.

Available values: PROPORTIONAL

calculation\_type
string

ORDER\_TOTAL\_AMOUNT : Total order amount (X points for every Y spent including discount)

Available values: ORDER\_TOTAL\_AMOUNT

order
object

Attributes Description

total\_amount
object

Attributes	Description
every `integer`	Value is multiplied by 100 to precisely represent 2 decimal places. For example, a \$10 order amount is written as 1000.
points `integer`	Number of points to be awarded, i.e. how many points to be added to the loyalty card.
points\_formula `string`	Formula used to dynamically calculate the rewarded points.

Order Metadata

Attributes Description

type
string

Defines how the points will be added to the loyalty card.PROPORTIONAL adds points based on a pre-defined ratio.

Available values: PROPORTIONAL

calculation\_type
string

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

order
object

Defines the formula for calculating points proportionally.

Attributes Description

metadata
object

Attributes	Description
every `integer`	For how many increments of the order metadata property to grant points for.
points `integer`	Number of points to be awarded, i.e. how many points to be added to the loyalty card.
points\_formula `string`	Formula used to dynamically calculate the rewarded points.
property `string`	Order metadata property.

Order Items Quantity

Attributes Description

type
string

Defines how the points will be added to the loyalty card.PROPORTIONAL adds points based on a pre-defined ratio.

Available values: PROPORTIONAL

calculation\_type
string

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\_items
object

Attributes Description

quantity
object

Attributes Description

every
integer

Value is multiplied by 100 to precisely represent 2 decimal places. For example, a \$10 order amount is written as 1000.

points
integer

Number of points to be awarded, i.e. how many points to be added to the loyalty card.

points\_formula
string

Formula used to dynamically calculate the rewarded points.

object
string

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

id
string

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\_to
array

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 Description

object
string

Type of object which will be covered by the earning rule.

Available values: products\_collection, product, sku

id
string

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

type
string

Defines how the points will be added to the loyalty card.PROPORTIONAL adds points based on a pre-defined ratio.

Available values: PROPORTIONAL

calculation\_type
string

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\_items
object

Attributes Description

amount
object

Attributes Description

every
integer

Value is multiplied by 100 to precisely represent 2 decimal places. For example, a \$10 order amount is written as 1000.

points
integer

Number of points to be awarded, i.e. how many points to be added to the loyalty card.

points\_formula
string

Formula used to dynamically calculate the rewarded points.

object
string

Available values: products\_collection, product, sku

id
string

applicable\_to
array

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 Description

object
string

Type of object which will be covered by the earning rule.

Available values: products\_collection, product, sku

id
string

Order Items Subtotal Amount

Attributes Description

type
string

Defines how the points will be added to the loyalty card.PROPORTIONAL adds points based on a pre-defined ratio.

Available values: PROPORTIONAL

calculation\_type
string

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\_items
object

Attributes Description

subtotal\_amount
object

Attributes Description

every
integer

Value is multiplied by 100 to precisely represent 2 decimal places. For example, a \$10 order amount is written as 1000.

points
integer

Number of points to be awarded, i.e. how many points to be added to the loyalty card.

points\_formula
string

Formula used to dynamically calculate the rewarded points.

object
string

Available values: products\_collection, product, sku

id
string

applicable\_to
array

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 Description

object
string

Type of object which will be covered by the earning rule.

Available values: products\_collection, product, sku

id
string