OpenAPI\Client\VouchersApi

All URIs are relative to https://api.voucherify.io, except if the operation defines another base path.

Method	HTTP request	Description
createVoucher()	POST /v1/vouchers/{code}	Create Voucher
deleteVoucher()	DELETE /v1/vouchers/{code}	Delete Voucher
disableVoucher()	POST /v1/vouchers/{code}/disable	Disable Voucher
enableVoucher()	POST /v1/vouchers/{code}/enable	Enable Voucher
exportVoucherTransactions()	POST /v1/vouchers/{code}/transactions/export	Export Voucher Transactions
generateRandomCode()	POST /v1/vouchers	Generate Random Code
getVoucher()	GET /v1/vouchers/{code}	Get Voucher
importVouchers()	POST /v1/vouchers/import	Import Vouchers
importVouchersUsingCsv()	POST /v1/vouchers/importCSV	Import Vouchers using CSV
listVoucherTransactions()	GET /v1/vouchers/{code}/transactions	List Voucher Transactions
listVouchers()	GET /v1/vouchers	List Vouchers
releaseValidationSession()	DELETE /v1/vouchers/{code}/sessions/{sessionKey}	Release Validation Session
updateVoucher()	PUT /v1/vouchers/{code}	Update Voucher
updateVoucherBalance()	POST /v1/vouchers/{code}/balance	Add or Remove Voucher Balance
updateVouchersInBulk()	POST /v1/vouchers/bulk/async	Update Vouchers in Bulk
updateVouchersMetadataInBulk()	POST /v1/vouchers/metadata/async	Update Vouchers' Metadata in Bulk

`createVoucher()`

createVoucher($code, $vouchers_create_with_specific_code_request_body): \OpenAPI\Client\Model\VouchersCreateResponseBody

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: X-App-Id
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');

// Configure API key authorization: X-App-Token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\VouchersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$code = 'code_example'; // string | A unique **code** that identifies the voucher.
$vouchers_create_with_specific_code_request_body = {"category":"New Customers","type":"DISCOUNT_VOUCHER","discount":{"percent_off":10,"type":"PERCENT","effect":"APPLY_TO_ORDER"},"start_date":"2022-01-01T00:00:00Z","expiration_date":"2022-12-31T23:59:59Z","validity_timeframe":{"duration":"PT1H","interval":"P2D"},"validity_day_of_week":[1,2,3,4,5],"active":false,"additional_info":"This voucher will remain inactive until enabled.","redemption":{"quantity":10},"metadata":{"test":true,"locale":"de-en"},"validation_rules":["val_4j7DCRm2IS59"]}; // \OpenAPI\Client\Model\VouchersCreateWithSpecificCodeRequestBody | Specify the details of the voucher that you would like to create.

try {
    $result = $apiInstance->createVoucher($code, $vouchers_create_with_specific_code_request_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VouchersApi->createVoucher: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
code	string	A unique code that identifies the voucher.
vouchers_create_with_specific_code_request_body	\OpenAPI\Client\Model\VouchersCreateWithSpecificCodeRequestBody	Specify the details of the voucher that you would like to create.	[optional]

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	\OpenAPI\Client\Model\VouchersTransactionsExportCreateRequestBody	Specify the parameters for the transaction export.	[optional]

Name	Type	Description	Notes
limit	int	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	int	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	string[]		[optional]

Files

VouchersApi.md

Latest commit

History

VouchersApi.md

File metadata and controls

OpenAPI\Client\VouchersApi

createVoucher()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteVoucher()

Example

Parameters

Return type

Authorization

HTTP request headers

disableVoucher()

Example

Parameters

Return type

Authorization

HTTP request headers

enableVoucher()

Example

Parameters

Return type

Authorization

HTTP request headers

exportVoucherTransactions()

Example

Parameters

Return type

Authorization

HTTP request headers

generateRandomCode()

Example

Parameters

Return type

Authorization

HTTP request headers

getVoucher()

Example

Parameters

Return type

Authorization

HTTP request headers

importVouchers()

Example

Parameters

Return type

Authorization

HTTP request headers

importVouchersUsingCsv()

Example

Parameters

Return type

Authorization

HTTP request headers

listVoucherTransactions()

Example

Parameters

Return type

Authorization

HTTP request headers

listVouchers()

Example

Parameters

Return type

Authorization

HTTP request headers

releaseValidationSession()

Example

Parameters

Return type

Authorization

HTTP request headers

updateVoucher()

`createVoucher()`

`deleteVoucher()`

`disableVoucher()`

`enableVoucher()`

`exportVoucherTransactions()`

`generateRandomCode()`

`getVoucher()`

`importVouchers()`

`importVouchersUsingCsv()`

`listVoucherTransactions()`

`listVouchers()`

`releaseValidationSession()`

`updateVoucher()`

`updateVoucherBalance()`

`updateVouchersInBulk()`

`updateVouchersMetadataInBulk()`