> ## Documentation Index > Fetch the complete documentation index at: https://docs.voucherify.io/llms.txt > Use this file to discover all available pages before exploring further. # Publication Object

Publications Create Response Body

Response body schema for POST v1/publication and GET v1/publications/create.

One of:

  1. Publications Create Voucher Response Body
  2. Publications Create Vouchers Response Body

Publications Create Voucher Response Body

Response body schema for POST v1/publication and GET v1/publications/create.

All of:

  1. Publications Create Base Response Body
  2. Attributes Description

    voucher

    		 See: Voucher

Publications Create Vouchers Response Body

Response body schema for POST v1/publication and GET v1/publications/create.

All of:

  1. Publications Create Base Response Body
  2. Attributes Description

    vouchers
    array

    Contains the unique voucher codes that was assigned by Voucherify.

Publications Create Base Response Body

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.

channel
string

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

Available values: API

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.

result
string

Status of the publication attempt.

Available values: SUCCESS

customer

 See: Customer With Summary Loyalty Referrals

vouchers\_id
array

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

Voucher

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

All of:

  1. Voucher Base
  2. Attributes Description

    categories
    array

    Contains details about the category.

    Array of Category

    validation\_rules\_assignments

    		 See: Validation Rules Assignments List

Customer With Summary Loyalty Referrals

All of:

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

  2. Customer Base

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

Category

Attributes Description

id
string

Unique category ID assigned by Voucherify.

name
string

Category name.

hierarchy
integer

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

object
string

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

Available values: category

created\_at
string

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

Example: 2022-07-14T10:45:13.156Z

updated\_at
string

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

Example: 2022-08-16T10:52:08.094Z

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.

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.

Discount

Contains information about discount.

One of:

  1. Amount
  2. Unit
  3. Unit Multiple
  4. Percent
  5. Fixed

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.

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

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

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

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.

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