Stackable Redemptions Object

Redemptions Redeem Response Body

Attributes	Description
redemptionsarray	Array of Redemption
parent_redemption	See: Redemption
order	Contains the order details associated with the redemption.Order Calculated
inapplicable_redeemablesarray	Lists validation results of each inapplicable redeemable.Array of Inapplicable Redeemable
skipped_redeemablesarray	Lists validation results of each redeemable. If a redeemable can be applied, the API returns "status": "APPLICABLE".Array of Skipped Redeemable

Redemption

Attributes	Description
idstring	Unique redemption ID.Example:r_0bc92f81a6801f9bca
objectstring	The type of object represented by the JSONAvailable values: redemption
datestring	Timestamp representing the date and time when the object was created in ISO 8601 format.Example:2021-12-22T10:13:06.487Z
customer_idstring, null	Unique customer ID of the redeeming customer.Example:cust_i8t5Tt6eiKG5K79KQlJ0Vs64
tracking_idstring, null	Hashed customer source ID.
metadataobject, null	The metadata object stores all custom attributes assigned to the redemption.
amountinteger	A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items’ amounts.Example:10000
redemptionstring, null	Unique redemption ID of the parent redemption.Example:r_0c656311b5878a2031
resultstring	Redemption result.Available values: SUCCESS, FAILURE
statusstring	Redemption status.Available values: SUCCEEDED, FAILED, ROLLED_BACK
related_redemptionsobject	Attributes Descriptionrollbacksarray Array of: Redemption Related Redemptions Rollbacks Item Attributes Descriptionidstring Unique rollback redemption ID. Example: rr_0bc92f81a6801f9bca datestring Timestamp representing the date and time when the object was created in ISO 8601 format. Example: 2021-12-22T10:13:06.487Z redemptionsarray Array of: Redemption Related Redemptions Item Attributes Descriptionidstring Unique redemption ID. Example: r_0bc92f81a6801f9bca datestring Timestamp representing the date and time when the object was created in ISO 8601 format. Example: 2021-12-22T10:13:06.487Z
failure_codestring	If the result is FAILURE, this parameter will provide a generic reason as to why the redemption failed.Example:customer_rules_violated
failure_messagestring	If the result is FAILURE, this parameter will provide a more expanded reason as to why the redemption failed.
order	Order Calculated No Customer Data
channelobject	Defines the details of the channel through which the redemption was issued.Attributes Descriptionchannel_idstring Unique channel ID of the user performing the redemption. This is either a user ID from a user using the Voucherify Dashboard or an X-APP-Id of a user using the API. Example: user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH channel_typestring The source of the channel for the redemption. A USER corresponds to the Voucherify Dashboard and an API corresponds to the API. Available values: USER, API
customer	Simple Customer
related_object_typestring	Defines the related object.Available values: voucher, promotion_tier, redemption
related_object_idstring	Unique related object ID assigned by Voucherify, i.e. v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno for a voucher.
voucher	Defines the details of the voucher being redeemed.Voucher
promotion_tier	Contains details of the promotion tier and the parent campaign.Promotion Tier
reward	See: Redemption Reward Result
giftobject	Contains the amount being subtracted from the gift card for the redemption.Attributes Descriptionamountinteger The amount subtracted from the gift card expressed as the smallest currency unit (e.g. 100 cents for $1.00).
loyalty_cardobject	Stores the number of points being added back to the loyalty card for the reward redemption rollback.Attributes Descriptionpointsinteger Number of points being added back to the loyalty card for the reward redemption rollback.

Order Calculated

All of:

1. Order Response Base

2. Order Calculated

   Attributes	Description
   customer	One of: Customer With Summary Loyalty Referrals, Customer Id
   referrer	One of: Referrer With Summary Loyalty Referrals, Referrer Id

Inapplicable Redeemable

Attributes	Description
statusstring	Indicates whether the redeemable can be applied or not applied based on the validation rules.Available values: INAPPLICABLE
idstring	Redeemable ID, i.e. the voucher code.
objectstring	Redeemable’s object type.Available values: voucher, promotion_tier
resultobject	Attributes Descriptionerror See: Error Object

Skipped Redeemable

Attributes	Description
statusstring	Indicates whether the redeemable can be applied or not applied based on the validation rules.Available values: SKIPPED
idstring	Redeemable ID, i.e. the voucher code.
objectstring	Redeemable’s object type.Available values: voucher, promotion_tier
resultobject	Attributes Description

