Generate Random Code

post https://{cluster}.voucherify.io/v1/vouchers

Create a standalone voucher. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD.

When you create a new voucher, you can specify a type to create it.
Creating a new voucher will create a new standalone voucher if no campaign name or campaign_id is provided. However, if an ID or name of a campaign with the type set to STANDALONE is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required.

You can optionally use the code parameter to define a specific code or the code_config parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API.

This method will return an error when trying to create a voucher that already exists.

🚧
Standalone Vouchers and Campaigns
In version v20241004, standalone vouchers created through the Voucherify dashboard create a campaign for that voucher. However, vouchers created through the API do not have a campaign attached, so the values for campaign and campaign_id are null.
Voucherify developers work on adding an optional feature to create a standalone voucher campaign through the API.
Follow the Voucherify Release Notes for more details about released features.

Responses

Response body

object

string

Assigned by the Voucherify API, identifies the voucher.

code

string

A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters.

campaign

string

A unique campaign name, identifies the voucher's parent campaign.

campaign_id

string

Assigned by the Voucherify API, identifies the voucher's parent campaign.

categories

object

string

required

Unique category ID assigned by Voucherify.

name

string

required

Category name.

hierarchy

integer

required

≥ 0

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

object

string

required

Defaults to category

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

category

created_at

date-time

required

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

updated_at

date-time

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

validation_rules_assignments

object

List of Validation Rules Assignments

object

string

required

Defaults to list

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

list

data_ref

string

required

Defaults to data

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

data

data

array of objects

required

Contains array of validation rules assignments.

data*

object

string

required

The unique identifier for a assignment

rule_id

string

required

The unique identifier for a rule

related_object_id

string

required

The unique identifier for a related object

related_object_type

string

required

The type of related object

created_at

date-time

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

updated_at

date-time

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

object

string

required

Defaults to validation_rules_assignment

The type of the object represented by JSON.

validation_rules_assignment

validation_status

string

The validation status of the assignment

VALID PARTIALLY_VALID INVALID

validation_omitted_rules

array of strings

The list of omitted rules

validation_omitted_rules

total

integer

required

≥ 0

Total number of validation rules assignments.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.voucherify.io/v1/vouchers \
3
     --header 'X-Voucherify-Channel: Voucherify Documentation' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returns a voucher object if the call succeeded.

400Returns an error if the data is invalid.