OpenAPI\Client\LoyaltiesApi

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

Method	HTTP request	Description
addMember()	POST /v1/loyalties/{campaignId}/members	Add Member
createEarningRule()	POST /v1/loyalties/{campaignId}/earning-rules	Create Earning Rule
createInBulkLoyaltyTiers()	POST /v1/loyalties/{campaignId}/tiers	Create loyalty tiers
createLoyaltyProgram()	POST /v1/loyalties	Create Loyalty Campaign
createPointsExpirationExport()	POST /v1/loyalties/{campaignId}/points-expiration/export	Create Points Expiration Export
createRewardAssignment1()	POST /v1/loyalties/{campaignId}/rewards	Create Reward Assignment
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
getLoyaltyProgram()	GET /v1/loyalties/{campaignId}	Get Loyalty Campaign
getLoyaltyTier()	GET /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}	Get Loyalty Tier
getMember()	GET /v1/loyalties/members/{memberId}	Get Member
getMember1()	GET /v1/loyalties/{campaignId}/members/{memberId}	Get Member
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
listEarningRules()	GET /v1/loyalties/{campaignId}/earning-rules	List Earning Rules
listLoyaltyCardTransactions()	GET /v1/loyalties/members/{memberId}/transactions	List Loyalty Card Transactions
listLoyaltyCardTransactions1()	GET /v1/loyalties/{campaignId}/members/{memberId}/transactions	List Loyalty Card Transactions
listLoyaltyPrograms()	GET /v1/loyalties	List Loyalty Campaigns
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
listMemberActivity()	GET /v1/loyalties/members/{memberId}/activity	List Member Activity
listMemberActivity1()	GET /v1/loyalties/{campaignId}/members/{memberId}/activity	List Member Activity
listMemberLoyaltyTier()	GET /v1/loyalties/members/{memberId}/tiers	List Member's Loyalty Tiers
listMemberRewards()	GET /v1/loyalties/members/{memberId}/rewards	List Member Rewards
listMembers()	GET /v1/loyalties/{campaignId}/members	List Members
listPointsExpiration()	GET /v1/loyalties/{campaignId}/members/{memberId}/points-expiration	Get Points Expiration
listRewardAssignments1()	GET /v1/loyalties/{campaignId}/reward-assignments	List Reward Assignments
listRewardAssignments2()	GET /v1/loyalties/{campaignId}/rewards	List Reward Assignments
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
updateEarningRule()	PUT /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}	Update Earning Rule
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
updateLoyaltyProgram()	PUT /v1/loyalties/{campaignId}	Update Loyalty Campaign
updateRewardAssignment1()	PUT /v1/loyalties/{campaignId}/rewards/{assignmentId}	Update Reward Assignment

`addMember()`

addMember($campaignId, $loyaltiesMembersCreateRequestBody): \OpenAPI\Client\Model\LoyaltiesMembersCreateResponseBody

Add Member

This method assigns a loyalty card to a customer. It selects a loyalty card suitable for publication, adds a publish entry, and returns the published voucher. A voucher is suitable for publication when its active and hasnt been published yet. 📘 Auto-update campaign In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use auto-update campaign.

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\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
);
$campaignId = 'campaignId_example'; // string | Unique campaign ID of the loyalty program.
$loyaltiesMembersCreateRequestBody = {"customer":"source_customer_1","metadata":{"year":2022},"channel":"postman","voucher":"KpzbHUY5"}; // \OpenAPI\Client\Model\LoyaltiesMembersCreateRequestBody | Provide details to whom the loyalty card should be assigned.     You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer.   You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the List Publications endpoint.

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

Parameters

