Customer Activity Object

Unique event ID, assigned by Voucherify.

evcus_0c150c51730c6b60b1

Event type.

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

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

2022-08-30T09:14:07.660Z

Unique identifier of the request that caused the event.

v-1f36113948e50fc4ge

Details about the referral.

Details about the loyalty activity.

Balance changed by the event.

2022-02-25T13:32:08.734Z

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

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.

Customer's first and last name.

Customer's email address.

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.

The type of object represented by JSON.

Campaign ID.

Campaign name.

Type of campaign.

Defines whether the campaign can be updated with new vouchers after campaign creation.

• AUTO_UPDATE: By choosing the auto update option you will create a campaign that can be enhanced by new vouchers after the time of creation (e.g. by publish vouchers method).
• STATIC: vouchers need to be manually published.

Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.

Indicates whether customers will be able to auto-join the campaign if any earning rule is fulfilled.

If this value is set to true, customers will be able to join the campaign only once.

Indicates whether the campaign is active.

Unique category name.

The unique category ID that this campaign belongs to.

Contains details about the category.

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.

Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date.

2022-09-20T00:00:00.000Z

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

2022-09-30T00:00:00.000Z

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

Timestamp representing the date and time when the campaign was created. Timestamp is presented in the ISO 8601 format.

2024-01-01T11:11:11.111Z

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

2024-01-01T11:11:11.111Z

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

A unique identifier that represents the voucher assigned by Voucherify.

Voucher code.

Gift object response.

Defines the loyalty card details.

Type of the voucher.

Campaign name.

Campaign unique ID.

Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.

Unique customer ID of the campaign owner.

cust_eWgXlBBiY6THFRJwX45Iakv4

Unique identifier of the referrer assigned by Voucherify.

cust_nM4jqPiaXUvQdVSA6vTRUnix

Unique identifier of the category that this voucher belongs to.

cat_0b6152ce12414820dc

Contains details about the category.

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

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

2021-12-22T10:13:06.487Z

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

2024-01-01T11:11:11.111Z

Defines the redemption limits on vouchers.

Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date.

2021-12-01T00:00:00.000Z

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

2021-12-31T00:00:00.000Z

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.

The type of object represented by JSON.

Unique custom event ID.

The object represented is an event.

The event name.

A simple customer object

Referral object.

Loyalty 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.

Timestamp representing the date and time when the custom event was created. Timestamp is presented in the ISO 8601 format.

2021-12-22T10:13:06.487Z

Unique redemption ID.

r_0bc92f81a6801f9bca

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

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

2021-12-22T10:13:06.487Z

Hashed customer source ID.

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

The source of the channel for the redemption rollback. A USER corresponds to the Voucherify Dashboard and an API corresponds to the API.

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.

user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH

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

customer_rules_violated

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

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.

10000

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

Redemption result.

Redemption status.

Unique redemption ID of the parent redemption.

r_0c656311b5878a2031

Unique redemption ID of the parent redemption.

r_0c656311b5878a2031

Unique customer ID of the redeeming customer.

cust_i8t5Tt6eiKG5K79KQlJ0Vs64

Defines the related object.

Unique related object ID assigned by Voucherify, i.e. v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno for a voucher.

Unique related parent object ID assigned by Voucherify, i.e. v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno for a voucher.

Campaign name

Defines the details of the voucher being redeemed.

Contains details of the promotion tier and the parent campaign.

Unique identifier of the custom event.

Name of the custom event.

Unique segment ID.

seg_DNAOhUtJffvX0f57ajLMFBYR

Segment name.

The type of object represented by the ID.

Timestamp representing the date and time when the distribution was sent in ISO 8601 format.

2021-12-22T10:13:06.487Z

Timestamp representing the date and time when the distribution was recovered in ISO 8601 format.

2021-12-22T10:13:06.487Z

Timestamp representing the date and time when the distribution failed in ISO 8601 format.

2021-12-22T10:13:06.487Z

Unique reward assignment ID assigned by Voucherify.

Defines of the voucher.

Defines of the product.

Defines of the sku.

Unique loyalty tier ID assigned by Voucherify.

Unique reward ID, assigned by Voucherify.

rew_nIy4gHpQHle2c3pNMwuj7G6j

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

Reward name.

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

2022-08-11T14:49:22.586Z

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

2022-08-11T16:01:34.885Z

Defines how the reward is generated.

Reward type.

Unique referral tier ID.

seg_DNAOhUtJffvX0f57ajLMFBYR

Campaign Id.

Text to be displayed to your customers on your website.

Referral tier parameters

Unique transaction ID.

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.

Unique voucher ID.

Unqiue campaign ID of the voucher's parent campaign if it is part of campaign that generates bulk codes.

The channel through which the transaction took place, whether through the API or the the Dashboard. In case of a redemption, this value is null.