Order Calculated No Customer Data

All of:

1. Order Response Base

2. Order Customer And Referrer Ids Objects

   Attributes	Description
   customer	If only customer_id was provided, customer return data will be limited.Customer Id
   referrer	If only referrer_id was provided, referrer return data will be limited.Referrer Id

Simple Customer

Attributes	Description
idstring	The ID of an existing customer that will be linked to redemption in this request.
source_idstring	A unique identifier of the customer who validates a voucher. It can be a customer ID or email from a CRM system, database, or a third-party service. If you also pass a customer ID (unique ID assigned by Voucherify), the source ID will be ignored.
namestring	Customer’s first and last name.
emailstring	Customer’s email address.
metadataobject	A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments.
objectstring	The type of object represented by JSON.Available values: customer

Voucher

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

Example:

10000


balanceinteger 

Available funds. Value is multiplied by 100 to precisely represent 2 decimal places. For example, 100 amount is written as 10000. Example: 500 effectstring Defines how the credits are applied to the customer’s order. Available values: APPLY_TO_ORDER, APPLY_TO_ITEMS
loyalty_cardobject	Object representing loyalty card parameters. Child attributes are present only if type is LOYALTY_CARD. Defaults to null.Attributes Descriptionpointsinteger Total points incurred over lifespan of loyalty card. Example: 7000 balanceinteger Points available for reward redemption. Example: 6970 next_expiration_datestring The next closest date when the next set of points are due to expire. Example: 2023-05-30 next_expiration_pointsinteger The amount of points that are set to expire next.
start_datestring	Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date.Example:2021-12-01T00:00:00.000Z
expiration_datestring	Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date.Example:2021-12-31T00:00:00.000Z
validity_timeframeobject	Set recurrent time periods when the voucher is valid. For example, valid for 1 hour every other day.start_date required when including the validity_timeframe.Attributes Descriptiondurationstring Defines the amount of time the voucher will be active in ISO 8601 format. For example, a voucher with a duration of PT1H will be valid for a duration of one hour. Example: PT1H intervalstring Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, a voucher with an interval of P2D will be active every other day. Example: P2D
validity_day_of_weekarray	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 | | activeboolean, null | A flag to toggle the voucher on or off. You can disable a voucher even though it’s within the active period defined by the start_date and expiration_date.- true indicates an active voucher

• false indicates an inactive voucher | | additional_infostring | An optional field to keep any extra textual information about the code such as a code description and details. | | metadataobject | The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format. | | assets | See: Voucher Assets | | is_referral_codeboolean, null | Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM. | | created_atstring | Timestamp representing the date and time when the voucher was created in ISO 8601 format.Example:2021-12-22T10:13:06.487Z | | updated_atstring | Timestamp representing the date and time when the voucher was last updated in ISO 8601 format.Example:2021-12-22T10:14:45.316Z | | holder_idstring | Unique customer ID of voucher owner.Example:cust_eWgXlBBiY6THFRJwX45Iakv4 | | holder | See: Simple Customer | | objectstring | The type of object represented by JSON. Default is voucher. | | distributionsarray | Array of: | | deletedboolean | Flag indicating whether this voucher is deleted. | | validation_rules_assignments | See: Validation Rules Assignments List | | publishobject | This object stores a summary of publish events: an events counter and an endpoint which can be called to return details of each event. A publication is required for loyalty cards and referral codes. This object gets updated whenever a voucher has been published. Publication means assigning a code to a particular customer. Typically, a publication is made by distributing your codes to your customers, e.g. through Export to MailChimp or publish voucher API method.Required Optionaltype:LOYALTY_CARD type:DISCOUNT_VOUCHER is_referral_code:true type:GIFT_VOUCHERAttributes Descriptionobjectstring

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

  countinteger

  Publication events counter.

  Example:

  0

  urlstring

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

  Example:

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

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

  redeemed_quantityinteger

  How many times a voucher has already been redeemed.

  Example:

  1

  redeemed_amountinteger

  Total amount redeemed. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 balance is written as 10000.

  Example:

  100000

  redeemed_pointsinteger

  Total loyalty points redeemed.

  Example:

  100000

  objectstring

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

  urlstring

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

  Example:

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

