Endpoints
curl --request GET \
--url https://{cluster}.voucherify.io/v1/redemptions \
--header 'Authorization: Bearer <token>' \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"object": "list",
"data_ref": "redemptions",
"redemptions": [
{
"id": "r_0bc92f81a6801f9bca",
"object": "redemption",
"date": "2021-12-22T10:13:06.487Z",
"customer_id": "cust_i8t5Tt6eiKG5K79KQlJ0Vs64",
"tracking_id": "<string>",
"metadata": {},
"redemption": "r_0c656311b5878a2031",
"result": "SUCCESS",
"status": "SUCCEEDED",
"order": {
"id": "<string>",
"source_id": "<string>",
"status": "CREATED",
"amount": 123,
"initial_amount": 123,
"discount_amount": 123,
"items_discount_amount": 123,
"total_discount_amount": 123,
"total_amount": 123,
"applied_discount_amount": 123,
"items_applied_discount_amount": 123,
"total_applied_discount_amount": 123,
"metadata": {},
"object": "order",
"created_at": "2021-12-22T10:13:06.487Z",
"updated_at": "2021-12-22T10:14:45.316Z",
"customer_id": "cust_7iUa6ICKyU6gH40dBU25kQU1",
"referrer_id": "cust_nM4jqPiaXUvQdVSA6vTRUnix",
"customer": {
"id": "<string>",
"object": "customer"
},
"referrer": {
"id": "<string>",
"object": "customer"
},
"redemptions": {},
"items": [
{
"object": "order_item",
"id": "<string>",
"sku_id": "<string>",
"product_id": "<string>",
"related_object": "product",
"source_id": "<string>",
"quantity": 123,
"discount_quantity": 123,
"initial_quantity": 123,
"amount": 123,
"discount_amount": 123,
"applied_discount_amount": 123,
"applied_discount_quantity": 123,
"applied_quantity": 123,
"applied_quantity_amount": 123,
"initial_amount": 123,
"price": 123,
"subtotal_amount": 123,
"product": {
"id": "<string>",
"source_id": "<string>",
"override": true,
"name": "<string>",
"metadata": {},
"price": 123
},
"sku": {
"id": "<string>",
"source_id": "<string>",
"override": true,
"sku": "<string>",
"price": 123,
"metadata": {}
},
"metadata": {},
"application_details": [
{
"source_index": 1,
"source_applied_quantity": -2,
"source_applied_quantity_amount": -1,
"target_index": 123,
"target_applied_quantity": 123,
"target_applied_quantity_amount": 123,
"target_applied_discount_amount": 123
}
]
}
]
},
"channel": {
"channel_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH",
"channel_type": "USER"
},
"customer": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"source_id": "<string>",
"metadata": {},
"object": "customer"
},
"related_object_type": "voucher",
"related_object_id": "<string>",
"amount": 10000,
"session": {
"key": "<string>"
},
"related_redemptions": {
"rollbacks": [
{
"id": "rr_0bc92f81a6801f9bca",
"date": "2021-12-22T10:13:06.487Z",
"rollback_order_mode": "WITH_ORDER"
}
],
"redemptions": [
{
"id": "r_0bc92f81a6801f9bca",
"date": "2021-12-22T10:13:06.487Z"
}
]
},
"failure_code": "customer_rules_violated",
"failure_message": "<string>",
"promotion_tier": {
"id": "promo_63fYCt81Aw0h7lzyRkrGZh9p",
"created_at": "2021-12-15T11:34:01.333Z",
"updated_at": "2022-02-09T09:20:05.603Z",
"name": "<string>",
"banner": "<string>",
"action": {
"discount": {
"type": "AMOUNT",
"amount_off": 123,
"amount_off_formula": "<string>",
"aggregated_amount_limit": 123,
"effect": "APPLY_TO_ORDER",
"is_dynamic": true
}
},
"metadata": {},
"hierarchy": 123,
"promotion_id": "<string>",
"campaign": {
"id": "<string>",
"start_date": "2022-09-22T00:00:00.000Z",
"expiration_date": "2022-09-30T00:00:00.000Z",
"validity_timeframe": {
"duration": "PT1H",
"interval": "P2D"
},
"validity_day_of_week": [
0
],
"validity_hours": {
"daily": [
{
"start_time": "12:00",
"days_of_week": [
0
],
"expiration_time": "14:00"
}
]
},
"active": true,
"category_id": "cat_0b688929a2476386a6",
"object": "campaign"
},
"campaign_id": "<string>",
"active": true,
"start_date": "2022-09-23T00:00:00.000Z",
"expiration_date": "2022-09-26T00:00:00.000Z",
"validity_timeframe": {
"duration": "PT1H",
"interval": "P2D"
},
"validity_day_of_week": [
0
],
"validity_hours": {
"daily": [
{
"start_time": "12:00",
"days_of_week": [
0
],
"expiration_time": "14:00"
}
]
},
"summary": {
"redemptions": {
"total_redeemed": 123
},
"orders": {
"total_amount": 123,
"total_discount_amount": 123
}
},
"object": "promotion_tier",
"validation_rule_assignments": {
"object": "list",
"data_ref": "data",
"data": [
{
"id": "asgm_74F7QZoYbUoljwQO",
"rule_id": "val_4j7DCRm2IS59",
"related_object_id": "v_JtWunK6jUo7X2qOFj0SyRHq4p9tgENlT",
"related_object_type": "voucher",
"created_at": "2022-02-17T08:18:15.085Z",
"object": "validation_rules_assignment"
}
],
"total": 123
},
"category_id": "cat_0c9da30e7116ba6bba",
"categories": [
{
"id": "<string>",
"name": "<string>",
"hierarchy": 1,
"object": "category",
"created_at": "2022-07-14T10:45:13.156Z",
"updated_at": "2022-08-16T10:52:08.094Z"
}
]
},
"reward": {
"customer": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"source_id": "<string>",
"metadata": {},
"object": "customer"
},
"assignment_id": "<string>",
"voucher": {
"id": "v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV",
"code": "WVPblOYX",
"campaign": "Gift Card Campaign",
"campaign_id": "camp_FNYR4jhqZBM9xTptxDGgeNBV",
"category": "<string>",
"category_id": "cat_0bb343dee3cdb5ec0c",
"type": "GIFT_VOUCHER",
"discount": {
"type": "AMOUNT",
"amount_off": 123,
"amount_off_formula": "<string>",
"aggregated_amount_limit": 123,
"effect": "APPLY_TO_ORDER",
"is_dynamic": true
},
"gift": {
"amount": 10000,
"subtracted_amount": 123,
"balance": 500,
"effect": "APPLY_TO_ORDER"
},
"loyalty_card": {
"points": 7000,
"balance": 6970,
"next_expiration_date": "2023-05-30",
"next_expiration_points": 123,
"pending_points": 123,
"expired_points": 123,
"subtracted_points": 123
},
"start_date": "2021-12-01T00:00:00.000Z",
"expiration_date": "2021-12-31T00:00:00.000Z",
"validity_timeframe": {
"duration": "PT1H",
"interval": "P2D"
},
"validity_day_of_week": [
0
],
"validity_hours": {
"daily": [
{
"start_time": "12:00",
"days_of_week": [
0
],
"expiration_time": "14:00"
}
]
},
"active": true,
"additional_info": "<string>",
"metadata": {},
"assets": {
"qr": {
"id": "U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK+t4pp7U7oFzjGJzj9q/bmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg+BaZk5QwXMf8k/OzSlOEVybpwSq+AiqPoNtjeuqtIgkDyvT6Q==",
"url": "https://dev.dl.voucherify.io/api/v1/assets/qr/U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK%2Bt4pp7U7oFzjGJzj9q%2FbmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg%2BBaZk5QwXMf8k%2FOzSlOEVybpwSq%2BAiqPoNtjeuqtIgkDyvT6Q%3D%3D"
},
"barcode": {
"id": "U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ==",
"url": "https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D"
}
},
"is_referral_code": true,
"created_at": "2021-12-22T10:13:06.487Z",
"updated_at": "2021-12-22T10:14:45.316Z",
"holder_id": "cust_eWgXlBBiY6THFRJwX45Iakv4",
"referrer_id": "cust_Vzck5i8U3OhcEUFY6MKhN9Rv",
"object": "voucher",
"publish": {
"object": "list",
"count": 0,
"url": "/v1/vouchers/WVPblOYX/publications?page=1&limit=10"
},
"redemption": {
"quantity": 123,
"redeemed_quantity": 1,
"redeemed_points": 100000,
"object": "list",
"url": "/v1/vouchers/WVPblOYX/redemptions?page=1&limit=10"
},
"categories": [
{
"id": "<string>",
"name": "<string>",
"hierarchy": 1,
"object": "category",
"created_at": "2022-07-14T10:45:13.156Z",
"updated_at": "2022-08-16T10:52:08.094Z"
}
],
"validation_rules_assignments": {
"object": "list",
"data_ref": "data",
"data": [
{
"id": "asgm_LnY1g7UNFA9KyDrD",
"rule_id": "val_3gPNA6SnH4ae",
"related_object_id": "camp_CZOnEGiZfwIKWmSjhIoIT7Ol",
"related_object_type": "campaign",
"object": "validation_rules_assignment",
"validation_status": "PARTIALLY_VALID",
"validation_omitted_rules": [
"1"
]
}
],
"total": 1
}
},
"product": {
"id": "prod_0b1da8105693710357",
"source_id": "productSourceID16",
"name": "T-shirt",
"price": 123,
"attributes": [
"<string>"
],
"metadata": {},
"object": "product",
"image_url": "https://images.com/original.jpg",
"created_at": "2022-05-23T06:52:55.008Z",
"updated_at": "2022-05-23T09:24:07.405Z",
"skus": {
"object": "list",
"data_ref": "data",
"data": [
{
"id": "sku_0b1621b319d248b79f",
"source_id": "sku_source_id_4",
"product_id": "prod_0b15f6b9f650c16990",
"sku": "Large Pink Shirt",
"price": 123,
"attributes": {},
"image_url": "<string>",
"metadata": {},
"created_at": "2022-05-17T10:36:30.187Z",
"updated_at": "2022-05-17T10:55:09.137Z",
"object": "sku",
"currency": "USD"
}
],
"total": 123
}
},
"sku": {
"id": "sku_0b1621b319d248b79f",
"source_id": "sku_source_id_4",
"product_id": "prod_0b15f6b9f650c16990",
"sku": "Large Pink Shirt",
"price": 123,
"attributes": {},
"image_url": "<string>",
"metadata": {},
"created_at": "2022-05-17T10:36:30.187Z",
"updated_at": "2022-05-17T10:55:09.137Z",
"object": "sku",
"currency": "USD"
},
"loyalty_tier_id": "<string>",
"id": "rew_0bc92f81a6801f9bca",
"name": "Reward Name",
"object": "reward",
"created_at": "2021-12-22T10:13:06.487Z",
"updated_at": "2022-10-03T12:24:58.008Z",
"parameters": {
"campaign": {
"id": "camp_13BbZ0kQsNinhqsX3wUts2UP",
"balance": 123,
"type": "<string>"
},
"product": {
"id": "prod_0b7d7dfb05cbe5c616",
"sku_id": "sku_0a41e31c7b41c28358"
},
"coin": {
"exchange_ratio": 123,
"points_ratio": 123
}
},
"metadata": {},
"type": "CAMPAIGN"
},
"gift": {
"amount": 123
},
"loyalty_card": {
"points": 123
},
"voucher": {
"id": "v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV",
"code": "WVPblOYX",
"campaign": "Gift Card Campaign",
"campaign_id": "camp_FNYR4jhqZBM9xTptxDGgeNBV",
"category": "<string>",
"category_id": "cat_0bb343dee3cdb5ec0c",
"type": "GIFT_VOUCHER",
"discount": {
"type": "AMOUNT",
"amount_off": 123,
"amount_off_formula": "<string>",
"aggregated_amount_limit": 123,
"effect": "APPLY_TO_ORDER",
"is_dynamic": true
},
"gift": {
"amount": 10000,
"subtracted_amount": 123,
"balance": 500,
"effect": "APPLY_TO_ORDER"
},
"loyalty_card": {
"points": 7000,
"balance": 6970,
"next_expiration_date": "2023-05-30",
"next_expiration_points": 123,
"pending_points": 123,
"expired_points": 123,
"subtracted_points": 123
},
"start_date": "2021-12-01T00:00:00.000Z",
"expiration_date": "2021-12-31T00:00:00.000Z",
"validity_timeframe": {
"duration": "PT1H",
"interval": "P2D"
},
"validity_day_of_week": [
0
],
"validity_hours": {
"daily": [
{
"start_time": "12:00",
"days_of_week": [
0
],
"expiration_time": "14:00"
}
]
},
"active": true,
"additional_info": "<string>",
"metadata": {},
"assets": {
"qr": {
"id": "U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK+t4pp7U7oFzjGJzj9q/bmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg+BaZk5QwXMf8k/OzSlOEVybpwSq+AiqPoNtjeuqtIgkDyvT6Q==",
"url": "https://dev.dl.voucherify.io/api/v1/assets/qr/U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK%2Bt4pp7U7oFzjGJzj9q%2FbmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg%2BBaZk5QwXMf8k%2FOzSlOEVybpwSq%2BAiqPoNtjeuqtIgkDyvT6Q%3D%3D"
},
"barcode": {
"id": "U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ==",
"url": "https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D"
}
},
"is_referral_code": true,
"created_at": "2021-12-22T10:13:06.487Z",
"updated_at": "2021-12-22T10:14:45.316Z",
"holder_id": "cust_eWgXlBBiY6THFRJwX45Iakv4",
"referrer_id": "cust_Vzck5i8U3OhcEUFY6MKhN9Rv",
"object": "voucher",
"publish": {
"object": "list",
"count": 0,
"url": "/v1/vouchers/WVPblOYX/publications?page=1&limit=10"
},
"redemption": {
"quantity": 123,
"redeemed_quantity": 1,
"redeemed_points": 100000,
"object": "list",
"url": "/v1/vouchers/WVPblOYX/redemptions?page=1&limit=10"
},
"categories": [
{
"id": "<string>",
"name": "<string>",
"hierarchy": 1,
"object": "category",
"created_at": "2022-07-14T10:45:13.156Z",
"updated_at": "2022-08-16T10:52:08.094Z"
}
],
"validation_rules_assignments": {
"object": "list",
"data_ref": "data",
"data": [
{
"id": "asgm_LnY1g7UNFA9KyDrD",
"rule_id": "val_3gPNA6SnH4ae",
"related_object_id": "camp_CZOnEGiZfwIKWmSjhIoIT7Ol",
"related_object_type": "campaign",
"object": "validation_rules_assignment",
"validation_status": "PARTIALLY_VALID",
"validation_omitted_rules": [
"1"
]
}
],
"total": 1
},
"holder": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"source_id": "<string>",
"metadata": {},
"object": "customer"
}
}
}
],
"total": 123
}List Redemptions
Returns a list of redemptions previously created. The redemptions are returned in a sorted order, with the most recent redemptions appearing first. The response returns a list of redemptions of all vouchers.
Filtering results
The result can be narrowed according to specified (or default) filters, for example, you can sort redemptions by date:
https://api.voucherify.io/v1/redemptions?limit=3&[created_at][before]=2017-09-08T13:52:18.227Z.
A filter based on the object created_at field narrows down the results and lists redemptions done before or after a particular date time. You can use the following options: [created_at][after], [created_at][before].
A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [created_at][before]=2017-09-08T13:52:18.227Z.
Failed Redemptions
A redemption may fail for various reasons. You can figure out an exact reason from the failure_code:
resource_not_found- voucher with given code does not existvoucher_not_active- voucher is not active yet (before start date)voucher_expired- voucher has already expired (after expiration date)voucher_disabled- voucher has been disabled (active: false)quantity_exceeded- voucher’s redemptions limit has been exceededgift_amount_exceeded- gift amount has been exceededcustomer_rules_violated- customer did not match the segmentorder_rules_violated- order did not match validation rulesinvalid_order- order was specified incorrectlyinvalid_amount- order amount was specified incorrectlymissing_amount- order amount was not specifiedmissing_order_items- order items were not specifiedmissing_customer- customer was not specified
curl --request GET \
--url https://{cluster}.voucherify.io/v1/redemptions \
--header 'Authorization: Bearer <token>' \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"object": "list",
"data_ref": "redemptions",
"redemptions": [
{
"id": "r_0bc92f81a6801f9bca",
"object": "redemption",
"date": "2021-12-22T10:13:06.487Z",
"customer_id": "cust_i8t5Tt6eiKG5K79KQlJ0Vs64",
"tracking_id": "<string>",
"metadata": {},
"redemption": "r_0c656311b5878a2031",
"result": "SUCCESS",
"status": "SUCCEEDED",
"order": {
"id": "<string>",
"source_id": "<string>",
"status": "CREATED",
"amount": 123,
"initial_amount": 123,
"discount_amount": 123,
"items_discount_amount": 123,
"total_discount_amount": 123,
"total_amount": 123,
"applied_discount_amount": 123,
"items_applied_discount_amount": 123,
"total_applied_discount_amount": 123,
"metadata": {},
"object": "order",
"created_at": "2021-12-22T10:13:06.487Z",
"updated_at": "2021-12-22T10:14:45.316Z",
"customer_id": "cust_7iUa6ICKyU6gH40dBU25kQU1",
"referrer_id": "cust_nM4jqPiaXUvQdVSA6vTRUnix",
"customer": {
"id": "<string>",
"object": "customer"
},
"referrer": {
"id": "<string>",
"object": "customer"
},
"redemptions": {},
"items": [
{
"object": "order_item",
"id": "<string>",
"sku_id": "<string>",
"product_id": "<string>",
"related_object": "product",
"source_id": "<string>",
"quantity": 123,
"discount_quantity": 123,
"initial_quantity": 123,
"amount": 123,
"discount_amount": 123,
"applied_discount_amount": 123,
"applied_discount_quantity": 123,
"applied_quantity": 123,
"applied_quantity_amount": 123,
"initial_amount": 123,
"price": 123,
"subtotal_amount": 123,
"product": {
"id": "<string>",
"source_id": "<string>",
"override": true,
"name": "<string>",
"metadata": {},
"price": 123
},
"sku": {
"id": "<string>",
"source_id": "<string>",
"override": true,
"sku": "<string>",
"price": 123,
"metadata": {}
},
"metadata": {},
"application_details": [
{
"source_index": 1,
"source_applied_quantity": -2,
"source_applied_quantity_amount": -1,
"target_index": 123,
"target_applied_quantity": 123,
"target_applied_quantity_amount": 123,
"target_applied_discount_amount": 123
}
]
}
]
},
"channel": {
"channel_id": "user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH",
"channel_type": "USER"
},
"customer": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"source_id": "<string>",
"metadata": {},
"object": "customer"
},
"related_object_type": "voucher",
"related_object_id": "<string>",
"amount": 10000,
"session": {
"key": "<string>"
},
"related_redemptions": {
"rollbacks": [
{
"id": "rr_0bc92f81a6801f9bca",
"date": "2021-12-22T10:13:06.487Z",
"rollback_order_mode": "WITH_ORDER"
}
],
"redemptions": [
{
"id": "r_0bc92f81a6801f9bca",
"date": "2021-12-22T10:13:06.487Z"
}
]
},
"failure_code": "customer_rules_violated",
"failure_message": "<string>",
"promotion_tier": {
"id": "promo_63fYCt81Aw0h7lzyRkrGZh9p",
"created_at": "2021-12-15T11:34:01.333Z",
"updated_at": "2022-02-09T09:20:05.603Z",
"name": "<string>",
"banner": "<string>",
"action": {
"discount": {
"type": "AMOUNT",
"amount_off": 123,
"amount_off_formula": "<string>",
"aggregated_amount_limit": 123,
"effect": "APPLY_TO_ORDER",
"is_dynamic": true
}
},
"metadata": {},
"hierarchy": 123,
"promotion_id": "<string>",
"campaign": {
"id": "<string>",
"start_date": "2022-09-22T00:00:00.000Z",
"expiration_date": "2022-09-30T00:00:00.000Z",
"validity_timeframe": {
"duration": "PT1H",
"interval": "P2D"
},
"validity_day_of_week": [
0
],
"validity_hours": {
"daily": [
{
"start_time": "12:00",
"days_of_week": [
0
],
"expiration_time": "14:00"
}
]
},
"active": true,
"category_id": "cat_0b688929a2476386a6",
"object": "campaign"
},
"campaign_id": "<string>",
"active": true,
"start_date": "2022-09-23T00:00:00.000Z",
"expiration_date": "2022-09-26T00:00:00.000Z",
"validity_timeframe": {
"duration": "PT1H",
"interval": "P2D"
},
"validity_day_of_week": [
0
],
"validity_hours": {
"daily": [
{
"start_time": "12:00",
"days_of_week": [
0
],
"expiration_time": "14:00"
}
]
},
"summary": {
"redemptions": {
"total_redeemed": 123
},
"orders": {
"total_amount": 123,
"total_discount_amount": 123
}
},
"object": "promotion_tier",
"validation_rule_assignments": {
"object": "list",
"data_ref": "data",
"data": [
{
"id": "asgm_74F7QZoYbUoljwQO",
"rule_id": "val_4j7DCRm2IS59",
"related_object_id": "v_JtWunK6jUo7X2qOFj0SyRHq4p9tgENlT",
"related_object_type": "voucher",
"created_at": "2022-02-17T08:18:15.085Z",
"object": "validation_rules_assignment"
}
],
"total": 123
},
"category_id": "cat_0c9da30e7116ba6bba",
"categories": [
{
"id": "<string>",
"name": "<string>",
"hierarchy": 1,
"object": "category",
"created_at": "2022-07-14T10:45:13.156Z",
"updated_at": "2022-08-16T10:52:08.094Z"
}
]
},
"reward": {
"customer": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"source_id": "<string>",
"metadata": {},
"object": "customer"
},
"assignment_id": "<string>",
"voucher": {
"id": "v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV",
"code": "WVPblOYX",
"campaign": "Gift Card Campaign",
"campaign_id": "camp_FNYR4jhqZBM9xTptxDGgeNBV",
"category": "<string>",
"category_id": "cat_0bb343dee3cdb5ec0c",
"type": "GIFT_VOUCHER",
"discount": {
"type": "AMOUNT",
"amount_off": 123,
"amount_off_formula": "<string>",
"aggregated_amount_limit": 123,
"effect": "APPLY_TO_ORDER",
"is_dynamic": true
},
"gift": {
"amount": 10000,
"subtracted_amount": 123,
"balance": 500,
"effect": "APPLY_TO_ORDER"
},
"loyalty_card": {
"points": 7000,
"balance": 6970,
"next_expiration_date": "2023-05-30",
"next_expiration_points": 123,
"pending_points": 123,
"expired_points": 123,
"subtracted_points": 123
},
"start_date": "2021-12-01T00:00:00.000Z",
"expiration_date": "2021-12-31T00:00:00.000Z",
"validity_timeframe": {
"duration": "PT1H",
"interval": "P2D"
},
"validity_day_of_week": [
0
],
"validity_hours": {
"daily": [
{
"start_time": "12:00",
"days_of_week": [
0
],
"expiration_time": "14:00"
}
]
},
"active": true,
"additional_info": "<string>",
"metadata": {},
"assets": {
"qr": {
"id": "U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK+t4pp7U7oFzjGJzj9q/bmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg+BaZk5QwXMf8k/OzSlOEVybpwSq+AiqPoNtjeuqtIgkDyvT6Q==",
"url": "https://dev.dl.voucherify.io/api/v1/assets/qr/U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK%2Bt4pp7U7oFzjGJzj9q%2FbmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg%2BBaZk5QwXMf8k%2FOzSlOEVybpwSq%2BAiqPoNtjeuqtIgkDyvT6Q%3D%3D"
},
"barcode": {
"id": "U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ==",
"url": "https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D"
}
},
"is_referral_code": true,
"created_at": "2021-12-22T10:13:06.487Z",
"updated_at": "2021-12-22T10:14:45.316Z",
"holder_id": "cust_eWgXlBBiY6THFRJwX45Iakv4",
"referrer_id": "cust_Vzck5i8U3OhcEUFY6MKhN9Rv",
"object": "voucher",
"publish": {
"object": "list",
"count": 0,
"url": "/v1/vouchers/WVPblOYX/publications?page=1&limit=10"
},
"redemption": {
"quantity": 123,
"redeemed_quantity": 1,
"redeemed_points": 100000,
"object": "list",
"url": "/v1/vouchers/WVPblOYX/redemptions?page=1&limit=10"
},
"categories": [
{
"id": "<string>",
"name": "<string>",
"hierarchy": 1,
"object": "category",
"created_at": "2022-07-14T10:45:13.156Z",
"updated_at": "2022-08-16T10:52:08.094Z"
}
],
"validation_rules_assignments": {
"object": "list",
"data_ref": "data",
"data": [
{
"id": "asgm_LnY1g7UNFA9KyDrD",
"rule_id": "val_3gPNA6SnH4ae",
"related_object_id": "camp_CZOnEGiZfwIKWmSjhIoIT7Ol",
"related_object_type": "campaign",
"object": "validation_rules_assignment",
"validation_status": "PARTIALLY_VALID",
"validation_omitted_rules": [
"1"
]
}
],
"total": 1
}
},
"product": {
"id": "prod_0b1da8105693710357",
"source_id": "productSourceID16",
"name": "T-shirt",
"price": 123,
"attributes": [
"<string>"
],
"metadata": {},
"object": "product",
"image_url": "https://images.com/original.jpg",
"created_at": "2022-05-23T06:52:55.008Z",
"updated_at": "2022-05-23T09:24:07.405Z",
"skus": {
"object": "list",
"data_ref": "data",
"data": [
{
"id": "sku_0b1621b319d248b79f",
"source_id": "sku_source_id_4",
"product_id": "prod_0b15f6b9f650c16990",
"sku": "Large Pink Shirt",
"price": 123,
"attributes": {},
"image_url": "<string>",
"metadata": {},
"created_at": "2022-05-17T10:36:30.187Z",
"updated_at": "2022-05-17T10:55:09.137Z",
"object": "sku",
"currency": "USD"
}
],
"total": 123
}
},
"sku": {
"id": "sku_0b1621b319d248b79f",
"source_id": "sku_source_id_4",
"product_id": "prod_0b15f6b9f650c16990",
"sku": "Large Pink Shirt",
"price": 123,
"attributes": {},
"image_url": "<string>",
"metadata": {},
"created_at": "2022-05-17T10:36:30.187Z",
"updated_at": "2022-05-17T10:55:09.137Z",
"object": "sku",
"currency": "USD"
},
"loyalty_tier_id": "<string>",
"id": "rew_0bc92f81a6801f9bca",
"name": "Reward Name",
"object": "reward",
"created_at": "2021-12-22T10:13:06.487Z",
"updated_at": "2022-10-03T12:24:58.008Z",
"parameters": {
"campaign": {
"id": "camp_13BbZ0kQsNinhqsX3wUts2UP",
"balance": 123,
"type": "<string>"
},
"product": {
"id": "prod_0b7d7dfb05cbe5c616",
"sku_id": "sku_0a41e31c7b41c28358"
},
"coin": {
"exchange_ratio": 123,
"points_ratio": 123
}
},
"metadata": {},
"type": "CAMPAIGN"
},
"gift": {
"amount": 123
},
"loyalty_card": {
"points": 123
},
"voucher": {
"id": "v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV",
"code": "WVPblOYX",
"campaign": "Gift Card Campaign",
"campaign_id": "camp_FNYR4jhqZBM9xTptxDGgeNBV",
"category": "<string>",
"category_id": "cat_0bb343dee3cdb5ec0c",
"type": "GIFT_VOUCHER",
"discount": {
"type": "AMOUNT",
"amount_off": 123,
"amount_off_formula": "<string>",
"aggregated_amount_limit": 123,
"effect": "APPLY_TO_ORDER",
"is_dynamic": true
},
"gift": {
"amount": 10000,
"subtracted_amount": 123,
"balance": 500,
"effect": "APPLY_TO_ORDER"
},
"loyalty_card": {
"points": 7000,
"balance": 6970,
"next_expiration_date": "2023-05-30",
"next_expiration_points": 123,
"pending_points": 123,
"expired_points": 123,
"subtracted_points": 123
},
"start_date": "2021-12-01T00:00:00.000Z",
"expiration_date": "2021-12-31T00:00:00.000Z",
"validity_timeframe": {
"duration": "PT1H",
"interval": "P2D"
},
"validity_day_of_week": [
0
],
"validity_hours": {
"daily": [
{
"start_time": "12:00",
"days_of_week": [
0
],
"expiration_time": "14:00"
}
]
},
"active": true,
"additional_info": "<string>",
"metadata": {},
"assets": {
"qr": {
"id": "U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK+t4pp7U7oFzjGJzj9q/bmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg+BaZk5QwXMf8k/OzSlOEVybpwSq+AiqPoNtjeuqtIgkDyvT6Q==",
"url": "https://dev.dl.voucherify.io/api/v1/assets/qr/U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK%2Bt4pp7U7oFzjGJzj9q%2FbmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg%2BBaZk5QwXMf8k%2FOzSlOEVybpwSq%2BAiqPoNtjeuqtIgkDyvT6Q%3D%3D"
},
"barcode": {
"id": "U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ==",
"url": "https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D"
}
},
"is_referral_code": true,
"created_at": "2021-12-22T10:13:06.487Z",
"updated_at": "2021-12-22T10:14:45.316Z",
"holder_id": "cust_eWgXlBBiY6THFRJwX45Iakv4",
"referrer_id": "cust_Vzck5i8U3OhcEUFY6MKhN9Rv",
"object": "voucher",
"publish": {
"object": "list",
"count": 0,
"url": "/v1/vouchers/WVPblOYX/publications?page=1&limit=10"
},
"redemption": {
"quantity": 123,
"redeemed_quantity": 1,
"redeemed_points": 100000,
"object": "list",
"url": "/v1/vouchers/WVPblOYX/redemptions?page=1&limit=10"
},
"categories": [
{
"id": "<string>",
"name": "<string>",
"hierarchy": 1,
"object": "category",
"created_at": "2022-07-14T10:45:13.156Z",
"updated_at": "2022-08-16T10:52:08.094Z"
}
],
"validation_rules_assignments": {
"object": "list",
"data_ref": "data",
"data": [
{
"id": "asgm_LnY1g7UNFA9KyDrD",
"rule_id": "val_3gPNA6SnH4ae",
"related_object_id": "camp_CZOnEGiZfwIKWmSjhIoIT7Ol",
"related_object_type": "campaign",
"object": "validation_rules_assignment",
"validation_status": "PARTIALLY_VALID",
"validation_omitted_rules": [
"1"
]
}
],
"total": 1
},
"holder": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"source_id": "<string>",
"metadata": {},
"object": "customer"
}
}
}
],
"total": 123
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.
1 <= x <= 100Which page of results to return. The lowest value is 1, the highest value is 99.
1 <= x <= 99A filter on the list based on the redemption result. Available options are: SUCCESS, FAILURE. You can provide multiple values by repeating the param.
A filter by the campaign name that the redemption resources originate from.
Return redemptions performed by the customer with given id or source_id.
"cust_nk0N1uNQ1YnupAoJGOgvsODC"
Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
created_at, -created_at, id, -id, voucher_code, -voucher_code, tracking_id, -tracking_id, customer_id, -customer_id A filter on the list based on the object created_at field. The value is a dictionary with the following options: before, after. A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [created_at][before]=2017-09-08T13:52:18.227Z
Show child attributes
Show child attributes
Timestamp representing the date and time before 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 after the voucher was created. The value is shown in the ISO 8601 format.
"2021-12-22T10:13:06.487Z"
Filters for listing responses.
Show child attributes
Show child attributes
Unique voucher code.
Show child attributes
Show child attributes
Data filters used to narrow down the data records to be returned in the result.
Show child attributes
Show child attributes
Array of resource values that should be included in the results (multiple values).
Array of resource values that should be included in the results (multiple values).
Value is exactly this value (single value).
Results omit this value (single value).
Value is NOT null. The value for this parameter is an empty string.
Value is null. The value for this parameter is an empty string.
Value starts with the specified string.
Value ends with the specified string.
Value includes the specified string.
Value does NOT include the specified string.
Unique related object ID, i.e. v_hS8JFl8S6lNcd1L69wLIoXgTio7eWEgk.
Show child attributes
Show child attributes
Data filters used to narrow down the data records to be returned in the result.
Show child attributes
Show child attributes
Array of resource values that should be included in the results (multiple values).
Array of resource values that should be included in the results (multiple values).
Value is exactly this value (single value).
Results omit this value (single value).
Value is NOT null. The value for this parameter is an empty string.
Value is null. The value for this parameter is an empty string.
Value starts with the specified string.
Value ends with the specified string.
Value includes the specified string.
Value does NOT include the specified string.
Unique related object parent ID, i.e. camp_22noMlhTADb7Fq2UL3vWu3d1.
Show child attributes
Show child attributes
Data filters used to narrow down the data records to be returned in the result.
Show child attributes
Show child attributes
Array of resource values that should be included in the results (multiple values).
Array of resource values that should be included in the results (multiple values).
Value is exactly this value (single value).
Results omit this value (single value).
Value is NOT null. The value for this parameter is an empty string.
Value is null. The value for this parameter is an empty string.
Value starts with the specified string.
Value ends with the specified string.
Value includes the specified string.
Value does NOT include the specified string.
Unique parent redemption ID, i.e. r_0c5952900bcbfd54b6.
Show child attributes
Show child attributes
Data filters used to narrow down the data records to be returned in the result.
Show child attributes
Show child attributes
Array of resource values that should be included in the results (multiple values).
Array of resource values that should be included in the results (multiple values).
Value is exactly this value (single value).
Results omit this value (single value).
Value is NOT null. The value for this parameter is an empty string.
Value is null. The value for this parameter is an empty string.
Value starts with the specified string.
Value ends with the specified string.
Value includes the specified string.
Value does NOT include the specified string.
Failure code, i.e. quantity_exceeded.
Show child attributes
Show child attributes
Data filters used to narrow down the data records to be returned in the result.
Show child attributes
Show child attributes
Array of resource values that should be included in the results (multiple values).
Array of resource values that should be included in the results (multiple values).
Value is exactly this value (single value).
Results omit this value (single value).
Value is NOT null. The value for this parameter is an empty string.
Value is null. The value for this parameter is an empty string.
Value starts with the specified string.
Value ends with the specified string.
Value includes the specified string.
Value does NOT include the specified string.
Result, i.e. SUCCESS or FAILURE.
Show child attributes
Show child attributes
Data filters used to narrow down the data records to be returned in the result.
Show child attributes
Show child attributes
Array of resource values that should be included in the results (multiple values).
Array of resource values that should be included in the results (multiple values).
Value is exactly this value (single value).
Results omit this value (single value).
Value is NOT null. The value for this parameter is an empty string.
Value is null. The value for this parameter is an empty string.
Value starts with the specified string.
Value ends with the specified string.
Value includes the specified string.
Value does NOT include the specified string.
Specify which type of object to return, i.e. redemption or redemption_rollback.
Show child attributes
Show child attributes
Data filters used to narrow down the data records to be returned in the result.
Show child attributes
Show child attributes
Array of resource values that should be included in the results (multiple values).
Array of resource values that should be included in the results (multiple values).
Value is exactly this value (single value).
Results omit this value (single value).
Value is NOT null. The value for this parameter is an empty string.
Value is null. The value for this parameter is an empty string.
Value starts with the specified string.
Value ends with the specified string.
Value includes the specified string.
Value does NOT include the specified string.
Unique customer ID, i.e. cust_sehkNIi8Uq2qQuRqSr7xn4Zi.
Show child attributes
Show child attributes
Data filters used to narrow down the data records to be returned in the result.
Show child attributes
Show child attributes
Array of resource values that should be included in the results (multiple values).
Array of resource values that should be included in the results (multiple values).
Value is exactly this value (single value).
Results omit this value (single value).
Value is NOT null. The value for this parameter is an empty string.
Value is null. The value for this parameter is an empty string.
Value starts with the specified string.
Value ends with the specified string.
Value includes the specified string.
Value does NOT include the specified string.
Campaign name.
Show child attributes
Show child attributes
Data filters used to narrow down the data records to be returned in the result.
Show child attributes
Show child attributes
Array of resource values that should be included in the results (multiple values).
Array of resource values that should be included in the results (multiple values).
Value is exactly this value (single value).
Results omit this value (single value).
Value is NOT null. The value for this parameter is an empty string.
Value is null. The value for this parameter is an empty string.
Value starts with the specified string.
Value ends with the specified string.
Value includes the specified string.
Value does NOT include the specified string.
User login used to login to Voucherify, i.e. name.lastname@email.com
Show child attributes
Show child attributes
Data filters used to narrow down the data records to be returned in the result.
Show child attributes
Show child attributes
Array of resource values that should be included in the results (multiple values).
Array of resource values that should be included in the results (multiple values).
Value is exactly this value (single value).
Results omit this value (single value).
Value is NOT null. The value for this parameter is an empty string.
Value is null. The value for this parameter is an empty string.
Value starts with the specified string.
Value ends with the specified string.
Value includes the specified string.
Value does NOT include the specified string.
Logical Operator Between Filters. Filter by conditions set on the junction parameter indicating how the conditions should be accounted for in the query. An AND is an all-inclusive logical operator, meaning the AND operator displays a record if ALL the conditions separated by AND are TRUE, while an OR operator displays a record if ANY of the conditions separated by OR is TRUE.
and, or Response
Returns a list of redemption objects. Each entry in the array is a separate redemption object. If no more redemptions are available, the resulting array will be empty. If you provide a non-existent customer ID, this call returns an empty object.
Response body schema for GET v1/redemptions.
The type of the object represented by JSON. This object stores information about redemptions in a dictionary.
Identifies the name of the attribute that contains the array of redemption objects.
This is an object representing a redemption.
- Redemption
- Redemption Rollback
Show child attributes
Show child attributes
Unique redemption ID.
"r_0bc92f81a6801f9bca"
The type of the object represented by the JSON
redemption Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format.
"2021-12-22T10:13:06.487Z"
Unique customer ID of the redeeming customer.
"cust_i8t5Tt6eiKG5K79KQlJ0Vs64"
Hashed customer source ID.
The metadata object stores all custom attributes assigned to the redemption.
Unique redemption ID of the parent redemption.
"r_0c656311b5878a2031"
Redemption result.
SUCCESS, FAILURE Redemption status.
SUCCEEDED, FAILED, ROLLED_BACK Order information.
Show child attributes
Show child attributes
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.
CREATED, PAID, CANCELED, FULFILLED This is the sum of the order items' amounts. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
This is the sum of the order items' amounts before any discount or other effect (e.g. add missing units) is applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
Sum of all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
Sum of all order-level AND all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
Order amount after undoing all the discounts through the rollback redemption. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
This field shows the order-level discount applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
Sum of all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
sum(items, i => i.applied_discount_amount)
Sum of all order-level AND all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
total_applied_discount_amount = applied_discount_amount + items_applied_discount_amount
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. It can be used to define business validation rules or discount formulas.
The type of the object represented by JSON.
order Timestamp representing the date and time when the order 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 order was last updated in ISO 8601 format.
"2021-12-22T10:14:45.316Z"
Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify.
"cust_7iUa6ICKyU6gH40dBU25kQU1"
Unique referrer ID.
"cust_nM4jqPiaXUvQdVSA6vTRUnix"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Timestamp representing the date and time when the redemption was created. The value is shown in the ISO 8601 format.
"2022-09-02T17:06:56.649Z"
Unique ID of the redemption rollback.
"rr_0c63c84eb78ee0a6c0"
Timestamp representing the date and time when the redemption rollback was created. The value is shown in the ISO 8601 format.
"2023-01-31T14:18:37.150Z"
The source of the incentive.
Unique ID of the parent redemption.
"r_0ba186c4824e4881e1"
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.
Contains a list of unique IDs of child redemptions, which belong to the stacked incentives.
Lists the rollback redemption IDs of the particular child redemptions.
Array of items applied to the order. It can include up to 500 items.
Show child attributes
Show child attributes
The type of the object represented by JSON.
order_item Unique identifier of the order line item.
Unique identifier of the SKU. It is assigned by Voucherify.
Unique identifier of the product. It is assigned by Voucherify.
Used along with the source_id property, can be set to either sku or product.
product, sku 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.
The quantity of the particular item in the cart.
Number of dicounted items.
A positive integer in the smallest unit quantity representing the total amount of the order; this is the sum of the order items' quantity.
The total amount of the order item (price * quantity).
Sum of all order-item-level discounts applied to the order.
This field shows the order-level discount applied.
Number of the discounted items applied in the transaction.
Quantity of items changed by the application of a new quantity items. It can be positive when an item is added or negative if an item is replaced.
Amount for the items changed by the application of a new quantity items. It can be positive when an item is added or negative if an item is replaced.
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.
Unit price of an item. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.
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
An object containing details of the related product.
Show child attributes
Show child attributes
A unique identifier that represents the product and is assigned by Voucherify.
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.
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.
Product name.
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. It can be used to create product collections.
Product price. A positive integer in the smallest currency unit (e.g. 100 cents for $1.00).
An object containing details of the related SKU.
Show child attributes
Show child attributes
A unique identifier that represents the SKU and is assigned by Voucherify.
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.
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.
The SKU name.
SKU price. A positive integer in the smallest currency unit (e.g. 100 cents for $1.00).
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. It can be used to create product collections.
A set of custom key/value pairs that you can attach to an item object. It can be useful for storing additional information about the item in a structured format. It can be used to define business validation rules or discount formulas.
Array containing details about the items that are replaced and the items that are replacements for discounts with the REPLACE_ITEMS effect.
Show child attributes
Show child attributes
Index number of the source item that is replaced. The enumeration starts from 0, which represents the first item in the request, e.g., if the replaced item is passed as the second in the request, source_index equals 3.
x >= 0Number of source units that are replaced.
x <= -1Amount equal to the price of the units that are replaced. Determines the change of the amount of the source item quantity.
x <= 0Index number of the target item that is a replacement of the source item. The enumeration continues the values for the order items, e.g. if there are three items in the request, target_index equals 3, as enumeration starts from 0.
Number of added target units that are replacements.
Amount equal to the price of the units that are replacements. Determines the change in the amount of the target item quantity.
Discount amount applied to the target item with regard to the replacement. Equals the target_applied_quantity_amount minus source_applied_quantity_amount.
Defines the details of the channel through which the redemption was issued.
Show child attributes
Show child attributes
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. For AUTO_REDEEM, it is the reward assignment ID.
"user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH"
The source of the channel for the redemption. A USER corresponds to the Voucherify Dashboard, API corresponds to the API, and AUTO_REDEEM corresponds to a loyalty campaign reward that has been redeemed automatically.
USER, API, AUTO_REDEEM Simplified customer data.
Show child attributes
Show child attributes
Unique identifier of an existing customer. It is assigned by Voucherify.
Customer's first and last name.
Customer's email address.
A unique identifier of the customer. It can be a customer ID or email from a CRM system, database, or a third-party service.
A set of custom key/value pairs that are attached to the customer. It stores all custom attributes assigned to the customer.
The type of the object represented by JSON.
customer Defines the related object.
voucher, promotion_tier, redemption Unique related object ID assigned by Voucherify, i.e. v_lfZi4rcEGe0sN9gmnj40bzwK2FH6QUno for a voucher.
For gift cards, this is a positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the number of redeemed credits. For loyalty cards, this is the number of loyalty points used in the transaction.
10000
Contains details about the redemption session lock. Sessions can be established only for discount vouchers, promotions, and gift cards.
Show child attributes
Show child attributes
The session unique ID assigned by Voucherify or your own unique session ID sent in the request.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Unique rollback redemption ID.
"rr_0bc92f81a6801f9bca"
Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format.
"2021-12-22T10:13:06.487Z"
Defines the rollback mode for the order. WITH_ORDER is a default setting. The redemption is rolled back together with the data about the order, including related discount values. WITHOUT_ORDER allows rolling the redemption back without affecting order data, including the applied discount values. This is returned only in GET v1/redemptions/ and GET v1/redemptions/{redemptionId} endpoints.
WITH_ORDER, WITHOUT_ORDER Show child attributes
Show child attributes
Unique redemption ID.
"r_0bc92f81a6801f9bca"
Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format.
"2021-12-22T10:13:06.487Z"
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.
Contains details of the promotion tier and the parent campaign.
Show child attributes
Show child attributes
Unique promotion tier ID.
"promo_63fYCt81Aw0h7lzyRkrGZh9p"
Timestamp representing the date and time when the promotion tier was created. The value is shown in the ISO 8601 format.
"2021-12-15T11:34:01.333Z"
Timestamp representing the date and time when the promotion tier was updated. The value is shown in the 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.
Show child attributes
Show child attributes
Contains information about discount.
- Discount
- Discount
- Discount
- Discount
- Discount
Show child attributes
Show child attributes
Defines the type of the voucher.
AMOUNT 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.
Formula used to dynamically calculate the discount.
Maximum discount amount per order.
Defines how the discount is applied to the customer's order.
APPLY_TO_ORDER, APPLY_TO_ITEMS, APPLY_TO_ITEMS_PROPORTIONALLY, APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY, APPLY_TO_ITEMS_BY_QUANTITY Flag indicating whether the discount was calculated using a formula.
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.
Show child attributes
Show child attributes
Unique campaign ID.
Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date.
"2022-09-22T00: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"
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.
Show child attributes
Show child attributes
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"
Integer array corresponding to the particular days of the week in which the voucher is valid.
0Sunday1Monday2Tuesday3Wednesday4Thursday5Friday6Saturday
0, 1, 2, 3, 4, 5, 6 Determines the hours of validity, e.g. to create a happy hours scenario.
Show child attributes
Show child attributes
Defines the recurring period(s) when the resource is active. The periods should not overlap.
Show child attributes
Show child attributes
Defines the starting hour of validity in the HH:mm format. The resource is inactive before this time.
"12:00"
Integer array corresponding to the particular days of the week in which the resource is valid.
0Sunday1Monday2Tuesday3Wednesday4Thursday5Friday6Saturday
0, 1, 2, 3, 4, 5, 6 Defines the ending hour of validity in the HH:mm format. The resource is inactive after this time.
"14:00"
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.
trueindicates an active campaignfalseindicates an inactive campaign
Unique category ID that this campaign belongs to.
"cat_0b688929a2476386a6"
The type of the object represented by the campaign object. This object stores information about the 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.
trueindicates an active promotion tierfalseindicates 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 earning rule is valid. For example, valid for 1 hour every other day.start_date required when including the validity_timeframe.
Show child attributes
Show child attributes
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"
Integer array corresponding to the particular days of the week in which the voucher is valid.
0Sunday1Monday2Tuesday3Wednesday4Thursday5Friday6Saturday
0, 1, 2, 3, 4, 5, 6 Determines the hours of validity, e.g. to create a happy hours scenario.
Show child attributes
Show child attributes
Defines the recurring period(s) when the resource is active. The periods should not overlap.
Show child attributes
Show child attributes
Defines the starting hour of validity in the HH:mm format. The resource is inactive before this time.
"12:00"
Integer array corresponding to the particular days of the week in which the resource is valid.
0Sunday1Monday2Tuesday3Wednesday4Thursday5Friday6Saturday
0, 1, 2, 3, 4, 5, 6 Defines the ending hour of validity in the HH:mm format. The resource is inactive after this time.
"14:00"
Contains statistics about promotion tier redemptions and orders.
Show child attributes
Show child attributes
The type of the object represented by JSON. This object stores information about the promotion tier.
Validation Rule Assignments List
Show child attributes
Show child attributes
The type of the object represented by JSON. This object stores information about validation rule assignments.
Identifies the name of the JSON property that contains the array of validation rule assignments.
A dictionary that contains an array of validation rule assignments.
Show child attributes
Show child attributes
Validation rule assignment ID.
"asgm_74F7QZoYbUoljwQO"
Validation rule ID.
"val_4j7DCRm2IS59"
The resource ID to which the validation rule was assigned.
"v_JtWunK6jUo7X2qOFj0SyRHq4p9tgENlT"
The type of resource to which the validation rule was assigned.
voucher, campaign, earning_rule, reward_assignment, promotion_tier, distribution Timestamp representing the date and time when the validation rule assignment was created. The value is shown in the ISO 8601 format.
"2022-02-17T08:18:15.085Z"
The type of the object represented by the ID.
validation_rules_assignment Total number of validation rule assignments.
Promotion tier category ID.
"cat_0c9da30e7116ba6bba"
Show child attributes
Show child attributes
Unique category ID assigned by Voucherify.
Category name.
Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value.
x >= 0The type of the object represented by the JSON. This object stores information about the category.
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"
Show child attributes
Show child attributes
Simplified customer data.
Show child attributes
Show child attributes
Unique identifier of an existing customer. It is assigned by Voucherify.
Customer's first and last name.
Customer's email address.
A unique identifier of the customer. It can be a customer ID or email from a CRM system, database, or a third-party service.
A set of custom key/value pairs that are attached to the customer. It stores all custom attributes assigned to the customer.
The type of the object represented by JSON.
customer Unique reward assignment ID assigned by Voucherify.
This is an object representing a voucher with categories and validation rules assignments.
Show child attributes
Show child attributes
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.
GIFT_VOUCHER, DISCOUNT_VOUCHER, LOYALTY_CARD Contains information about discount.
- Discount
- Discount
- Discount
- Discount
- Discount
Show child attributes
Show child attributes
Defines the type of the voucher.
AMOUNT 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.
Formula used to dynamically calculate the discount.
Maximum discount amount per order.
Defines how the discount is applied to the customer's order.
APPLY_TO_ORDER, APPLY_TO_ITEMS, APPLY_TO_ITEMS_PROPORTIONALLY, APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY, APPLY_TO_ITEMS_BY_QUANTITY Flag indicating whether the discount was calculated using a formula.
Object representing gift parameters. Child attributes are present only if type is GIFT_VOUCHER. Defaults to null.
Show child attributes
Show child attributes
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.
10000
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.
Available funds. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.
500
Defines how the credits are applied to the customer's order.
APPLY_TO_ORDER, APPLY_TO_ITEMS Object representing loyalty card parameters. Child attributes are present only if type is LOYALTY_CARD. Defaults to null.
Show child attributes
Show child attributes
Total number of points added to the loyalty card over its lifespan.
7000
Points available for reward redemption. This is calculated as follows: balance = points - expired_points - subtracted_points - redemption.redeemed_points.
6970
The next closest date when the next set of points are due to expire.
"2023-05-30"
The amount of points that are set to expire next.
Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually.
Shows the total number of expired points over the lifetime of the loyalty card.
Shows the total number of subtracted points over the lifetime of the loyalty card.
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 earning rule is valid. For example, valid for 1 hour every other day.start_date required when including the validity_timeframe.
Show child attributes
Show child attributes
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"
Integer array corresponding to the particular days of the week in which the voucher is valid.
0Sunday1Monday2Tuesday3Wednesday4Thursday5Friday6Saturday
0, 1, 2, 3, 4, 5, 6 Determines the hours of validity, e.g. to create a happy hours scenario.
Show child attributes
Show child attributes
Defines the recurring period(s) when the resource is active. The periods should not overlap.
Show child attributes
Show child attributes
Defines the starting hour of validity in the HH:mm format. The resource is inactive before this time.
"12:00"
Integer array corresponding to the particular days of the week in which the resource is valid.
0Sunday1Monday2Tuesday3Wednesday4Thursday5Friday6Saturday
0, 1, 2, 3, 4, 5, 6 Defines the ending hour of validity in the HH:mm format. The resource is inactive after this time.
"14:00"
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.
trueindicates an active voucherfalseindicates 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.
Stores links to images of QR and barcode that correspond to an encrypted voucher code.
Show child attributes
Show child attributes
Stores Quick Response (QR) representation of encrypted code.
Show child attributes
Show child attributes
Encrypted voucher code ID.
"U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK+t4pp7U7oFzjGJzj9q/bmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg+BaZk5QwXMf8k/OzSlOEVybpwSq+AiqPoNtjeuqtIgkDyvT6Q=="
URL to QR code
Optional: Attach query parameters to base URL to customize the image of the encrypted voucher code.
size: integer value from1to100format: string, eitherpng(default) orsvg
"https://dev.dl.voucherify.io/api/v1/assets/qr/U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK%2Bt4pp7U7oFzjGJzj9q%2FbmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg%2BBaZk5QwXMf8k%2FOzSlOEVybpwSq%2BAiqPoNtjeuqtIgkDyvT6Q%3D%3D"
Stores barcode representation of encrypted code.
Show child attributes
Show child attributes
Encrypted voucher code ID.
"U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ=="
URL to barcode
Optional: Attach query parameters to base URL to customize the image of the encrypted voucher code.
size: integer value from1to100format: string, eitherpng(default) orsvg
"https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D"
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.
Show child attributes
Show child attributes
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.
Publication events counter.
0
The endpoint where this list of publications can be accessed using a GET method. /v1/vouchers/{voucher_code}/publications
"/v1/vouchers/WVPblOYX/publications?page=1&limit=10"
Stores a summary of redemptions that have been applied to the voucher.
Show child attributes
Show child attributes
How many times a voucher can be redeemed. A null value means unlimited.
How many times a voucher has already been redeemed.
1
Total loyalty points redeemed.
100000
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.
The endpoint where this list of redemptions can be accessed using a GET method. /v1/vouchers/{voucher_code}/redemptions
"/v1/vouchers/WVPblOYX/redemptions?page=1&limit=10"
Contains details about the category.
Show child attributes
Show child attributes
Unique category ID assigned by Voucherify.
Category name.
Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value.
x >= 0The type of the object represented by the JSON. This object stores information about the category.
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"
List of Validation Rules Assignments
Show child attributes
Show child attributes
The type of the object represented by JSON. This object stores information about validation rules assignments.
list Identifies the name of the attribute that contains the array of validation rules assignments.
data Contains array of validation rules assignments.
Show child attributes
Show child attributes
The unique identifier for a assignment
The unique identifier for a rule
The unique identifier for a related object
The type of related object
The type of the object represented by JSON.
validation_rules_assignment 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 validation status of the assignment
VALID, PARTIALLY_VALID, INVALID The list of omitted rules
Total number of validation rules assignments.
x >= 0This 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.
Show child attributes
Show child attributes
Unique product ID assigned by Voucherify.
"prod_0b1da8105693710357"
Unique product source ID.
"productSourceID16"
Unique user-defined product name.
"T-shirt"
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.
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.
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. It can be used to create product collections.
The type of the object represented by JSON. This object stores information about the product.
product The HTTPS URL pointing to the .png or .jpg file that will be used to render the product image.
"https://images.com/original.jpg"
Timestamp representing the date and time when the product was created. The value is shown in the ISO 8601 format.
"2022-05-23T06:52:55.008Z"
Timestamp representing the date and time when the product was updated. The value is shown in the ISO 8601 format.
"2022-05-23T09:24:07.405Z"
Contains information about child SKUs.
Show child attributes
Show child attributes
The type of the object represented by JSON. This object stores information about SKUs.
Identifies the name of the JSON property that contains the array of SKUs.
A dictionary that contains an array of SKUs.
Show child attributes
Show child attributes
A unique identifier that represents the SKU and is assigned by Voucherify.
"sku_0b1621b319d248b79f"
A unique SKU identifier from your inventory system.
"sku_source_id_4"
The parent product's unique ID.
"prod_0b15f6b9f650c16990"
Unique user-defined SKU name.
"Large Pink Shirt"
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.
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.
The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image.
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. It can be used to create product collections.
Timestamp representing the date and time when the SKU was created. The value is shown in the ISO 8601 format.
"2022-05-17T10:36:30.187Z"
Timestamp representing the date and time when the SKU was updated. The value is shown in the ISO 8601 format.
"2022-05-17T10:55:09.137Z"
The type of the object represented by JSON. This object stores information about the SKU.
sku SKU price currency.
"USD"
Total number of SKUs in the product.
This is an object representing a product SKU.
Show child attributes
Show child attributes
A unique identifier that represents the SKU and is assigned by Voucherify.
"sku_0b1621b319d248b79f"
A unique SKU identifier from your inventory system.
"sku_source_id_4"
The parent product's unique ID.
"prod_0b15f6b9f650c16990"
Unique user-defined SKU name.
"Large Pink Shirt"
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.
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.
The HTTPS URL pointing to the .png or .jpg file that will be used to render the SKU image.
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. It can be used to create product collections.
Timestamp representing the date and time when the SKU was created. The value is shown in the ISO 8601 format.
"2022-05-17T10:36:30.187Z"
Timestamp representing the date and time when the SKU was updated. The value is shown in the ISO 8601 format.
"2022-05-17T10:55:09.137Z"
The type of the object represented by JSON. This object stores information about the SKU.
sku SKU price currency.
"USD"
Unique loyalty tier ID assigned by Voucherify.
Unique reward ID.
"rew_0bc92f81a6801f9bca"
Name of the reward.
"Reward Name"
The type of the object represented by the JSON
reward Timestamp representing the date and time when the redemption was created. The value is shown in the 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.
Show child attributes
Show child attributes
Defines the product redeemed as a reward.
Show child attributes
Show child attributes
Campaign unique ID.
"camp_13BbZ0kQsNinhqsX3wUts2UP"
Points available for reward redemption. This is calculated as follows: balance = points - expired_points - subtracted_points - redemption.redeemed_points.
Defines the type of the campaign.
Defines the product redeemed as a reward.
Defines the ratio by mapping the number of loyalty points in points_ratio to a predefined cash amount in exchange_ratio.
Show child attributes
Show child attributes
A set of custom key/value pairs that you can attach to a reward. The metadata object stores all custom attributes assigned to the reward.
Reward type.
CAMPAIGN, COIN, MATERIAL Defines the details of the voucher being redeemed.
Show child attributes
Show child attributes
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.
GIFT_VOUCHER, DISCOUNT_VOUCHER, LOYALTY_CARD Contains information about discount.
- Discount
- Discount
- Discount
- Discount
- Discount
Show child attributes
Show child attributes
Defines the type of the voucher.
AMOUNT 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.
Formula used to dynamically calculate the discount.
Maximum discount amount per order.
Defines how the discount is applied to the customer's order.
APPLY_TO_ORDER, APPLY_TO_ITEMS, APPLY_TO_ITEMS_PROPORTIONALLY, APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY, APPLY_TO_ITEMS_BY_QUANTITY Flag indicating whether the discount was calculated using a formula.
Object representing gift parameters. Child attributes are present only if type is GIFT_VOUCHER. Defaults to null.
Show child attributes
Show child attributes
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.
10000
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.
Available funds. The value is multiplied by 100 to represent 2 decimal places. For example 10000 cents for $100.00.
500
Defines how the credits are applied to the customer's order.
APPLY_TO_ORDER, APPLY_TO_ITEMS Object representing loyalty card parameters. Child attributes are present only if type is LOYALTY_CARD. Defaults to null.
Show child attributes
Show child attributes
Total number of points added to the loyalty card over its lifespan.
7000
Points available for reward redemption. This is calculated as follows: balance = points - expired_points - subtracted_points - redemption.redeemed_points.
6970
The next closest date when the next set of points are due to expire.
"2023-05-30"
The amount of points that are set to expire next.
Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually.
Shows the total number of expired points over the lifetime of the loyalty card.
Shows the total number of subtracted points over the lifetime of the loyalty card.
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 earning rule is valid. For example, valid for 1 hour every other day.start_date required when including the validity_timeframe.
Show child attributes
Show child attributes
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"
Integer array corresponding to the particular days of the week in which the voucher is valid.
0Sunday1Monday2Tuesday3Wednesday4Thursday5Friday6Saturday
0, 1, 2, 3, 4, 5, 6 Determines the hours of validity, e.g. to create a happy hours scenario.
Show child attributes
Show child attributes
Defines the recurring period(s) when the resource is active. The periods should not overlap.
Show child attributes
Show child attributes
Defines the starting hour of validity in the HH:mm format. The resource is inactive before this time.
"12:00"
Integer array corresponding to the particular days of the week in which the resource is valid.
0Sunday1Monday2Tuesday3Wednesday4Thursday5Friday6Saturday
0, 1, 2, 3, 4, 5, 6 Defines the ending hour of validity in the HH:mm format. The resource is inactive after this time.
"14:00"
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.
trueindicates an active voucherfalseindicates 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.
Stores links to images of QR and barcode that correspond to an encrypted voucher code.
Show child attributes
Show child attributes
Stores Quick Response (QR) representation of encrypted code.
Show child attributes
Show child attributes
Encrypted voucher code ID.
"U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK+t4pp7U7oFzjGJzj9q/bmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg+BaZk5QwXMf8k/OzSlOEVybpwSq+AiqPoNtjeuqtIgkDyvT6Q=="
URL to QR code
Optional: Attach query parameters to base URL to customize the image of the encrypted voucher code.
size: integer value from1to100format: string, eitherpng(default) orsvg
"https://dev.dl.voucherify.io/api/v1/assets/qr/U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK%2Bt4pp7U7oFzjGJzj9q%2FbmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg%2BBaZk5QwXMf8k%2FOzSlOEVybpwSq%2BAiqPoNtjeuqtIgkDyvT6Q%3D%3D"
Stores barcode representation of encrypted code.
Show child attributes
Show child attributes
Encrypted voucher code ID.
"U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ=="
URL to barcode
Optional: Attach query parameters to base URL to customize the image of the encrypted voucher code.
size: integer value from1to100format: string, eitherpng(default) orsvg
"https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D"
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.
Show child attributes
Show child attributes
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.
Publication events counter.
0
The endpoint where this list of publications can be accessed using a GET method. /v1/vouchers/{voucher_code}/publications
"/v1/vouchers/WVPblOYX/publications?page=1&limit=10"
Stores a summary of redemptions that have been applied to the voucher.
Show child attributes
Show child attributes
How many times a voucher can be redeemed. A null value means unlimited.
How many times a voucher has already been redeemed.
1
Total loyalty points redeemed.
100000
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.
The endpoint where this list of redemptions can be accessed using a GET method. /v1/vouchers/{voucher_code}/redemptions
"/v1/vouchers/WVPblOYX/redemptions?page=1&limit=10"
Contains details about the category.
Show child attributes
Show child attributes
Unique category ID assigned by Voucherify.
Category name.
Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value.
x >= 0The type of the object represented by the JSON. This object stores information about the category.
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"
List of Validation Rules Assignments
Show child attributes
Show child attributes
The type of the object represented by JSON. This object stores information about validation rules assignments.
list Identifies the name of the attribute that contains the array of validation rules assignments.
data Contains array of validation rules assignments.
Show child attributes
Show child attributes
The unique identifier for a assignment
The unique identifier for a rule
The unique identifier for a related object
The type of related object
The type of the object represented by JSON.
validation_rules_assignment 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 validation status of the assignment
VALID, PARTIALLY_VALID, INVALID The list of omitted rules
Total number of validation rules assignments.
x >= 0Simplified customer data.
Show child attributes
Show child attributes
Unique identifier of an existing customer. It is assigned by Voucherify.
Customer's first and last name.
Customer's email address.
A unique identifier of the customer. It can be a customer ID or email from a CRM system, database, or a third-party service.
A set of custom key/value pairs that are attached to the customer. It stores all custom attributes assigned to the customer.
The type of the object represented by JSON.
customer Total number of redemptions.
Was this page helpful?