Reason why the transaction occurred. In case of a redemption, this value is null.

Type of transaction.

Contains the detailed information about the transaction.

The related transaction ID on the receiving card.

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

Unique validation id.

Unique session id.

The validation status

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

2021-12-22T10:13:06.487Z

Unique customer ID of the customer making the purchase.

cust_7iUa6ICKyU6gH40dBU25kQU1

Lists validation results of each redeemable.

Lists validation results of each redeemable.

Lists validation results of each redeemable.

Unique redemption ID.

r_0bc92f81a6801f9bca

Unique customer ID of the redeeming customer.

cust_i8t5Tt6eiKG5K79KQlJ0Vs64

Hashed customer source ID.

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

2021-12-22T10:13:06.487Z

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.

10000

Redemption result.

Defines the details of the voucher being redeemed.

Unique redemption ID of the parent redemption.

r_0c656311b5878a2031

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

Customer's loyalty points.

Total number of customers referred by the customer.

Contains campaigns with details about point balances and how many customers were referred by the customer.

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

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

Customer Referrals Campaigns Item

Customer's first and last name.

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

Customer's email address.

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

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

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

Customer's address.

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.

Type of the voucher.

Defines the voucher discount type and details.

Defines the voucher gift details.

Defines the voucher loyalty card details.

Defines the redemption limits on vouchers.

It represents the total number of winners in a lucky draw.

It indicates whether each winner in a draw is unique or not.

Specifies whether each participant can win only once across multiple draws.

Define how a referral is triggered.

Contains details about the custom event.

Defines the referee reward.

Unique category ID assigned by Voucherify.

Category name.

Category hierarchy.

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

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

2022-07-14T10:45:13.156Z

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

2022-08-16T10:52:08.094Z

The type of the stacking rule eligibility.

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.

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

Defines how the credits are applied to the customer's order.

Total points incurred over lifespan of loyalty card.

Points available for reward redemption.

The next closest date when the next set of points are due to expire.

The amount of points that are set to expire next.

The unique ID of a customer that is assigned by Voucherify.

cust_CSnYd37MXmrbS19XCrghjBsv

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.

Customer's first and last name.

Customer's email address.

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.

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

Unique reward assignment ID assigned by Voucherify.

Defines of the voucher.

Defines of the product.

Defines of the sku.

Unique loyalty tier ID assigned by Voucherify.

Unique reward ID.

rew_0bc92f81a6801f9bca

Name of the reward.

Reward Name

The type of object represented by the JSON

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

2021-12-22T10:13:06.487Z

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

2022-10-03T12:24:58.008Z

These are parameters representing a material reward.

Reward type.

Assigned by the Voucherify API, identifies the voucher.

v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV

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

WVPblOYX

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

Gift Card Campaign

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

camp_FNYR4jhqZBM9xTptxDGgeNBV

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

Unique category ID assigned by Voucherify.

cat_0bb343dee3cdb5ec0c

Contains details about the category.

Defines the type of the voucher.

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

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

Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date.

2021-12-01T00:00:00.000Z

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

2021-12-31T00:00:00.000Z

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.

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

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

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

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.

Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.

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

2021-12-22T10:13:06.487Z

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

2021-12-22T10:14:45.316Z

Unique identifier of the customer who owns the voucher.

cust_eWgXlBBiY6THFRJwX45Iakv4

Unique identifier of the referring person.

cust_Vzck5i8U3OhcEUFY6MKhN9Rv

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

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.

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

Unique promotion tier ID.

promo_63fYCt81Aw0h7lzyRkrGZh9p

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

2021-12-15T11:34:01.333Z

Timestamp representing the date and time when the promotion tier was updated in ISO 8601 format.

2022-02-09T09:20:05.603Z

Name of the promotion tier.

Text to be displayed to your customers on your website.

Contains details about the discount applied by the promotion tier.

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.

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 unique ID.

Contains details about promotion tier's parent campaign.

Promotion tier's parent campaign's unique ID.

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

Activation timestamp defines when the promotion tier starts to be active in ISO 8601 format. Promotion tier is inactive before this date.

2022-09-23T00:00:00.000Z

Activation timestamp defines when the promotion tier expires in ISO 8601 format. Promotion tier is inactive after this date.

2022-09-26T00:00:00.000Z

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.

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

Contains statistics about promotion tier redemptions and orders.

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

Promotion tier category ID.

cat_0c9da30e7116ba6bba

Unique product ID.

Product source id.

Product name.

Unique sku ID.

Sku source id.

Sku name.

Loyalty Tier name.

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

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

Defines range of loyalty tier in points.

Unique customer ID of the customer making the purchase.

cust_7iUa6ICKyU6gH40dBU25kQU1

Unique campaign ID, assigned by Voucherify.

camp_rRsfatlwN7unSeUIJDCYedal

Unique tier ID, assigned by Voucherify.