Promotion Tier

Attributes	Description
idstring	Unique promotion tier ID.Example:promo_63fYCt81Aw0h7lzyRkrGZh9p
created_atstring	Timestamp representing the date and time when the promotion tier was created in ISO 8601 format.Example:2021-12-15T11:34:01.333Z
updated_atstring	Timestamp representing the date and time when the promotion tier was updated in ISO 8601 format.Example:2022-02-09T09:20:05.603Z
namestring	Name of the promotion tier.
bannerstring	Text to be displayed to your customers on your website.
actionobject	Contains details about the discount applied by the promotion tier.Attributes Descriptiondiscount See: Discount
metadataobject	The metadata object stores all custom attributes assigned to the promotion tier. A set of key/value pairs that you can attach to a promotion tier object. It can be useful for storing additional information about the promotion tier in a structured format.
hierarchyinteger	The promotions hierarchy defines the order in which the discounts from different tiers will be applied to a customer’s order. If a customer qualifies for discounts from more than one tier, discounts will be applied in the order defined in the hierarchy.
promotion_idstring	Promotion unique ID.
campaignobject	Contains details about promotion tier’s parent campaign.Attributes Descriptionidstring Unique campaign ID. start_datestring Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date. Example: 2022-09-22T00:00:00.000Z expiration_datestring Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date. Example: 2022-09-30T00:00:00.000Z validity_timeframeobject Recurrent time periods when the campaign is valid. For example, valid for 1 hour every other day. Attributes Descriptionintervalstring Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, a campaign with an interval of P2D will be active every other day. durationstring Defines the amount of time the campaign will be active in ISO 8601 format. For example, a campaign with a duration of P1D will be valid for a duration of one day. validity_day_of_weekarray Integer array corresponding to the particular days of the week in which the campaign is valid. 0 Sunday 1 Monday 2 Tuesday 3 Wednesday 4 Thursday 5 Friday 6 Saturday activeboolean A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it’s within the active period defined by the start_date and expiration_date using the Disable Campaign endpoint. true indicates an active campaign false indicates an inactive campaign category_idstring Unique category ID that this campaign belongs to. Example: cat_0b688929a2476386a6 objectstring The type of object represented by the campaign object. This object stores information about the campaign.
campaign_idstring	Promotion tier’s parent campaign’s unique ID.
activeboolean	A flag to toggle the promotion tier on or off. You can disable a promotion tier even though it’s within the active period defined by the start_date and expiration_date.- true indicates an active promotion tier

• false indicates an inactive promotion tier | | start_datestring | Activation timestamp defines when the promotion tier starts to be active in ISO 8601 format. Promotion tier is inactive before this date.Example:2022-09-23T00:00:00.000Z | | expiration_datestring | Activation timestamp defines when the promotion tier expires in ISO 8601 format. Promotion tier is inactive after this date.Example:2022-09-26T00:00:00.000Z | | validity_timeframeobject | Set recurrent time periods when the promotion tier is valid. For example, valid for 1 hour every other day.start_date required when including the validity_timeframe.Attributes Descriptionintervalstring

  Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, a promotion tier with an interval of P2D will be active every other day.

  durationstring

  Defines the amount of time the promotion tier will be active in ISO 8601 format. For example, a promotion tier with a duration of P1D will be valid for a duration of one day. | | validity_day_of_weekarray | Integer array corresponding to the particular days of the week in which the promotion tier is valid.- 0 Sunday

• 1 Monday

• 2 Tuesday

• 3 Wednesday

• 4 Thursday

• 5 Friday

• 6 Saturday | | summaryobject | Contains statistics about promotion tier redemptions and orders.Attributes Descriptionredemptionsobject

  Contains statistics about promotion tier redemptions.

  Attributes Descriptiontotal_redeemedinteger

  Number of times the promotion tier was redeemed.

  ordersobject

  Contains statistics about orders related to the promotion tier.

  Attributes Descriptiontotal_amountinteger

  Sum of order totals.

  total_discount_amountinteger

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

Redemption Reward Result

