OpenAPI\Client\LoyaltiesApi

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

Method	HTTP request	Description
createInBulkLoyaltyTiers()	POST /v1/loyalties/{campaignId}/tiers	Create loyalty tiers
deleteEarningRule()	DELETE /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}	Delete Earning Rule
deleteLoyaltyProgram()	DELETE /v1/loyalties/{campaignId}	Delete Loyalty Campaign
deleteRewardAssignment1()	DELETE /v1/loyalties/{campaignId}/rewards/{assignmentId}	Delete Reward Assignment
disableEarningRule()	POST /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/disable	Disable Earning Rule
enableEarningRule()	POST /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/enable	Enable Earning Rule
exportLoyaltyCardTransactions()	POST /v1/loyalties/members/{memberId}/transactions/export	Export Loyalty Card Transactions
exportLoyaltyCardTransactions1()	POST /v1/loyalties/{campaignId}/members/{memberId}/transactions/export	Export Loyalty Card Transactions
getEarningRule()	GET /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}	Get Earning Rule
getLoyaltyTier()	GET /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}	Get Loyalty Tier
getRewardAssignment1()	GET /v1/loyalties/{campaignId}/reward-assignments/{assignmentId}	Get Reward Assignment
getRewardAssignment2()	GET /v1/loyalties/{campaignId}/rewards/{assignmentId}	Get Reward Assignment
getRewardDetails()	GET /v1/loyalties/{campaignId}/reward-assignments/{assignmentId}/reward	Get Reward Details
listLoyaltyCardTransactions()	GET /v1/loyalties/members/{memberId}/transactions	List Loyalty Card Transactions
listLoyaltyCardTransactions1()	GET /v1/loyalties/{campaignId}/members/{memberId}/transactions	List Loyalty Card Transactions
listLoyaltyTierEarningRules()	GET /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/earning-rules	List Loyalty Tier Earning Rules
listLoyaltyTierRewards()	GET /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/rewards	List Loyalty Tier Rewards
listLoyaltyTiers()	GET /v1/loyalties/{campaignId}/tiers	List Loyalty Tiers
listMemberLoyaltyTier()	GET /v1/loyalties/members/{memberId}/tiers	List Member's Loyalty Tiers
listMemberRewards()	GET /v1/loyalties/members/{memberId}/rewards	List Member Rewards
listPointsExpiration()	GET /v1/loyalties/{campaignId}/members/{memberId}/points-expiration	Get Points Expiration
redeemReward()	POST /v1/loyalties/members/{memberId}/redemption	Redeem Reward
redeemReward1()	POST /v1/loyalties/{campaignId}/members/{memberId}/redemption	Redeem Reward
transferPoints()	POST /v1/loyalties/{campaignId}/members/{memberId}/transfers	Transfer Loyalty Points
updateLoyaltyCardBalance()	POST /v1/loyalties/members/{memberId}/balance	Add or Remove Loyalty Card Balance
updateLoyaltyCardBalance1()	POST /v1/loyalties/{campaignId}/members/{memberId}/balance	Add or Remove Loyalty Card Balance

`createInBulkLoyaltyTiers()`

createInBulkLoyaltyTiers($campaign_id, $loyalties_tiers_create_in_bulk_request_body_item): \OpenAPI\Client\Model\LoyaltyTier[]

Create loyalty tiers

Creates loyalty tiers for desired campaign.

Example

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


// Configure API key authorization: X-App-Id-1
$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-1
$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\LoyaltiesApi(
    // 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
);
$campaign_id = 'campaign_id_example'; // string | Unique loyalty campaign ID or name.
$loyalties_tiers_create_in_bulk_request_body_item = array(new \OpenAPI\Client\Model\LoyaltiesTiersCreateInBulkRequestBodyItem()); // \OpenAPI\Client\Model\LoyaltiesTiersCreateInBulkRequestBodyItem[] | Provide tier definitions you want to add to existing loyalty campaign.