Activation timestamp defines when the loyalty tier starts to be active in ISO 8601 format. Loyalty tier is inactive before this date.

Expiration timestamp defines when the loyalty tier expires in ISO 8601 format. Loyalty tier is inactive after this date.

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

2021-12-22T10:13:06.487Z

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

2021-12-22T10:13:06.487Z

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

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

Defines the event which triggers the earning rule to add points to a loyalty card.

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

Contains the custom earning rule name and parent campaign.

The type of object represented by JSON. Default is earning_rule.

For internal use by Voucherify.

Start date defines when the earning rule starts to be active. Activation timestamp is presented in the ISO 8601 format. Earning rule is inactive before this date. If you don't define the start date for an earning rule, it'll inherit the campaign start date by default.

Expiration date defines when the earning rule expires. Expiration timestamp is presented in the ISO 8601 format. Earning rule is inactive after this date.If you don't define the expiration date for an earning rule, it'll inherit the campaign expiration date by default.

Set recurrent time periods when the earning rule is valid. For example, valid for 1 hour every other day.start_date required when including the validity_timeframe.

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

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

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.

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

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

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

2021-12-22T10:13:06.487Z

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

2021-12-22T10:14:45.316Z

The order status.

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.

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.

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

Sum of all product-specific discounts applied to the order.

Sum of all order-level AND all product-specific discounts applied to the order.

Order amount after undoing all the discounts through the rollback redemption.

This field shows the order-level discount applied.

Sum of all product-specific discounts applied in a particular request.
sum(items, i => i.applied_discount_amount)

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

Array of items applied to the order.

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.

Unique customer ID of the customer making the purchase.

cust_7iUa6ICKyU6gH40dBU25kQU1

Unique referrer ID.

cust_nM4jqPiaXUvQdVSA6vTRUnix

The type of object represented by JSON.

A unique identifier of an existing customer.

The type of object represented by JSON.

Unique publication ID, assigned by Voucherify.

pub_BbjAXnmm8e0SIm3zG8qvvFCP0KuLywtp

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

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

2022-09-23T09:57:00.434Z

Unique customer ID of the customer receiving the publication.

cust_eWgXlBBiY6THFRJwX45Iakv4

Customer's source_id.

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.

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

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.

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

Voucher code.

The type of object represented by JSON.

Campaign name

Gift object response

Defines the loyalty card details.

Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.

Indicates whether the redeemable can be applied or not applied based on the validation rules.

Redeemable ID, i.e. the voucher code.

Redeemable's object type.

Specifies the redeemable's end effect on the order. This object is unique to each type of redeemable.

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

Indicates whether the redeemable can be applied or not applied based on the validation rules.

Redeemable ID, i.e. the voucher code.

Redeemable's object type.

Indicates whether the redeemable can be applied or not applied based on the validation rules.

Redeemable ID, i.e. the voucher code.

Redeemable's object type.

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

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

The order status.

Unique customer ID of the customer making the purchase.

cust_7iUa6ICKyU6gH40dBU25kQU1

Unique referrer ID.

cust_nM4jqPiaXUvQdVSA6vTRUnix

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.

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

This field shows the order-level discount applied.

Sum of all product-specific discounts applied to the order.

Sum of all product-specific discounts applied in a particular request.
sum(items, i => i.applied_discount_amount)

Sum of all order-level AND all product-specific discounts applied to the order.

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

Order amount after undoing all the discounts through the rollback redemption.

Array of items applied to the order.

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.

The type of object represented by JSON.

Unique promotion tier ID.

promo_63fYCt81Aw0h7lzyRkrGZh9p

Name of the promotion tier.

Text to be displayed to your customers on your website.

Contains details about promotion tier's parent campaign.

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.

Unique identifier of the promotion stack.

Name of the promotion stack.

Unique identifier of the category of the promotion stack.

Represents simplified promotion stack campaign data.

Contains the tier configuration.

Total number of redemptions made by the customer.

Total number of redemptions that failed.

Total number of redemptions that succeeded.

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

Total number of redemption rollbacks that failed.

Total number of redemption rollbacks that succeeded.

Summary of gift card credits.

Summary of loyalty points.

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 number of orders made by the customer.

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.

Amount spent on last order. Value is multiplied by 100 to precisely represent 2 decimal places. For example 10000 cents for $100.00.

Timestamp representing the date and time of the customer's last order in ISO 8601 format.

2022-08-30T11:51:08.029Z

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.

Defines the type of the voucher.

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.

Maximum discount amount per order.

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

Flag indicating whether the discount was calculated using a formula.

Discount type.

Number of units to be granted a full value discount.

Defines how the unit is added to the customer's order.

The product deemed as free, chosen from product inventory (e.g. time, items).

Contains information about the product.

Flag indicating whether the discount was calculated using a formula.

Discount type.

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