Attributes	Description
customer	Simple Customer
assignment_idstring, null	Unique reward assignment ID assigned by Voucherify.
voucher	Defines of the voucher.Voucher
product	Defines of the product.Product
sku	Defines of the sku.SKU Object
loyalty_tier_idstring, null	Unique loyalty tier ID assigned by Voucherify.
idstring	Unique reward ID.Example:rew_0bc92f81a6801f9bca
namestring	Name of the reward.Example:Reward Name
objectstring	The type of object represented by the JSONAvailable values: reward
created_atstring	Timestamp representing the date and time when the redemption was created in ISO 8601 format.Example:2021-12-22T10:13:06.487Z
updated_atstring	Timestamp in ISO 8601 format indicating when the reward was updated.Example:2022-10-03T12:24:58.008Z
parametersobject	These are parameters representing a material reward.Attributes Descriptioncampaignobject Defines the product redeemed as a reward. Attributes Descriptionidstring Campaign unique ID. Example: camp_13BbZ0kQsNinhqsX3wUts2UP balanceinteger Points available for reward redemption. typestring Defines the type of the campaign. productobject Defines the product redeemed as a reward. Attributes Descriptionidstring Unique product ID, assigned by Voucherify. Example: prod_0b7d7dfb05cbe5c616 sku_idstring A unique SKU ID assigned by Voucherify. Example: sku_0a41e31c7b41c28358 coinobject Defines the ratio by mapping the number of loyalty points in points_ratio to a predefined cash amount in exchange_ratio. Attributes Descriptionexchange_ratiointeger The cash equivalent of the points defined in the points_ratio property. points_ratiointeger The number of loyalty points that will map to the predefined cash amount defined by the exchange_ratio property.
typestring	Reward type.Available values: CAMPAIGN, COIN, MATERIAL

Order Response Base

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

Customer With Summary Loyalty Referrals

All of:

1. Customer Response Data

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

2. Customer Base

Customer Id

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

Referrer With Summary Loyalty Referrals

Customer With Summary Loyalty Referrals

Referrer Id

Customer Id

Error Object

Attributes	Description
codeinteger	Error’s HTTP status code.
keystring	Short string describing the kind of error which occurred.
messagestring	A human-readable message providing a short description about the error.
detailsstring	A human-readable message providing more details about the error.
request_idstring	This ID is useful when troubleshooting and/or finding the root cause of an error response by our support team.Example:v-0a885062c80375740f
resource_idstring	Unique resource ID that can be used in another endpoint to get more details.Example:rf_0c5d710a87c8a31f86
resource_typestring	The resource type.Example:voucher

Category

Attributes	Description
idstring	Unique category ID assigned by Voucherify.
namestring	Category name.
hierarchyinteger	Category hierarchy.
objectstring	The type of object represented by the JSON. This object stores information about the category.Available values: category
created_atstring	Timestamp representing the date and time when the category was created in ISO 8601 format.Example:2022-07-14T10:45:13.156Z
updated_atstring	Timestamp representing the date and time when the category was updated in ISO 8601 format.Example:2022-08-16T10:52:08.094Z
stacking_rules_typestring	The type of the stacking rule eligibility.Available values: JOINT, EXCLUSIVE

Discount

Contains information about discount.

One of:

Amount, Unit, Unit Multiple, Percent, Fixed

Voucher Assets

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

Validation Rules Assignments List

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

Validation Rule Assignments List

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

Product

This is an object representing a product.

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

All of:

1. Product without Skus Object

2. Attributes	Description
   skus	See: Skus List For Product

SKU Object

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

Order Item Calculated

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

Order Redemptions

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

Customer Summary

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

Customer Loyalty

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

Customer Referrals

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

Customer Base

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

Amount

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

Unit

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

Unit Multiple

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

Percent

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

Fixed

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

Business Validation Rule Assignment

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

Validation Rule Assignment

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

Product without Skus Object

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

Skus List For Product

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

Customer Summary Redemptions

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


amount\_to\_gointeger 

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

Customer Summary Orders

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

Discount Amount Vouchers Effect Types

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

Discount Unit Vouchers Effect Types

Available values: ADD_MISSING_ITEMS, ADD_NEW_ITEMS, ADD_MANY_ITEMS

Simple Product Discount Unit

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

Simple Sku Discount Unit

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

One Unit

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

Discount Percent Vouchers Effect Types

Available values: APPLY_TO_ORDER, APPLY_TO_ITEMS

Discount Fixed Vouchers Effect Types

Available values: APPLY_TO_ORDER, APPLY_TO_ITEMS