Endpoints
- Customer Object
- Customer Activity Object
- GETList Customers
- GETGet Customer
- GETList Customer Activity
- GETList Customer's Segments
- GETList Customer's Redeemables
- POSTCreate Customer
- POSTImport and Update Customers using CSV
- PUTUpdate Customer
- POSTUpdate Customers in Bulk
- POSTUpdate Customers' Metadata in Bulk
- DELDelete Customer
- POSTDelete Customer Permanently
- GETList Customer Activitiesdeprecated
curl --request GET \
--url https://{cluster}.voucherify.io/v1/customers/{customerId}/redeemables \
--header 'Authorization: Bearer <token>' \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"object": "list",
"data_ref": "data",
"data": [
{
"id": "rh_0e7b8db4700106a852",
"created_at": "2024-03-22T17:48:25.910Z",
"redeemable_id": "v_GXVguPhq2khgFxH7GrRXWA91gDr1LiA1",
"redeemable_object": "voucher",
"customer_id": "cust_p1ufreYbVbwZ1x70nFkH9rF9",
"holder_role": "OWNER",
"campaign_id": "camp_weer1c3p5ZgktqfW56RfoNaG",
"campaign_type": "DISCOUNT_COUPONS",
"voucher_type": "DISCOUNT_VOUCHER",
"redeemable": {
"type": "voucher",
"voucher": {
"id": "v_GXVguPhq2khgFxH7GrRXWA91gDr1LiA1",
"code": "3xRUnMVG",
"campaign": "Gaz6Q29w1d",
"campaign_id": "camp_weer1c3p5ZgktqfW56RfoNaG",
"category": null,
"category_id": null,
"categories": [],
"type": "DISCOUNT_VOUCHER",
"discount": {
"type": "AMOUNT",
"amount_off": 1000
},
"gift": null,
"loyalty_card": null,
"start_date": null,
"expiration_date": null,
"validity_timeframe": null,
"validity_hours": null,
"validity_day_of_week": null,
"active": true,
"additional_info": null,
"metadata": {},
"assets": {
"qr": {
"id": "fa250fcd-8d51-41e7-9dda-9288ce2799a7",
"url": "{{internalVoucherifyURL}}"
},
"barcode": {
"id": "1b876033-ad88-4e74-8344-27fca1767006",
"url": "{{internalVoucherifyURL}}"
}
},
"is_referral_code": false,
"created_at": "2024-03-22T17:48:18.57+00:00",
"updated_at": "2024-03-22T17:48:25.910974+00:00",
"holder_id": "cust_p1ufreYbVbwZ1x70nFkH9rF9",
"redemption": {
"quantity": null,
"redeemed_quantity": 0,
"object": "list",
"url": "/v1/vouchers/3xRUnMVG/redemptions?page=1&limit=10"
},
"publish": {
"object": "list",
"count": 1,
"url": "/v1/vouchers/3xRUnMVG/publications?page=1&limit=10"
},
"object": "voucher"
},
"status": "ACTIVE"
}
},
{
"id": "rh_0e79fe37e4926cafd6",
"created_at": "2024-03-21T12:43:02.915Z",
"redeemable_id": "v_nnxc1aFzFZCAhRlG6sm0kSO4jKUohc9b",
"redeemable_object": "voucher",
"customer_id": "cust_p1ufreYbVbwZ1x70nFkH9rF9",
"holder_role": "REFERRER",
"campaign_id": "camp_ixXNxP8kRoV15RoyZU4HqqYJ",
"campaign_type": "REFERRAL_PROGRAM",
"voucher_type": "DISCOUNT_VOUCHER",
"redeemable": {
"type": "voucher",
"voucher": {
"id": "v_nnxc1aFzFZCAhRlG6sm0kSO4jKUohc9b",
"code": "PBF3ZYfS",
"campaign": "REFER_2",
"campaign_id": "camp_ixXNxP8kRoV15RoyZU4HqqYJ",
"category": null,
"category_id": null,
"categories": [],
"type": "DISCOUNT_VOUCHER",
"discount": {
"type": "AMOUNT",
"amount_off": 88800,
"effect": "APPLY_TO_ORDER"
},
"gift": null,
"loyalty_card": null,
"start_date": null,
"expiration_date": null,
"validity_timeframe": null,
"validity_hours": null,
"validity_day_of_week": null,
"active": true,
"additional_info": null,
"metadata": {},
"assets": {
"qr": {
"id": "fc0471bf-0c7b-443f-9532-303437041eea",
"url": "{{internalVoucherifyURL}}"
},
"barcode": {
"id": "5b2f2007-494b-40c3-9d4c-ad27269a0cd0",
"url": "{{internalVoucherifyURL}}"
}
},
"is_referral_code": true,
"created_at": "2024-03-21T12:42:49.771+00:00",
"updated_at": "2024-03-21T12:43:02.915953+00:00",
"holder_id": "cust_p1ufreYbVbwZ1x70nFkH9rF9",
"referrer_id": "cust_p1ufreYbVbwZ1x70nFkH9rF9",
"redemption": {
"quantity": null,
"redeemed_quantity": 0,
"object": "list",
"url": "/v1/vouchers/PBF3ZYfS/redemptions?page=1&limit=10"
},
"publish": {
"object": "list",
"count": 1,
"url": "/v1/vouchers/PBF3ZYfS/publications?page=1&limit=10"
},
"object": "voucher"
},
"status": "ACTIVE"
}
}
],
"total": 2,
"has_more": false
}Retrieves all the redeemables that have been assigned to the customer.
To use this endpoint, you must have the following permissions:
- Read Customers (
customers.details.read)
curl --request GET \
--url https://{cluster}.voucherify.io/v1/customers/{customerId}/redeemables \
--header 'Authorization: Bearer <token>' \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>'{
"object": "list",
"data_ref": "data",
"data": [
{
"id": "rh_0e7b8db4700106a852",
"created_at": "2024-03-22T17:48:25.910Z",
"redeemable_id": "v_GXVguPhq2khgFxH7GrRXWA91gDr1LiA1",
"redeemable_object": "voucher",
"customer_id": "cust_p1ufreYbVbwZ1x70nFkH9rF9",
"holder_role": "OWNER",
"campaign_id": "camp_weer1c3p5ZgktqfW56RfoNaG",
"campaign_type": "DISCOUNT_COUPONS",
"voucher_type": "DISCOUNT_VOUCHER",
"redeemable": {
"type": "voucher",
"voucher": {
"id": "v_GXVguPhq2khgFxH7GrRXWA91gDr1LiA1",
"code": "3xRUnMVG",
"campaign": "Gaz6Q29w1d",
"campaign_id": "camp_weer1c3p5ZgktqfW56RfoNaG",
"category": null,
"category_id": null,
"categories": [],
"type": "DISCOUNT_VOUCHER",
"discount": {
"type": "AMOUNT",
"amount_off": 1000
},
"gift": null,
"loyalty_card": null,
"start_date": null,
"expiration_date": null,
"validity_timeframe": null,
"validity_hours": null,
"validity_day_of_week": null,
"active": true,
"additional_info": null,
"metadata": {},
"assets": {
"qr": {
"id": "fa250fcd-8d51-41e7-9dda-9288ce2799a7",
"url": "{{internalVoucherifyURL}}"
},
"barcode": {
"id": "1b876033-ad88-4e74-8344-27fca1767006",
"url": "{{internalVoucherifyURL}}"
}
},
"is_referral_code": false,
"created_at": "2024-03-22T17:48:18.57+00:00",
"updated_at": "2024-03-22T17:48:25.910974+00:00",
"holder_id": "cust_p1ufreYbVbwZ1x70nFkH9rF9",
"redemption": {
"quantity": null,
"redeemed_quantity": 0,
"object": "list",
"url": "/v1/vouchers/3xRUnMVG/redemptions?page=1&limit=10"
},
"publish": {
"object": "list",
"count": 1,
"url": "/v1/vouchers/3xRUnMVG/publications?page=1&limit=10"
},
"object": "voucher"
},
"status": "ACTIVE"
}
},
{
"id": "rh_0e79fe37e4926cafd6",
"created_at": "2024-03-21T12:43:02.915Z",
"redeemable_id": "v_nnxc1aFzFZCAhRlG6sm0kSO4jKUohc9b",
"redeemable_object": "voucher",
"customer_id": "cust_p1ufreYbVbwZ1x70nFkH9rF9",
"holder_role": "REFERRER",
"campaign_id": "camp_ixXNxP8kRoV15RoyZU4HqqYJ",
"campaign_type": "REFERRAL_PROGRAM",
"voucher_type": "DISCOUNT_VOUCHER",
"redeemable": {
"type": "voucher",
"voucher": {
"id": "v_nnxc1aFzFZCAhRlG6sm0kSO4jKUohc9b",
"code": "PBF3ZYfS",
"campaign": "REFER_2",
"campaign_id": "camp_ixXNxP8kRoV15RoyZU4HqqYJ",
"category": null,
"category_id": null,
"categories": [],
"type": "DISCOUNT_VOUCHER",
"discount": {
"type": "AMOUNT",
"amount_off": 88800,
"effect": "APPLY_TO_ORDER"
},
"gift": null,
"loyalty_card": null,
"start_date": null,
"expiration_date": null,
"validity_timeframe": null,
"validity_hours": null,
"validity_day_of_week": null,
"active": true,
"additional_info": null,
"metadata": {},
"assets": {
"qr": {
"id": "fc0471bf-0c7b-443f-9532-303437041eea",
"url": "{{internalVoucherifyURL}}"
},
"barcode": {
"id": "5b2f2007-494b-40c3-9d4c-ad27269a0cd0",
"url": "{{internalVoucherifyURL}}"
}
},
"is_referral_code": true,
"created_at": "2024-03-21T12:42:49.771+00:00",
"updated_at": "2024-03-21T12:43:02.915953+00:00",
"holder_id": "cust_p1ufreYbVbwZ1x70nFkH9rF9",
"referrer_id": "cust_p1ufreYbVbwZ1x70nFkH9rF9",
"redemption": {
"quantity": null,
"redeemed_quantity": 0,
"object": "list",
"url": "/v1/vouchers/PBF3ZYfS/redemptions?page=1&limit=10"
},
"publish": {
"object": "list",
"count": 1,
"url": "/v1/vouchers/PBF3ZYfS/publications?page=1&limit=10"
},
"object": "voucher"
},
"status": "ACTIVE"
}
}
],
"total": 2,
"has_more": false
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Unique identifier of a customer represented by an internal customer ID or customer source ID.
"cust_nk0N1uNQ1YnupAoJGOgvsODC"
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 <= 100Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
id, -id A cursor for pagination. It retrieves the events starting after an event with the given ID.
Filters for listing customer redeemables.
Show child attributes
Show child attributes
Unique redeemable holder ID, i.e. rh_0e77502f84f0f4a6a8.
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.
Timestamp representing the date and time when the customer redeemable was created. The value is shown in the ISO 8601 format.
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
Value is after this date. The value for this parameter is shown in the ISO 8601 format.
"2024-01-01T00:00:00.000Z"
Value is before this date. The value for this parameter is shown in the ISO 8601 format.
"2024-01-01T00:00:00.000Z"
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 is more days ago before the current date and time, e.g. more than 10 days ago.
Value is less days before the current date and time, e.g. less than 10 days ago.
Unique redeemable ID, e.g. 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, i.e. voucher.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Array of resource values that should be included in the results (multiple values).
voucher Array of resource values that should be included in the results (multiple values).
voucher Value is exactly this value (single value).
voucher Results omit this value (single value).
voucher 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.
Holder role of the redeemable. Allowed values:
OWNER,
REFEREE,
REFERRER.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Array of resource values that should be included in the results (multiple values).
OWNER, REFEREE, REFERRER Array of resource values that should be included in the results (multiple values).
OWNER, REFEREE, REFERRER Value is exactly this value (single value).
OWNER, REFEREE, REFERRER Results omit this value (single value).
OWNER, REFEREE, REFERRER 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.
Unique campaign identifer, e.g. camp_bfrwAVsP6Q1EM1ZjgHwheKYr.
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.
Type of the campaign. Allowed values:
DISCOUNT_COUPONS,
REFERRAL_PROGRAM,
GIFT_VOUCHERS,
LOYALTY_PROGRAM
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Array of resource values that should be included in the results (multiple values).
LOYALTY_PROGRAM, GIFT_VOUCHERS, DISCOUNT_COUPONS, REFERRAL_PROGRAM Array of resource values that should be included in the results (multiple values).
LOYALTY_PROGRAM, GIFT_VOUCHERS, DISCOUNT_COUPONS, REFERRAL_PROGRAM Value is exactly this value (single value).
LOYALTY_PROGRAM, GIFT_VOUCHERS, DISCOUNT_COUPONS, REFERRAL_PROGRAM Results omit this value (single value).
LOYALTY_PROGRAM, GIFT_VOUCHERS, DISCOUNT_COUPONS, REFERRAL_PROGRAM 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.
Type of the voucher. Allowed values:
DISCOUNT_VOUCHER,
GIFT_VOUCHER,
LOYALTY_CARD.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Array of resource values that should be included in the results (multiple values).
GIFT_VOUCHER, DISCOUNT_VOUCHER, LOYALTY_CARD Array of resource values that should be included in the results (multiple values).
GIFT_VOUCHER, DISCOUNT_VOUCHER, LOYALTY_CARD Value is exactly this value (single value).
GIFT_VOUCHER, DISCOUNT_VOUCHER, LOYALTY_CARD Results omit this value (single value).
GIFT_VOUCHER, DISCOUNT_VOUCHER, LOYALTY_CARD 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.
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
The method returns redeemable(s) to which the given customer is assigned.
Response body schema for GET v1/customers/{customerId}/redeemables.
List of customer's redeemables
The type of the object represented by JSON. This object stores information about customer redeemables.
Identifies the name of the JSON property that contains the array of redeemables.
A dictionary that contains an array of redeemables.
Show child attributes
Show child attributes
Unique redeemable holder identifier.
"rh_0e7b8db4700106a852"
Timestamp representing the date and time when the redeemable was assigned. The value is shown in the ISO 8601 format.
"2024-03-22T17:48:25.910Z"
Identifier of the redeemable item.
"v_GXVguPhq2khgFxH7GrRXWA91gDr1LiA1"
Type of the redeemable.
"voucher"
Identifier of the customer.
"cust_p1ufreYbVbwZ1x70nFkH9rF9"
Role of the holder.
OWNER, REFERRER, REFEREE "OWNER"
Unique campaign identifier, assigned by Voucherify.
"camp_weer1c3p5ZgktqfW56RfoNaG"
Defines the type of the campaign.
LOYALTY_PROGRAM, GIFT_VOUCHERS, DISCOUNT_COUPONS, PROMOTION, REFERRAL_PROGRAM "DISCOUNT_COUPONS"
Defines the type of the voucher.
GIFT_VOUCHER, DISCOUNT_VOUCHER, LOYALTY_CARD "DISCOUNT_VOUCHER"
Detailed information about the customer's redeemable item
Show child attributes
Show child attributes
Type of the redeemable.
"voucher"
Defines the details of the voucher.
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"
The value is null.
Unique category ID assigned by Voucherify.
"cat_0bb343dee3cdb5ec0c"
Contains an empty array.
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. balance = amount - subtracted_amount - redemption.redeemed_amount.
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 identifier of the referring person.
"cust_Vzck5i8U3OhcEUFY6MKhN9Rv"
Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify.
"cust_eWgXlBBiY6THFRJwX45Iakv4"
The type of the object represented by JSON. Default is voucher.
This object stores a summary of publish events: an events counter and an endpoint which can be called to return details of each event. A publication is required for loyalty cards and referral codes. This object gets updated whenever a voucher has been published. Publication means assigning a code to a particular customer. Typically, a publication is made by distributing your codes to your customers, e.g. through Export to MailChimp or
| Required | Optional |
|---|---|
type:LOYALTY_CARD | type:DISCOUNT_VOUCHER |
is_referral_code:true | type:GIFT_VOUCHER |
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"
Status of the redeemable.
ACTIVE, USED, DISABLED, NOT_ACTIVE_YET, EXPIRED, NO_BALANCE "ACTIVE"
Total number of results returned.
As query results are always limited (by the limit parameter), the has_more flag indicates if there are more records for given filter parameters. This lets you know if you can run another request with a starting_after_id query or a different limit to get more records returned in the results.
Returns an ID that can be used to return another page of results. Use the ID in the starting_after_id query parameter to display another page of the results occuring after the field with that ID.
Was this page helpful?