Publication Object

Unique publication ID, assigned by Voucherify.

pub_BbjAXnmm8e0SIm3zG8qvvFCP0KuLywtp

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

Timestamp representing the date and time when the publication was created. The value is shown in the 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.

Status of the publication attempt.

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

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

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

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. The value is shown in the 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 customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify.

cust_eWgXlBBiY6THFRJwX45Iakv4

Unique identifier of the referring person.

cust_Vzck5i8U3OhcEUFY6MKhN9Rv

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

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.

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

Unique category ID assigned by Voucherify.

Category name.

Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value.

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

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

2022-07-14T10:45:13.156Z

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

2022-08-16T10:52:08.094Z

The type of the object represented by JSON. This object stores information about validation rules assignments.

Identifies the name of the attribute that contains the array of validation rules assignments.

Contains array of validation rules assignments.

Total number of validation rules assignments.

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.

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.

PT1H

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.

P2D

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

Stores Quick Response (QR) representation of encrypted code.

Stores barcode representation of encrypted code.

The unique identifier for a assignment

The unique identifier for a rule

The unique identifier for a related object

The type of related object

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

2022-03-09T11:19:04.819Z

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

2022-03-09T11:19:04.819Z

The type of the object represented by JSON.

The validation status of the assignment

The list of omitted rules

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

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.

Defines the type of the voucher.

The percent discount that the customer will receive.

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.

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.

Defines the type of the voucher.

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.

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

Flag indicating whether the discount was calculated using a formula.

Unique product ID, assigned by Voucherify.

Product's source ID.

Product name.

Unique SKU ID, assigned by Voucherify.

Product variant's source ID.

Sku name

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.

Contains information about the sku.