Name	Type	Description	Notes
campaignId	string	Unique campaign ID of the loyalty program.
loyaltiesMembersCreateRequestBody	\OpenAPI\Client\Model\LoyaltiesMembersCreateRequestBody	Provide details to whom the loyalty card should be assigned. You can choose to either specify the exact loyalty card code that you want to publish from existin (non-assigned) codes, or choose not to specify a voucher code. If you choose not to specify a code in the request paylaod, then the system will choose the next available voucher code available to be assigned to a customer. You can also include metadata in the request payload. This metadata will be assigned to the publication object, but will not be returned in the response to this endpoint. To see of publications (assignments of particular codes to customers) and publication metadata, use the List Publications endpoint.	[optional]

Return type

\OpenAPI\Client\Model\LoyaltiesMembersCreateResponseBody

Name	Type	Description	Notes
campaignId	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.
loyaltiesEarningRulesCreateRequestBodyItem	\OpenAPI\Client\Model\LoyaltiesEarningRulesCreateRequestBodyItem[]	Customize the request body based on the type of earning rules you would like to create. The request body is an array of objects. The required minimum properties to include in the payload for each object are event and loyalty. Additionally, if you choose to add a validity_timeframe, you must include a start_date. Furthermore, an earning rule event type: - customer.segment.entered requires a segment object - a custom event requires a custom_event object - a customer.loyalty.tier.joined, customer.loyalty.tier.left, customer.loyalty.tier.upgraded, customer.loyalty.tier.downgraded, customer.loyalty.tier.prolonged requires a loyalty_tier object	[optional]

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

Name	Type	Description	Notes
campaignId	string	Unique campaign ID or name.
loyaltiesPointsExpirationExportCreateRequestBody	\OpenAPI\Client\Model\LoyaltiesPointsExpirationExportCreateRequestBody	Specify the data filters, types of data to return and order in which the results should be returned.	[optional]

Name	Type	Description	Notes
campaignId	string	Unique 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.
loyaltiesRewardsCreateAssignmentItemRequestBody	\OpenAPI\Client\Model\LoyaltiesRewardsCreateAssignmentItemRequestBody[]	Define the cost of the rewards in loyalty points.	[optional]

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

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

Name	Type	Description	Notes
campaignId	string	Unique campaign ID.
memberId	string	Unique code that identifies the loyalty card.

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]
order	ParameterOrderListCampaigns	Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.	[optional]

Name	Type	Description	Notes
memberId	string	Unique loyalty card assigned to a particular customer.
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]
order	ParameterOrderCreatedAt	Apply this filter to order the events according the date and time when it was created. The dash - preceding a sorting option means sorting in a descending order.	[optional]
startingAfterId	string	A cursor for pagination. It retrieves the events starting after an event with the given ID.	[optional]

Files

LoyaltiesApi.md

Latest commit

History

LoyaltiesApi.md

File metadata and controls

OpenAPI\Client\LoyaltiesApi

addMember()

Example

Parameters

Return type

Authorization

HTTP request headers

createEarningRule()

Example

Parameters

Return type

Authorization

HTTP request headers

createInBulkLoyaltyTiers()

Example

Parameters

Return type

Authorization

HTTP request headers

createLoyaltyProgram()

Example

Parameters

Return type

Authorization

HTTP request headers

createPointsExpirationExport()

Example

Parameters

Return type

Authorization

HTTP request headers

createRewardAssignment1()

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()

`addMember()`

`createEarningRule()`

`createInBulkLoyaltyTiers()`

`createLoyaltyProgram()`

`createPointsExpirationExport()`

`createRewardAssignment1()`

`deleteEarningRule()`

`deleteLoyaltyProgram()`

`deleteRewardAssignment1()`

`disableEarningRule()`

`enableEarningRule()`

`exportLoyaltyCardTransactions()`

`exportLoyaltyCardTransactions1()`

`getEarningRule()`

`getLoyaltyProgram()`

`getLoyaltyTier()`

`getMember()`

`getMember1()`

`getRewardAssignment1()`

`getRewardAssignment2()`

`getRewardDetails()`

`listEarningRules()`

`listLoyaltyCardTransactions()`