All URIs are relative to https://api.voucherify.io
| Method | HTTP request | Description |
|---|---|---|
| create_voucher | POST /v1/vouchers/{code} | Create Voucher |
| delete_voucher | DELETE /v1/vouchers/{code} | Delete Voucher |
| disable_voucher | POST /v1/vouchers/{code}/disable | Disable Voucher |
| enable_voucher | POST /v1/vouchers/{code}/enable | Enable Voucher |
| export_voucher_transactions | POST /v1/vouchers/{code}/transactions/export | Export Voucher Transactions |
| generate_random_code | POST /v1/vouchers | Generate Random Code |
| get_voucher | GET /v1/vouchers/{code} | Get Voucher |
| import_vouchers | POST /v1/vouchers/import | Import Vouchers |
| import_vouchers_using_csv | POST /v1/vouchers/importCSV | Import Vouchers using CSV |
| list_voucher_transactions | GET /v1/vouchers/{code}/transactions | List Voucher Transactions |
| list_vouchers | GET /v1/vouchers | List Vouchers |
| release_validation_session | DELETE /v1/vouchers/{code}/sessions/{sessionKey} | Release Validation Session |
| update_voucher | PUT /v1/vouchers/{code} | Update Voucher |
| update_voucher_balance | POST /v1/vouchers/{code}/balance | Add or Remove Voucher Balance |
| update_vouchers_in_bulk | POST /v1/vouchers/bulk/async | Update Vouchers in Bulk |
| update_vouchers_metadata_in_bulk | POST /v1/vouchers/metadata/async | Update Vouchers' Metadata in Bulk |
create_voucher(code, opts)
Create Voucher
Create a standalone voucher. You can choose to create a GIFT_VOUCHER, a DISCOUNT_VOUCHER, or a LOYALTY_CARD. The code path parameter can use all letters of the English alphabet, Arabic numerals and special characters. When you create a new voucher, you can specify a type to create it. Creating a new voucher will create a new stand alone voucher if no campaign name or campaign_id is provided. In case of the loyalty card, a campaign name is required.
require 'time'
require 'VoucherifySdk'
# setup authorization
VoucherifySdk.configure do |config|
# Configure API key authorization: X-App-Id
config.api_key['X-App-Id'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Id'] = 'Bearer'
# Configure API key authorization: X-App-Token
config.api_key['X-App-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Token'] = 'Bearer'
end
api_instance = VoucherifySdk::VouchersApi.new
code = 'code_example' # String | A unique **code** that identifies the voucher.
opts = {
vouchers_create_with_specific_code_request_body: VoucherifySdk::VouchersCreateWithSpecificCodeRequestBody.new # VouchersCreateWithSpecificCodeRequestBody | Specify the details of the voucher that you would like to create.
}
begin
# Create Voucher
result = api_instance.create_voucher(code, opts)
p result
rescue VoucherifySdk::ApiError => e
puts "Error when calling VouchersApi->create_voucher: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| code | String | A unique code that identifies the voucher. | |
| vouchers_create_with_specific_code_request_body | VouchersCreateWithSpecificCodeRequestBody | Specify the details of the voucher that you would like to create. | [optional] |
- Content-Type: application/json
- Accept: application/json
delete_voucher(code, opts)
Delete Voucher
Deletes a voucher. This operation cannot be undone. Additionally, this operation removes any redemptions on the voucher. If the force parameter is set to false or not set at all, the voucher will be moved to the bin.
require 'time'
require 'VoucherifySdk'
# setup authorization
VoucherifySdk.configure do |config|
# Configure API key authorization: X-App-Id
config.api_key['X-App-Id'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Id'] = 'Bearer'
# Configure API key authorization: X-App-Token
config.api_key['X-App-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Token'] = 'Bearer'
end
api_instance = VoucherifySdk::VouchersApi.new
code = 'code_example' # String | A unique **code** that identifies the voucher.
opts = {
force: true # Boolean | If this flag is set to true, the voucher will be removed permanently. If it is set to false or not set at all, the voucher will be moved to the bin. Going forward, the user will be able to create another voucher with exactly the same code.
}
begin
# Delete Voucher
api_instance.delete_voucher(code, opts)
rescue VoucherifySdk::ApiError => e
puts "Error when calling VouchersApi->delete_voucher: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| code | String | A unique code that identifies the voucher. | |
| force | Boolean | If this flag is set to true, the voucher will be removed permanently. If it is set to false or not set at all, the voucher will be moved to the bin. Going forward, the user will be able to create another voucher with exactly the same code. | [optional] |
nil (empty response body)
- Content-Type: Not defined
- Accept: Not defined
disable_voucher(code)
Disable Voucher
There are various times when youll want to manage a vouchers accessibility. This can be done by two API methods for managing the voucher state - enable and disable. ___ This method sets the voucher state to inactive. The voucher cannot be redeemed.
require 'time'
require 'VoucherifySdk'
# setup authorization
VoucherifySdk.configure do |config|
# Configure API key authorization: X-App-Id
config.api_key['X-App-Id'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Id'] = 'Bearer'
# Configure API key authorization: X-App-Token
config.api_key['X-App-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Token'] = 'Bearer'
end
api_instance = VoucherifySdk::VouchersApi.new
code = 'code_example' # String | A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u.
begin
# Disable Voucher
result = api_instance.disable_voucher(code)
p result
rescue VoucherifySdk::ApiError => e
puts "Error when calling VouchersApi->disable_voucher: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| code | String | A code that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. |
- Content-Type: Not defined
- Accept: application/json
enable_voucher(code)
Enable Voucher
There are various times when youll want to manage a vouchers accessibility. This can be done by two API methods for managing the voucher state - enable and disable. ___ The method sets the voucher state to active. The voucher can be redeemed - only if the redemption occurs after the start date and the voucher is not expired.
require 'time'
require 'VoucherifySdk'
# setup authorization
VoucherifySdk.configure do |config|
# Configure API key authorization: X-App-Id
config.api_key['X-App-Id'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Id'] = 'Bearer'
# Configure API key authorization: X-App-Token
config.api_key['X-App-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Token'] = 'Bearer'
end
api_instance = VoucherifySdk::VouchersApi.new
code = 'code_example' # String | A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u.
begin
# Enable Voucher
result = api_instance.enable_voucher(code)
p result
rescue VoucherifySdk::ApiError => e
puts "Error when calling VouchersApi->enable_voucher: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| code | String | A code that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. |
- Content-Type: Not defined
- Accept: application/json
export_voucher_transactions(code, opts)
Export Voucher Transactions
Export transactions that are associated with credit movements on a gift card or loyalty card.
require 'time'
require 'VoucherifySdk'
# setup authorization
VoucherifySdk.configure do |config|
# Configure API key authorization: X-App-Id
config.api_key['X-App-Id'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Id'] = 'Bearer'
# Configure API key authorization: X-App-Token
config.api_key['X-App-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Token'] = 'Bearer'
end
api_instance = VoucherifySdk::VouchersApi.new
code = 'GIFT-CARD-1' # String | A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u.
opts = {
vouchers_transactions_export_create_request_body: VoucherifySdk::VouchersTransactionsExportCreateRequestBody.new # VouchersTransactionsExportCreateRequestBody | Specify the parameters for the transaction export.
}
begin
# Export Voucher Transactions
result = api_instance.export_voucher_transactions(code, opts)
p result
rescue VoucherifySdk::ApiError => e
puts "Error when calling VouchersApi->export_voucher_transactions: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| code | String | A code that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. | |
| vouchers_transactions_export_create_request_body | VouchersTransactionsExportCreateRequestBody | Specify the parameters for the transaction export. | [optional] |
VouchersTransactionsExportCreateResponseBody
- Content-Type: application/json
- Accept: application/json
generate_random_code(opts)
Generate Random Code
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 stand alone voucher if no campaign name or campaign_id is provided. 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.
require 'time'
require 'VoucherifySdk'
# setup authorization
VoucherifySdk.configure do |config|
# Configure API key authorization: X-App-Id
config.api_key['X-App-Id'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Id'] = 'Bearer'
# Configure API key authorization: X-App-Token
config.api_key['X-App-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Token'] = 'Bearer'
end
api_instance = VoucherifySdk::VouchersApi.new
opts = {
body: { ... } # Object | Specify the details of the voucher that you would like to create.
}
begin
# Generate Random Code
result = api_instance.generate_random_code(opts)
p result
rescue VoucherifySdk::ApiError => e
puts "Error when calling VouchersApi->generate_random_code: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| body | Object | Specify the details of the voucher that you would like to create. | [optional] |
- Content-Type: application/json
- Accept: application/json
get_voucher(code)
Get Voucher
Retrieves the voucher with the given code or unique Voucherify ID. You can either pass the voucher ID which was assigned by Voucherify, e.g., v_7HxHkf4VAkMuc8u4lZs78lyRwhRze5UE, or the code of the voucher as the path parameter value, e.g., 7fjWdr.
require 'time'
require 'VoucherifySdk'
# setup authorization
VoucherifySdk.configure do |config|
# Configure API key authorization: X-App-Id
config.api_key['X-App-Id'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Id'] = 'Bearer'
# Configure API key authorization: X-App-Token
config.api_key['X-App-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Token'] = 'Bearer'
end
api_instance = VoucherifySdk::VouchersApi.new
code = 'code_example' # String | A unique **code** that identifies the voucher.
begin
# Get Voucher
result = api_instance.get_voucher(code)
p result
rescue VoucherifySdk::ApiError => e
puts "Error when calling VouchersApi->get_voucher: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| code | String | A unique code that identifies the voucher. |
- Content-Type: Not defined
- Accept: application/json
import_vouchers(vouchers_import_create_item_request_body)
Import Vouchers
Import standalone vouchers and gift cards into the repository. 📘 Important notes - Start and expiration dates need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - Custom code attributes (not supported by-default) need to be added as code metadata. - You cannot import the same codes to a single Voucherify Project. Any parameters not provided in the payload will be left blank or null. For both standalone discount vouchers and gift cards, you can import the following fields: - code - category - active - type - start_date - expiration_date - redemption.quantity - additional_info - metadata For gift cards, you can also import the following field: - gift.amount For discount vouchers, you can import the discount object. The object will slightly vary depending on the type of discount. Each discount type requires the type to be defined in the import. Fields other than the ones listed above wont be imported. Even if provided, they will be silently skipped. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this API request.
require 'time'
require 'VoucherifySdk'
# setup authorization
VoucherifySdk.configure do |config|
# Configure API key authorization: X-App-Id
config.api_key['X-App-Id'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Id'] = 'Bearer'
# Configure API key authorization: X-App-Token
config.api_key['X-App-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Token'] = 'Bearer'
end
api_instance = VoucherifySdk::VouchersApi.new
vouchers_import_create_item_request_body = [VoucherifySdk::VouchersImportCreateItemRequestBody.new] # Array<VouchersImportCreateItemRequestBody> | The request body is an array of objects. Each object contains details about a specific voucher.
begin
# Import Vouchers
result = api_instance.import_vouchers(vouchers_import_create_item_request_body)
p result
rescue VoucherifySdk::ApiError => e
puts "Error when calling VouchersApi->import_vouchers: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| vouchers_import_create_item_request_body | Array<VouchersImportCreateItemRequestBody> | The request body is an array of objects. Each object contains details about a specific voucher. |
VouchersImportCreateResponseBody
- Content-Type: application/json
- Accept: application/json
import_vouchers_using_csv(opts)
Import Vouchers using CSV
Import standalone vouchers into the repository using a CSV file. The CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object. You can find an example CSV file here. ___ 📘 Standard voucher fields mapping - Go to the import vouchers endpoint to see all standard CSV fields description (body params section). - Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name - Start and expiration dates need to be provided in compliance with the ISO 8601 norms. For example, 2020-03-11T09:00:00.000Z. - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ - Custom code attributes (not supported by-default) need to be added as code metadata. - You cannot import the same codes to a single Voucherify Project. 📘 Categories In the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the List Vouchers endpoint. This API request starts a process that affects Voucherify data in bulk. In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. The result will return the async ID. You can verify the status of your request via this API request.
require 'time'
require 'VoucherifySdk'
# setup authorization
VoucherifySdk.configure do |config|
# Configure API key authorization: X-App-Id
config.api_key['X-App-Id'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Id'] = 'Bearer'
# Configure API key authorization: X-App-Token
config.api_key['X-App-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Token'] = 'Bearer'
end
api_instance = VoucherifySdk::VouchersApi.new
opts = {
file: File.new('/path/to/some/file') # File | File path.
}
begin
# Import Vouchers using CSV
result = api_instance.import_vouchers_using_csv(opts)
p result
rescue VoucherifySdk::ApiError => e
puts "Error when calling VouchersApi->import_vouchers_using_csv: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| file | File | File path. | [optional] |
VouchersImportCsvCreateResponseBody
- Content-Type: multipart/form-data
- Accept: application/json
list_voucher_transactions(code, opts)
List Voucher Transactions
List transactions that are associated with credit movements on a gift card or loyalty card.
require 'time'
require 'VoucherifySdk'
# setup authorization
VoucherifySdk.configure do |config|
# Configure API key authorization: X-App-Id
config.api_key['X-App-Id'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Id'] = 'Bearer'
# Configure API key authorization: X-App-Token
config.api_key['X-App-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Token'] = 'Bearer'
end
api_instance = VoucherifySdk::VouchersApi.new
code = 'code_example' # String | A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u.
opts = {
limit: 56, # Integer | 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.
page: 56 # Integer | Which page of results to return. The lowest value is 1.
}
begin
# List Voucher Transactions
result = api_instance.list_voucher_transactions(code, opts)
p result
rescue VoucherifySdk::ApiError => e
puts "Error when calling VouchersApi->list_voucher_transactions: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| code | String | A code that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. | |
| limit | Integer | 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. | [optional] |
| page | Integer | Which page of results to return. The lowest value is 1. | [optional] |
VouchersTransactionsListResponseBody
- Content-Type: Not defined
- Accept: application/json
list_vouchers(opts)
List Vouchers
Returns a list of vouchers. By default, the vouchers are returned sorted by creation date, with the most recent vouchers appearing first. A maximum of 100 vouchers are returned in the response. When you get a list of vouchers, you can optionally specify query parameters to customize the number of vouchers returned per call using limit, which page of vouchers to return using page, sort the vouchers using the order query parameter and more. This method will return an error when trying to return a limit of more than 100 vouchers.
require 'time'
require 'VoucherifySdk'
# setup authorization
VoucherifySdk.configure do |config|
# Configure API key authorization: X-App-Id
config.api_key['X-App-Id'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Id'] = 'Bearer'
# Configure API key authorization: X-App-Token
config.api_key['X-App-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Token'] = 'Bearer'
end
api_instance = VoucherifySdk::VouchersApi.new
opts = {
limit: 56, # Integer | 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.
page: 56, # Integer | Which page of results to return. The lowest value is 1.
category: 'category_example', # String | Limit search results to vouchers within the specified category.
campaign_id: 'campaign_id_example', # String | Limit search results to vouchers within the specified campaign
customer: 'customer_example', # String | A tracking identifier of a customer who is the holder of the vouchers. It can be an id generated by Voucherify or the source_id. Remember to use the proper URL escape codes if the source_id contains special characters.
campaign: 'campaign_example', # String | A unique campaign name, identifies the parent campaign.
created_at: VoucherifySdk::ParameterCreatedBeforeAfter.new, # ParameterCreatedBeforeAfter | 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
updated_at: VoucherifySdk::ParameterUpdatedBeforeAfter.new, # ParameterUpdatedBeforeAfter | A filter on the list based on the object updated_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: [updated_at][before] 2017-09-08T13:52:18.227Z
order: VoucherifySdk::ParameterOrderVouchers::CREATED_AT, # ParameterOrderVouchers | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.
code: 'code_example', # String |
ids: ['inner_example'] # Array<String> |
}
begin
# List Vouchers
result = api_instance.list_vouchers(opts)
p result
rescue VoucherifySdk::ApiError => e
puts "Error when calling VouchersApi->list_vouchers: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| limit | Integer | 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. | [optional] |
| page | Integer | Which page of results to return. The lowest value is 1. | [optional] |
| category | String | Limit search results to vouchers within the specified category. | [optional] |
| campaign_id | String | Limit search results to vouchers within the specified campaign | [optional] |
| customer | String | A tracking identifier of a customer who is the holder of the vouchers. It can be an id generated by Voucherify or the source_id. Remember to use the proper URL escape codes if the source_id contains special characters. | [optional] |
| campaign | String | A unique campaign name, identifies the parent campaign. | [optional] |
| created_at | ParameterCreatedBeforeAfter | 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 | [optional] |
| updated_at | ParameterUpdatedBeforeAfter | A filter on the list based on the object updated_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: [updated_at][before] 2017-09-08T13:52:18.227Z | [optional] |
| order | ParameterOrderVouchers | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] |
| code | String | [optional] | |
| ids | Array<String> | [optional] |
- Content-Type: Not defined
- Accept: application/json
release_validation_session(code, session_key)
Release Validation Session
Manually release a validation session that has been set up for the voucher. This method undos the actions that are explained in our guide on how a validation session was established, you can read more here. 📘 Release Session using Dashboard You can also use the Validations Manager in the Dashboard to unlock sessions. Read more.
require 'time'
require 'VoucherifySdk'
# setup authorization
VoucherifySdk.configure do |config|
# Configure API key authorization: X-App-Id
config.api_key['X-App-Id'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Id'] = 'Bearer'
# Configure API key authorization: X-App-Token
config.api_key['X-App-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Token'] = 'Bearer'
end
api_instance = VoucherifySdk::VouchersApi.new
code = 'code_example' # String | A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify.
session_key = 'ssn_yQGMTeKBSw8OOuFPwlBEjzGy8d8VA9Ts' # String | A unique session identifier.
begin
# Release Validation Session
api_instance.release_validation_session(code, session_key)
rescue VoucherifySdk::ApiError => e
puts "Error when calling VouchersApi->release_validation_session: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| code | String | A code that identifies the voucher or a unique voucher ID assigned by Voucherify. | |
| session_key | String | A unique session identifier. |
nil (empty response body)
- Content-Type: Not defined
- Accept: Not defined
update_voucher(code, vouchers_update_request_body)
Update Voucher
Updates the specified voucher by setting the values of the parameters passed in the request body. Any parameters not provided in the payload will be left unchanged. Fields other than the ones listed in the request body wont be modified. Even if provided, they will be silently skipped.
require 'time'
require 'VoucherifySdk'
# setup authorization
VoucherifySdk.configure do |config|
# Configure API key authorization: X-App-Id
config.api_key['X-App-Id'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Id'] = 'Bearer'
# Configure API key authorization: X-App-Token
config.api_key['X-App-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Token'] = 'Bearer'
end
api_instance = VoucherifySdk::VouchersApi.new
code = 'code_example' # String | A unique **code** that identifies the voucher.
vouchers_update_request_body = VoucherifySdk::VouchersUpdateRequestBody.new # VouchersUpdateRequestBody | Specify the parameters to be updated.
begin
# Update Voucher
result = api_instance.update_voucher(code, vouchers_update_request_body)
p result
rescue VoucherifySdk::ApiError => e
puts "Error when calling VouchersApi->update_voucher: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| code | String | A unique code that identifies the voucher. | |
| vouchers_update_request_body | VouchersUpdateRequestBody | Specify the parameters to be updated. |
- Content-Type: application/json
- Accept: application/json
update_voucher_balance(code, vouchers_balance_update_request_body)
Add or Remove Voucher Balance
Add balance to an existing gift card or loyalty card.
require 'time'
require 'VoucherifySdk'
# setup authorization
VoucherifySdk.configure do |config|
# Configure API key authorization: X-App-Id
config.api_key['X-App-Id'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Id'] = 'Bearer'
# Configure API key authorization: X-App-Token
config.api_key['X-App-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Token'] = 'Bearer'
end
api_instance = VoucherifySdk::VouchersApi.new
code = 'code_example' # String | A **code** that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u.
vouchers_balance_update_request_body = VoucherifySdk::VouchersBalanceUpdateRequestBody.new # VouchersBalanceUpdateRequestBody | Provide the amount to be added to/subtracted from the voucher.
begin
# Add or Remove Voucher Balance
result = api_instance.update_voucher_balance(code, vouchers_balance_update_request_body)
p result
rescue VoucherifySdk::ApiError => e
puts "Error when calling VouchersApi->update_voucher_balance: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| code | String | A code that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u. | |
| vouchers_balance_update_request_body | VouchersBalanceUpdateRequestBody | Provide the amount to be added to/subtracted from the voucher. |
VouchersBalanceUpdateResponseBody
- Content-Type: application/json
- Accept: application/json
update_vouchers_in_bulk(vouchers_update_in_bulk_item_request_body)
Update Vouchers in Bulk
Updates specific metadata parameters for each code, respectively, in one asynchronous operation. The request can include up to 10 MB of data. Upserts are not supported. 🚧 Currently, only metadata updates are supported. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the GET Async Action endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.
require 'time'
require 'VoucherifySdk'
# setup authorization
VoucherifySdk.configure do |config|
# Configure API key authorization: X-App-Id
config.api_key['X-App-Id'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Id'] = 'Bearer'
# Configure API key authorization: X-App-Token
config.api_key['X-App-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Token'] = 'Bearer'
end
api_instance = VoucherifySdk::VouchersApi.new
vouchers_update_in_bulk_item_request_body = [VoucherifySdk::VouchersUpdateInBulkItemRequestBody.new] # Array<VouchersUpdateInBulkItemRequestBody> | List the codes to be updated with the metadata key/value pairs for that code.
begin
# Update Vouchers in Bulk
result = api_instance.update_vouchers_in_bulk(vouchers_update_in_bulk_item_request_body)
p result
rescue VoucherifySdk::ApiError => e
puts "Error when calling VouchersApi->update_vouchers_in_bulk: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| vouchers_update_in_bulk_item_request_body | Array<VouchersUpdateInBulkItemRequestBody> | List the codes to be updated with the metadata key/value pairs for that code. |
VouchersUpdateInBulkResponseBody
- Content-Type: application/json
- Accept: application/json
update_vouchers_metadata_in_bulk(vouchers_metadata_update_in_bulk_request_body)
Update Vouchers' Metadata in Bulk
Updates metadata parameters for a list of codes. Every resource in the list will receive the metadata defined in the request. The request can include up to 10 MB of data. Upserts are not supported. The response returns a unique asynchronous action ID. Use this ID in the query paramater of the GET Async Action endpoint to check, e.g.: - The status of your request (in queue, in progress, done, or failed) - Resources that failed to be updated - The report file with details about the update This API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.
require 'time'
require 'VoucherifySdk'
# setup authorization
VoucherifySdk.configure do |config|
# Configure API key authorization: X-App-Id
config.api_key['X-App-Id'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Id'] = 'Bearer'
# Configure API key authorization: X-App-Token
config.api_key['X-App-Token'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['X-App-Token'] = 'Bearer'
end
api_instance = VoucherifySdk::VouchersApi.new
vouchers_metadata_update_in_bulk_request_body = VoucherifySdk::VouchersMetadataUpdateInBulkRequestBody.new # VouchersMetadataUpdateInBulkRequestBody | List the codes of the vouchers you would like to update with the metadata key/value pairs.
begin
# Update Vouchers' Metadata in Bulk
result = api_instance.update_vouchers_metadata_in_bulk(vouchers_metadata_update_in_bulk_request_body)
p result
rescue VoucherifySdk::ApiError => e
puts "Error when calling VouchersApi->update_vouchers_metadata_in_bulk: #{e}"
end| Name | Type | Description | Notes |
|---|---|---|---|
| vouchers_metadata_update_in_bulk_request_body | VouchersMetadataUpdateInBulkRequestBody | List the codes of the vouchers you would like to update with the metadata key/value pairs. |
VouchersMetadataUpdateInBulkResponseBody
- Content-Type: application/json
- Accept: application/json