try {
    $result = $apiInstance->createInBulkLoyaltyTiers($campaign_id, $loyalties_tiers_create_in_bulk_request_body_item);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltiesApi->createInBulkLoyaltyTiers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	string	Unique loyalty campaign ID or name.
loyalties_tiers_create_in_bulk_request_body_item	\OpenAPI\Client\Model\LoyaltiesTiersCreateInBulkRequestBodyItem[]	Provide tier definitions you want to add to existing loyalty campaign.	[optional]

Return type

\OpenAPI\Client\Model\LoyaltyTier[]

Authorization

X-App-Id-1, X-App-Token-1

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`deleteEarningRule()`

deleteEarningRule($campaign_id, $earning_rule_id)

Delete Earning Rule

This method deletes an earning rule for a specific loyalty campaign.

Example

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


// Configure API key authorization: X-App-Id-1
$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-1
$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\LoyaltiesApi(
    // 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
);
$campaign_id = 'campaign_id_example'; // string | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the `name` of the campaign as the path parameter value, e.g., `Loyalty%20Campaign`.
$earning_rule_id = 'earning_rule_id_example'; // string | A unique earning rule ID.

try {
    $apiInstance->deleteEarningRule($campaign_id, $earning_rule_id);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltiesApi->deleteEarningRule: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	string	The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the `name` of the campaign as the path parameter value, e.g., `Loyalty%20Campaign`.
earning_rule_id	string	A unique earning rule ID.

Return type

void (empty response body)

Authorization

X-App-Id-1, X-App-Token-1

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`deleteLoyaltyProgram()`

deleteLoyaltyProgram($campaign_id, $force): \OpenAPI\Client\Model\LoyaltiesDeleteResponseBody

Delete Loyalty Campaign

This method permanently deletes a loyalty campaign and all related loyalty cards. This action cannot be undone. Also, it immediately removes any redemptions on loyalty cards.

Example

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


// Configure API key authorization: X-App-Id-1
$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-1
$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\LoyaltiesApi(
    // 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
);
$campaign_id = 'campaign_id_example'; // string | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the `name` of the campaign as the path parameter value, e.g., `Loyalty%20Campaign`.
$force = True; // bool | If this flag is set to `true`, the campaign and related vouchers will be removed permanently. Going forward, the user will be able to create the next campaign with the same name.

try {
    $result = $apiInstance->deleteLoyaltyProgram($campaign_id, $force);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltiesApi->deleteLoyaltyProgram: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	string	The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the `name` of the campaign as the path parameter value, e.g., `Loyalty%20Campaign`.
force	bool	If this flag is set to `true`, the campaign and related vouchers will be removed permanently. Going forward, the user will be able to create the next campaign with the same name.	[optional]

Return type

\OpenAPI\Client\Model\LoyaltiesDeleteResponseBody

Authorization

X-App-Id-1, X-App-Token-1

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`deleteRewardAssignment1()`

deleteRewardAssignment1($campaign_id, $assignment_id)

Delete Reward Assignment

This method deletes a reward assignment for a particular loyalty campaign.

Example

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


// Configure API key authorization: X-App-Id-1
$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-1
$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\LoyaltiesApi(
    // 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
);
$campaign_id = 'campaign_id_example'; // string | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the `name` of the campaign as the path parameter value, e.g., `Loyalty%20Campaign`.
$assignment_id = 'assignment_id_example'; // string | A unique reward assignment ID.

try {
    $apiInstance->deleteRewardAssignment1($campaign_id, $assignment_id);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltiesApi->deleteRewardAssignment1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	string	The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the `name` of the campaign as the path parameter value, e.g., `Loyalty%20Campaign`.
assignment_id	string	A unique reward assignment ID.

Return type

void (empty response body)

Authorization

X-App-Id-1, X-App-Token-1

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`disableEarningRule()`

disableEarningRule($campaign_id, $earning_rule_id): \OpenAPI\Client\Model\LoyaltiesEarningRulesDisableResponseBody

Disable Earning Rule

Disable an earning rule.

Example

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


// Configure API key authorization: X-App-Id-1
$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-1
$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\LoyaltiesApi(
    // 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
);
$campaign_id = 'campaign_id_example'; // string | Unique campaign ID or name.
$earning_rule_id = 'earning_rule_id_example'; // string | Unique earning rule ID.

try {
    $result = $apiInstance->disableEarningRule($campaign_id, $earning_rule_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltiesApi->disableEarningRule: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	string	Unique campaign ID or name.
earning_rule_id	string	Unique earning rule ID.

Return type

\OpenAPI\Client\Model\LoyaltiesEarningRulesDisableResponseBody

Authorization

X-App-Id-1, X-App-Token-1

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`enableEarningRule()`

enableEarningRule($campaign_id, $earning_rule_id): \OpenAPI\Client\Model\LoyaltiesEarningRulesEnableResponseBody

Enable Earning Rule

Enable an earning rule.

Example

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


// Configure API key authorization: X-App-Id-1
$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-1
$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\LoyaltiesApi(
    // 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
);
$campaign_id = 'campaign_id_example'; // string | Unique campaign ID or name.
$earning_rule_id = 'earning_rule_id_example'; // string | Unique earning rule ID.

try {
    $result = $apiInstance->enableEarningRule($campaign_id, $earning_rule_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltiesApi->enableEarningRule: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	string	Unique campaign ID or name.
earning_rule_id	string	Unique earning rule ID.

Return type

\OpenAPI\Client\Model\LoyaltiesEarningRulesEnableResponseBody

Authorization

X-App-Id-1, X-App-Token-1

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`exportLoyaltyCardTransactions()`

exportLoyaltyCardTransactions($member_id, $loyalties_members_transactions_export_create_request_body): \OpenAPI\Client\Model\LoyaltiesMembersTransactionsExportCreateResponseBody

Export Loyalty Card Transactions

Export transactions that are associated with point movements on a loyalty card. | Field | Definition | Example Export | |:---|:---|:---| | id | Unique transaction ID assigned by Voucherify. | vtx_0cb7811f1c07765800 | | type | Transaction type. | - POINTS_EXPIRATION
- POINTS_ADDITION
- POINTS_REMOVAL
- POINTS_TRANSFER_OUT
- POINTS_ACCRUAL
- POINTS_REFUND
- POINTS_REDEMPTION | | source_id | Custom source ID of the transaction if one was included originally. | source_id_custom | | reason | Contains the reason for the transaction if one was included originally. | | | balance | The loyalty card balance after the transaction. | | | amount | The amount of loyalty points being allocated during the transaction. This value can either be negative or positive depending on the nature of the transaction. | | | created_at | Timestamp in ISO 8601 format representing the date and time when the transaction was created. | 2022-03-09T09:16:32.521Z | | voucher_id | Unique Voucher ID. | v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp | | campaign_id | Parent campaign ID. | camp_FNYR4jhqZBM9xTptxDGgeNBV | | source| Channel through which the transaction was initiated. | - API
- voucherify-web-ui
- Automation | | details | More detailed information stored in the form of a JSON. | Provides more details related to the transaction in the form of an object. | | related_transaction_id | Unique transaction ID related to a receiver/donor card in the case of a points transfer from/to another card. | vtx_0c9afe802593b34b80 |

Example

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


// Configure API key authorization: X-App-Id-1
$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-1
$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\LoyaltiesApi(
    // 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
);
$member_id = 'member_id_example'; // string | A unique code identifying the loyalty card that you are looking to export transaction data for.
$loyalties_members_transactions_export_create_request_body = {"parameters":{"order":"-created_at","fields":["id","type","source_id","reason","balance","amount","created_at","voucher_id","campaign_id","details","related_transaction_id"]}}; // \OpenAPI\Client\Model\LoyaltiesMembersTransactionsExportCreateRequestBody | Specify the parameters and filters for the transaction export.

try {
    $result = $apiInstance->exportLoyaltyCardTransactions($member_id, $loyalties_members_transactions_export_create_request_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltiesApi->exportLoyaltyCardTransactions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
member_id	string	A unique code identifying the loyalty card that you are looking to export transaction data for.
loyalties_members_transactions_export_create_request_body	\OpenAPI\Client\Model\LoyaltiesMembersTransactionsExportCreateRequestBody	Specify the parameters and filters for the transaction export.	[optional]

Return type

\OpenAPI\Client\Model\LoyaltiesMembersTransactionsExportCreateResponseBody

Authorization

X-App-Id-1, X-App-Token-1

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`exportLoyaltyCardTransactions1()`

exportLoyaltyCardTransactions1($campaign_id, $member_id, $loyalties_members_transactions_export_create_request_body): \OpenAPI\Client\Model\LoyaltiesMembersTransactionsExportCreateResponseBody

Export Loyalty Card Transactions

Export transactions that are associated with point movements on a loyalty card. | Field | Definition | Example Export | |:---|:---|:---| | id | Unique transaction ID assigned by Voucherify. | vtx_0cb7811f1c07765800 | | type | Transaction type. | - POINTS_EXPIRATION
- POINTS_ADDITION
- POINTS_REMOVAL
- POINTS_TRANSFER_OUT
- POINTS_ACCRUAL
- POINTS_REFUND
- POINTS_REDEMPTION | | source_id | Custom source ID of the transaction if one was included originally. | source_id_custom | | reason | Contains the reason for the transaction if one was included originally. | | | balance | The loyalty card balance after the transaction. | | | amount | The amount of loyalty points being allocated during the transaction. This value can either be negative or positive depending on the nature of the transaction. | | | created_at | Timestamp in ISO 8601 format representing the date and time when the transaction was created. | 2022-03-09T09:16:32.521Z | | voucher_id | Unique Voucher ID. | v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp | | campaign_id | Parent campaign ID. | camp_FNYR4jhqZBM9xTptxDGgeNBV | | source| Channel through which the transaction was initiated. | - API
- voucherify-web-ui
- Automation | | details | More detailed information stored in the form of a JSON. | Provides more details related to the transaction in the form of an object. | | related_transaction_id | Unique transaction ID related to a receiver/donor card in the case of a points transfer from/to another card. | vtx_0c9afe802593b34b80 |

Example

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


// Configure API key authorization: X-App-Id-1
$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-1
$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\LoyaltiesApi(
    // 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
);
$campaign_id = 'campaign_id_example'; // string | A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export.
$member_id = 'member_id_example'; // string | A unique code identifying the loyalty card that you are looking to export transaction data for.
$loyalties_members_transactions_export_create_request_body = {"parameters":{"order":"-created_at","fields":["id","type","source_id","reason","balance","amount","created_at","voucher_id","campaign_id","details","related_transaction_id"]}}; // \OpenAPI\Client\Model\LoyaltiesMembersTransactionsExportCreateRequestBody | Specify the parameters and filters for the transaction export.

try {
    $result = $apiInstance->exportLoyaltyCardTransactions1($campaign_id, $member_id, $loyalties_members_transactions_export_create_request_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltiesApi->exportLoyaltyCardTransactions1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	string	A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export.
member_id	string	A unique code identifying the loyalty card that you are looking to export transaction data for.
loyalties_members_transactions_export_create_request_body	\OpenAPI\Client\Model\LoyaltiesMembersTransactionsExportCreateRequestBody	Specify the parameters and filters for the transaction export.	[optional]

Return type

\OpenAPI\Client\Model\LoyaltiesMembersTransactionsExportCreateResponseBody

Authorization

X-App-Id-1, X-App-Token-1

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getEarningRule()`

getEarningRule($campaign_id, $earning_rule_id): \OpenAPI\Client\Model\LoyaltiesEarningRulesGetResponseBody

Get Earning Rule

Retrieves an earning rule assigned to a campaign.

Example

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


// Configure API key authorization: X-App-Id-1
$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-1
$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\LoyaltiesApi(
    // 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
);
$campaign_id = 'campaign_id_example'; // string | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the `name` of the campaign as the path parameter value, e.g., `Loyalty%20Campaign`.
$earning_rule_id = 'earning_rule_id_example'; // string | A unique earning rule ID.

try {
    $result = $apiInstance->getEarningRule($campaign_id, $earning_rule_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltiesApi->getEarningRule: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	string	The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the `name` of the campaign as the path parameter value, e.g., `Loyalty%20Campaign`.
earning_rule_id	string	A unique earning rule ID.

Return type

\OpenAPI\Client\Model\LoyaltiesEarningRulesGetResponseBody

Authorization

X-App-Id-1, X-App-Token-1

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getLoyaltyTier()`

getLoyaltyTier($campaign_id, $loyalty_tier_id): \OpenAPI\Client\Model\LoyaltiesTiersGetResponseBody

Get Loyalty Tier

Retrieve a loyalty tier from a loyalty campaign by the loyalty tier ID.

Example

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


// Configure API key authorization: X-App-Id-1
$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-1
$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\LoyaltiesApi(
    // 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
);
$campaign_id = 'campaign_id_example'; // string | Unique loyalty campaign ID or name.
$loyalty_tier_id = 'loyalty_tier_id_example'; // string | Unique loyalty tier ID.

try {
    $result = $apiInstance->getLoyaltyTier($campaign_id, $loyalty_tier_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltiesApi->getLoyaltyTier: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	string	Unique loyalty campaign ID or name.
loyalty_tier_id	string	Unique loyalty tier ID.

Return type

\OpenAPI\Client\Model\LoyaltiesTiersGetResponseBody

Authorization

X-App-Id-1, X-App-Token-1

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getRewardAssignment1()`

getRewardAssignment1($campaign_id, $assignment_id): \OpenAPI\Client\Model\LoyaltiesRewardAssignmentsGetResponseBody

Get Reward Assignment

Retrieve specific reward assignment.

Example

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


// Configure API key authorization: X-App-Id-1
$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-1
$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\LoyaltiesApi(
    // 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
);
$campaign_id = 'campaign_id_example'; // string | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the `name` of the campaign as the path parameter value, e.g., `Loyalty%20Campaign`.
$assignment_id = 'assignment_id_example'; // string | Unique reward assignment ID.

try {
    $result = $apiInstance->getRewardAssignment1($campaign_id, $assignment_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltiesApi->getRewardAssignment1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	string	The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the `name` of the campaign as the path parameter value, e.g., `Loyalty%20Campaign`.
assignment_id	string	Unique reward assignment ID.

Return type

\OpenAPI\Client\Model\LoyaltiesRewardAssignmentsGetResponseBody

Authorization

X-App-Id-1, X-App-Token-1

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getRewardAssignment2()`

getRewardAssignment2($campaign_id, $assignment_id): \OpenAPI\Client\Model\LoyaltiesRewardsGetResponseBody

Get Reward Assignment

Retrieve specific reward assignment. > 📘 Alternative endpoint > > This endpoint is an alternative to this endpoint.

Example

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


// Configure API key authorization: X-App-Id-1
$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-1
$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\LoyaltiesApi(
    // 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
);
$campaign_id = 'campaign_id_example'; // string | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the `name` of the campaign as the path parameter value, e.g., `Loyalty%20Campaign`.
$assignment_id = 'assignment_id_example'; // string | A unique reward assignment ID.

try {
    $result = $apiInstance->getRewardAssignment2($campaign_id, $assignment_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltiesApi->getRewardAssignment2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	string	The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the `name` of the campaign as the path parameter value, e.g., `Loyalty%20Campaign`.
assignment_id	string	A unique reward assignment ID.

Return type

\OpenAPI\Client\Model\LoyaltiesRewardsGetResponseBody

Authorization

X-App-Id-1, X-App-Token-1

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getRewardDetails()`

getRewardDetails($campaign_id, $assignment_id): \OpenAPI\Client\Model\LoyaltiesRewardAssignmentsRewardGetResponseBody

Get Reward Details

Get reward details in the context of a loyalty campaign and reward assignment ID.

Example

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


// Configure API key authorization: X-App-Id-1
$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-1
$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\LoyaltiesApi(
    // 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
);
$campaign_id = 'campaign_id_example'; // string | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the `name` of the campaign as the path parameter value, e.g., `Loyalty%20Campaign`.
$assignment_id = 'assignment_id_example'; // string | Unique reward assignment ID.

try {
    $result = $apiInstance->getRewardDetails($campaign_id, $assignment_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltiesApi->getRewardDetails: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	string	The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the `name` of the campaign as the path parameter value, e.g., `Loyalty%20Campaign`.
assignment_id	string	Unique reward assignment ID.

Return type

\OpenAPI\Client\Model\LoyaltiesRewardAssignmentsRewardGetResponseBody

Authorization

X-App-Id-1, X-App-Token-1

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listLoyaltyCardTransactions()`

listLoyaltyCardTransactions($member_id, $limit, $page): \OpenAPI\Client\Model\LoyaltiesMembersTransactionsListResponseBody

List Loyalty Card Transactions

Retrieve transaction data related to point movements for a specific loyalty card.

Example

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


// Configure API key authorization: X-App-Id-1
$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-1
$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\LoyaltiesApi(
    // 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
);
$member_id = 'member_id_example'; // string | A unique code identifying the loyalty card that you are looking to retrieve transaction data for.
$limit = 56; // int | A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
$page = 56; // int | Which page of results to return.

try {
    $result = $apiInstance->listLoyaltyCardTransactions($member_id, $limit, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltiesApi->listLoyaltyCardTransactions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
member_id	string	A unique code identifying the loyalty card that you are looking to retrieve transaction data for.
limit	int	A limit on the number of objects to be returned. Limit can range between 1 and 100 items.	[optional]
page	int	Which page of results to return.	[optional]

Return type

\OpenAPI\Client\Model\LoyaltiesMembersTransactionsListResponseBody

Authorization

X-App-Id-1, X-App-Token-1

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listLoyaltyCardTransactions1()`

listLoyaltyCardTransactions1($campaign_id, $member_id, $limit, $page): \OpenAPI\Client\Model\LoyaltiesMembersTransactionsListResponseBody

List Loyalty Card Transactions

Retrieve transaction data related to point movements for a specific loyalty card.

Example

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


// Configure API key authorization: X-App-Id-1
$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-1
$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\LoyaltiesApi(
    // 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
);
$campaign_id = 'campaign_id_example'; // string | A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to return.
$member_id = 'member_id_example'; // string | A unique code identifying the loyalty card that you are looking to retrieve transaction data for.
$limit = 56; // int | A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
$page = 56; // int | Which page of results to return.

try {
    $result = $apiInstance->listLoyaltyCardTransactions1($campaign_id, $member_id, $limit, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltiesApi->listLoyaltyCardTransactions1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	string	A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to return.
member_id	string	A unique code identifying the loyalty card that you are looking to retrieve transaction data for.
limit	int	A limit on the number of objects to be returned. Limit can range between 1 and 100 items.	[optional]
page	int	Which page of results to return.	[optional]

Return type

\OpenAPI\Client\Model\LoyaltiesMembersTransactionsListResponseBody

Authorization

X-App-Id-1, X-App-Token-1

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listLoyaltyTierEarningRules()`

listLoyaltyTierEarningRules($campaign_id, $loyalty_tier_id, $limit, $page): \OpenAPI\Client\Model\LoyaltiesTiersEarningRulesListResponseBody

List Loyalty Tier Earning Rules

Retrieve available earning rules for a given tier and the calculation method for earning points.

Example

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


// Configure API key authorization: X-App-Id-1
$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-1
$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\LoyaltiesApi(
    // 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
);
$campaign_id = 'campaign_id_example'; // string | Unique campaign ID or name.
$loyalty_tier_id = 'loyalty_tier_id_example'; // string | Unique loyalty tier ID.
$limit = 56; // int | A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
$page = 56; // int | Which page of results to return.

try {
    $result = $apiInstance->listLoyaltyTierEarningRules($campaign_id, $loyalty_tier_id, $limit, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltiesApi->listLoyaltyTierEarningRules: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	string	Unique campaign ID or name.
loyalty_tier_id	string	Unique loyalty tier ID.
limit	int	A limit on the number of objects to be returned. Limit can range between 1 and 100 items.	[optional]
page	int	Which page of results to return.	[optional]

Return type

\OpenAPI\Client\Model\LoyaltiesTiersEarningRulesListResponseBody

Authorization

X-App-Id-1, X-App-Token-1

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listLoyaltyTierRewards()`

listLoyaltyTierRewards($campaign_id, $loyalty_tier_id): \OpenAPI\Client\Model\LoyaltiesTiersRewardsListResponseBody

List Loyalty Tier Rewards

Get available rewards for a given tier.

Example

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


// Configure API key authorization: X-App-Id-1
$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-1
$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\LoyaltiesApi(
    // 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
);
$campaign_id = 'campaign_id_example'; // string | Unique campaign ID or name.
$loyalty_tier_id = 'loyalty_tier_id_example'; // string | Unique loyalty tier ID.

try {
    $result = $apiInstance->listLoyaltyTierRewards($campaign_id, $loyalty_tier_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltiesApi->listLoyaltyTierRewards: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	string	Unique campaign ID or name.
loyalty_tier_id	string	Unique loyalty tier ID.

Return type

\OpenAPI\Client\Model\LoyaltiesTiersRewardsListResponseBody

Authorization

X-App-Id-1, X-App-Token-1

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listLoyaltyTiers()`

listLoyaltyTiers($campaign_id, $limit, $order): \OpenAPI\Client\Model\LoyaltiesTiersListResponseBody

List Loyalty Tiers

Retrieve a list of loyalty tiers which were added to the loyalty program.

Example

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


// Configure API key authorization: X-App-Id-1
$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-1
$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\LoyaltiesApi(
    // 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
);
$campaign_id = 'campaign_id_example'; // string | Unique loyalty campaign ID or name.
$limit = 56; // int | A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
$order = new \OpenAPI\Client\Model\ParameterOrderListLoyaltyTiers(); // ParameterOrderListLoyaltyTiers | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.

try {
    $result = $apiInstance->listLoyaltyTiers($campaign_id, $limit, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltiesApi->listLoyaltyTiers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	string	Unique loyalty campaign ID or name.
limit	int	A limit on the number of objects to be returned. Limit can range between 1 and 100 items.	[optional]
order	ParameterOrderListLoyaltyTiers	Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.	[optional]

Return type

\OpenAPI\Client\Model\LoyaltiesTiersListResponseBody

Authorization

X-App-Id-1, X-App-Token-1

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listMemberLoyaltyTier()`

listMemberLoyaltyTier($member_id): \OpenAPI\Client\Model\LoyaltiesMembersTiersListResponseBody

List Member's Loyalty Tiers

Retrieve member tiers using the loyalty card ID.

Example

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


// Configure API key authorization: X-App-Id-1
$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-1
$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\LoyaltiesApi(
    // 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
);
$member_id = 'member_id_example'; // string | Unique loyalty card assigned to a particular customer.

try {
    $result = $apiInstance->listMemberLoyaltyTier($member_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltiesApi->listMemberLoyaltyTier: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
member_id	string	Unique loyalty card assigned to a particular customer.

Return type

\OpenAPI\Client\Model\LoyaltiesMembersTiersListResponseBody

Authorization

X-App-Id-1, X-App-Token-1

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listMemberRewards()`

listMemberRewards($member_id, $affordable_only): \OpenAPI\Client\Model\LoyaltiesMembersRewardsListResponseBody

List Member Rewards

Retrieves the list of rewards that the given customer (identified by member_id, which is a loyalty card assigned to a particular customer) can get in exchange for loyalty points. You can use the affordable_only parameter to limit the results to rewards that the customer can actually afford (only rewards whose price in points is not higher than the loyalty points balance on a loyalty card). Please note that rewards that are disabled (i.e. set to Not Available in the Dashboard) for a given loyalty tier reward mapping will not be returned in this endpoint.

Example

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


// Configure API key authorization: X-App-Id-1
$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-1
$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\LoyaltiesApi(
    // 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
);
$member_id = 'member_id_example'; // string | Unique loyalty card assigned to a particular customer.
$affordable_only = True; // bool | Limit the results to rewards that the customer can actually afford (only rewards whose price in points is not higher than the loyalty points balance on a loyalty card). Set this flag to `true` to return rewards which the customer can actually afford.

try {
    $result = $apiInstance->listMemberRewards($member_id, $affordable_only);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltiesApi->listMemberRewards: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
member_id	string	Unique loyalty card assigned to a particular customer.
affordable_only	bool	Limit the results to rewards that the customer can actually afford (only rewards whose price in points is not higher than the loyalty points balance on a loyalty card). Set this flag to `true` to return rewards which the customer can actually afford.	[optional]

Return type

\OpenAPI\Client\Model\LoyaltiesMembersRewardsListResponseBody

Authorization

X-App-Id-1, X-App-Token-1

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listPointsExpiration()`

listPointsExpiration($campaign_id, $member_id, $limit, $page): \OpenAPI\Client\Model\LoyaltiesMembersPointsExpirationListResponseBody

Get Points Expiration

Retrieve loyalty point expiration buckets for a given loyalty card. Expired point buckets are not returned in this endpoint. You can use the Exports API to retrieve a list of both ACTIVE and EXPIRED point buckets.

Example

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


// Configure API key authorization: X-App-Id-1
$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-1
$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\LoyaltiesApi(
    // 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
);
$campaign_id = 'campaign_id_example'; // string | The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the `name` of the campaign as the path parameter value, e.g., `Loyalty%20Campaign`.
$member_id = 'member_id_example'; // string | Loyalty card code.
$limit = 56; // int | A limit on the number of objects to be returned. Limit can range between 1 and 100 items.
$page = 56; // int | Which page of results to return.

try {
    $result = $apiInstance->listPointsExpiration($campaign_id, $member_id, $limit, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltiesApi->listPointsExpiration: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	string	The campaign ID or name of the loyalty campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the `name` of the campaign as the path parameter value, e.g., `Loyalty%20Campaign`.
member_id	string	Loyalty card code.
limit	int	A limit on the number of objects to be returned. Limit can range between 1 and 100 items.	[optional]
page	int	Which page of results to return.	[optional]

Return type

\OpenAPI\Client\Model\LoyaltiesMembersPointsExpirationListResponseBody

Authorization

X-App-Id-1, X-App-Token-1

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`redeemReward()`

redeemReward($member_id, $loyalties_members_redemption_redeem_request_body): \OpenAPI\Client\Model\LoyaltiesMembersRedemptionRedeemResponseBody

Redeem Reward

> 📘 Alternative endpoint > > This endpoint is an alternative to this [endpoint](ref:redeem-reward-1). The URL was re-designed to allow you to redeem a reward without having to provide the `campaignId` as a path parameter.

Example

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


// Configure API key authorization: X-App-Id-1
$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-1
$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\LoyaltiesApi(
    // 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
);
$member_id = 'member_id_example'; // string | Unique loyalty card assigned to a particular customer.
$loyalties_members_redemption_redeem_request_body = {"reward":{"id":"rew_INt3fGH3n7xIr3ZQcq4kkUZ1","points":100},"order":{"items":[{"product_id":"prod_0c5d6689b39320059b","quantity":"1"},{"product_id":"prod_0b2c36568000039138","quantity":"2"}]}}; // \OpenAPI\Client\Model\LoyaltiesMembersRedemptionRedeemRequestBody | Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order.

try {
    $result = $apiInstance->redeemReward($member_id, $loyalties_members_redemption_redeem_request_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltiesApi->redeemReward: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
member_id	string	Unique loyalty card assigned to a particular customer.
loyalties_members_redemption_redeem_request_body	\OpenAPI\Client\Model\LoyaltiesMembersRedemptionRedeemRequestBody	Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order.	[optional]

Return type

\OpenAPI\Client\Model\LoyaltiesMembersRedemptionRedeemResponseBody

Authorization

X-App-Id-1, X-App-Token-1

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`redeemReward1()`

redeemReward1($campaign_id, $member_id, $loyalties_members_redemption_redeem_request_body): \OpenAPI\Client\Model\LoyaltiesMembersRedemptionRedeemResponseBody

Redeem Reward

Exchange points from a loyalty card for a specified reward. This API method returns an assigned award in the response. It means that if a requesting customer gets a coupon code with a discount for the next order, that discount code will be visible in response as part of the reward object definition.

Example

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


// Configure API key authorization: X-App-Id-1
$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-1
$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\LoyaltiesApi(
    // 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
);
$campaign_id = 'campaign_id_example'; // string | Unique campaign ID.
$member_id = 'member_id_example'; // string | A code that identifies the loyalty card.
$loyalties_members_redemption_redeem_request_body = {"reward":{"id":"rew_INt3fGH3n7xIr3ZQcq4kkUZ1","points":100},"order":{"items":[{"product_id":"prod_0c5d6689b39320059b","quantity":"1"},{"product_id":"prod_0b2c36568000039138","quantity":"2"}]}}; // \OpenAPI\Client\Model\LoyaltiesMembersRedemptionRedeemRequestBody | Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order.

try {
    $result = $apiInstance->redeemReward1($campaign_id, $member_id, $loyalties_members_redemption_redeem_request_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltiesApi->redeemReward1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	string	Unique campaign ID.
member_id	string	A code that identifies the loyalty card.
loyalties_members_redemption_redeem_request_body	\OpenAPI\Client\Model\LoyaltiesMembersRedemptionRedeemRequestBody	Specify the reward to be redeemed. In case of a pay with points reward, specify the order and the number of points to be applied to the order. Please note that if you do not specify the amount of points, the application will default to applying the number of points to pay for the remainder of the order. If the limit of available points on the card is reached, then only the available points on the card will be applied to the order.	[optional]

Return type

\OpenAPI\Client\Model\LoyaltiesMembersRedemptionRedeemResponseBody

Authorization

X-App-Id-1, X-App-Token-1

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`transferPoints()`

transferPoints($campaign_id, $member_id, $loyalties_transfer_points): \OpenAPI\Client\Model\LoyaltiesMembersTransfersCreateResponseBody

Transfer Loyalty Points

Transfer points between different loyalty cards. You need to provide the campaign ID and the loyalty card ID you want the points to be transferred to as path parameters in the URL. In the request body, you provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card.

Example

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


// Configure API key authorization: X-App-Id-1
$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-1
$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\LoyaltiesApi(
    // 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
);
$campaign_id = 'campaign_id_example'; // string | A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination).
$member_id = 'member_id_example'; // string | A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination).
$loyalties_transfer_points = [{"code":"0PmQ7JQI","points":1},{"code":"kCeufB8i","points":1}]; // \OpenAPI\Client\Model\LoyaltiesTransferPoints[] | Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card.

try {
    $result = $apiInstance->transferPoints($campaign_id, $member_id, $loyalties_transfer_points);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltiesApi->transferPoints: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	string	A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination).
member_id	string	A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination).
loyalties_transfer_points	\OpenAPI\Client\Model\LoyaltiesTransferPoints[]	Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card.	[optional]

Return type

\OpenAPI\Client\Model\LoyaltiesMembersTransfersCreateResponseBody

Authorization

X-App-Id-1, X-App-Token-1

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updateLoyaltyCardBalance()`

updateLoyaltyCardBalance($member_id, $loyalties_members_balance_update_request_body): \OpenAPI\Client\Model\LoyaltiesMembersBalanceUpdateResponseBody

Add or Remove Loyalty Card Balance

This method gives adds or removes balance to an existing loyalty card. The removal of points will consume the points that expire the soonest. > 📘 Alternative endpoint > This endpoint is an alternative to this endpoint. The URL was re-designed to allow you to add or remove loyalty card balance without having to provide the campaignId as a path parameter.

Example

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


// Configure API key authorization: X-App-Id-1
$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-1
$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\LoyaltiesApi(
    // 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
);
$member_id = 'member_id_example'; // string | Unique loyalty card assigned to a particular customer.
$loyalties_members_balance_update_request_body = {"points":-100}; // \OpenAPI\Client\Model\LoyaltiesMembersBalanceUpdateRequestBody | Specify the point adjustment along with the expiration mechanism.

try {
    $result = $apiInstance->updateLoyaltyCardBalance($member_id, $loyalties_members_balance_update_request_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltiesApi->updateLoyaltyCardBalance: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
member_id	string	Unique loyalty card assigned to a particular customer.
loyalties_members_balance_update_request_body	\OpenAPI\Client\Model\LoyaltiesMembersBalanceUpdateRequestBody	Specify the point adjustment along with the expiration mechanism.	[optional]

Return type

\OpenAPI\Client\Model\LoyaltiesMembersBalanceUpdateResponseBody

Authorization

X-App-Id-1, X-App-Token-1

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updateLoyaltyCardBalance1()`

updateLoyaltyCardBalance1($campaign_id, $member_id, $loyalties_members_balance_update_request_body): \OpenAPI\Client\Model\LoyaltiesMembersBalanceUpdateResponseBody

Add or Remove Loyalty Card Balance

This method adds or removes balance to an existing loyalty card. The removal of points will consume the points that expire the soonest.

Example

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


// Configure API key authorization: X-App-Id-1
$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-1
$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\LoyaltiesApi(
    // 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
);
$campaign_id = 'campaign_id_example'; // string | Unique campaign ID.
$member_id = 'member_id_example'; // string | A code that identifies the loyalty card.
$loyalties_members_balance_update_request_body = {"points":100,"expiration_type":"CUSTOM_DATE","expiration_date":"2023-05-30"}; // \OpenAPI\Client\Model\LoyaltiesMembersBalanceUpdateRequestBody | Specify the point adjustment along with the expiration mechanism.

try {
    $result = $apiInstance->updateLoyaltyCardBalance1($campaign_id, $member_id, $loyalties_members_balance_update_request_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltiesApi->updateLoyaltyCardBalance1: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	string	Unique campaign ID.
member_id	string	A code that identifies the loyalty card.
loyalties_members_balance_update_request_body	\OpenAPI\Client\Model\LoyaltiesMembersBalanceUpdateRequestBody	Specify the point adjustment along with the expiration mechanism.	[optional]

Return type

\OpenAPI\Client\Model\LoyaltiesMembersBalanceUpdateResponseBody

Authorization

X-App-Id-1, X-App-Token-1

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

LoyaltiesApi.md

Latest commit

History

LoyaltiesApi.md

File metadata and controls

OpenAPI\Client\LoyaltiesApi

createInBulkLoyaltyTiers()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteEarningRule()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteLoyaltyProgram()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteRewardAssignment1()

Example

Parameters

Return type

Authorization

HTTP request headers

disableEarningRule()

Example

Parameters

Return type

Authorization

HTTP request headers

enableEarningRule()

Example

Parameters

Return type

Authorization

HTTP request headers

exportLoyaltyCardTransactions()

Example

Parameters

Return type

Authorization

HTTP request headers

exportLoyaltyCardTransactions1()

Example

Parameters

Return type

Authorization

HTTP request headers

getEarningRule()

Example

Parameters

Return type

Authorization

HTTP request headers

getLoyaltyTier()

Example

Parameters

Return type

Authorization

HTTP request headers

getRewardAssignment1()

Example

Parameters

Return type

Authorization

HTTP request headers

getRewardAssignment2()

Example

Parameters

Return type

Authorization

HTTP request headers

getRewardDetails()

`createInBulkLoyaltyTiers()`

`deleteEarningRule()`

`deleteLoyaltyProgram()`

`deleteRewardAssignment1()`

`disableEarningRule()`

`enableEarningRule()`

`exportLoyaltyCardTransactions()`

`exportLoyaltyCardTransactions1()`

`getEarningRule()`

`getLoyaltyTier()`

`getRewardAssignment1()`

`getRewardAssignment2()`

`getRewardDetails()`

`listLoyaltyCardTransactions()`

`listLoyaltyCardTransactions1()`

`listLoyaltyTierEarningRules()`

`listLoyaltyTierRewards()`

`listLoyaltyTiers()`

`listMemberLoyaltyTier()`

`listMemberRewards()`

`listPointsExpiration()`

`redeemReward()`

`redeemReward1()`