Data model description
Loyalty Card Object
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:Loyalty 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 Object | ||||||||||||||||||
typestring | Defines the type of voucher. Available values:LOYALTY_CARD | ||||||||||||||||||
discountnull | Object representing discount parameters. Child attributes are present only if | ||||||||||||||||||
giftnull | Object representing gift parameters. Child attributes are present only if | ||||||||||||||||||
loyalty_cardobject | Object representing loyalty card parameters. Child attributes are present only if
| ||||||||||||||||||
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.
| ||||||||||||||||||
validity_day_of_weekarray | Integer array corresponding to the particular days of the week in which the voucher is valid.
0 , 1 , 2 , 3 , 4 , 5 , 6 | ||||||||||||||||||
activeboolean | 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
| ||||||||||||||||||
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. | ||||||||||||||||||
assetsobject | Stores links to images of QR and barcode that correspond to an encrypted voucher code.
| ||||||||||||||||||
is_referral_codeboolean | Flag indicating whether this voucher is a referral code. | ||||||||||||||||||
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 | ||||||||||||||||||
redemptionobject | Stores a summary of redemptions that have been applied to the voucher.
| ||||||||||||||||||
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.
| ||||||||||||||||||
objectstring | The type of object represented by JSON. Default is |
Category Object
Attributes | Description |
---|---|
idstring | Unique category ID assigned by Voucherify. |
namestring | Category name. |
hierarchyinteger | Category hierarchy. |
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 |
objectstring | The type of object represented by the JSON. This object stores information about the category. |