# Voucherify.LoyaltiesApi All URIs are relative to *https://api.voucherify.io* Method | HTTP request | Description ------------- | ------------- | ------------- [**activateMemberPendingPoints**](LoyaltiesApi.md#activateMemberPendingPoints) | **POST** /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/activate | Activate Member Pending Points [**addMember**](LoyaltiesApi.md#addMember) | **POST** /v1/loyalties/{campaignId}/members | Add Member [**adjustMemberPendingPoints**](LoyaltiesApi.md#adjustMemberPendingPoints) | **POST** /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/balance | Adjust Member Pending Points [**cancelMemberPendingPoints**](LoyaltiesApi.md#cancelMemberPendingPoints) | **POST** /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/cancel | Cancel Member Pending Points [**createEarningRule**](LoyaltiesApi.md#createEarningRule) | **POST** /v1/loyalties/{campaignId}/earning-rules | Create Earning Rule [**createInBulkLoyaltyTiers**](LoyaltiesApi.md#createInBulkLoyaltyTiers) | **POST** /v1/loyalties/{campaignId}/tiers | Create loyalty tiers [**createLoyaltyProgram**](LoyaltiesApi.md#createLoyaltyProgram) | **POST** /v1/loyalties | Create Loyalty Campaign [**createPointsExpirationExport**](LoyaltiesApi.md#createPointsExpirationExport) | **POST** /v1/loyalties/{campaignId}/points-expiration/export | Export Loyalty Campaign Point Expiration [**createRewardAssignment1**](LoyaltiesApi.md#createRewardAssignment1) | **POST** /v1/loyalties/{campaignId}/rewards | Create Loyalty Campaign Reward Assignment [**deleteEarningRule**](LoyaltiesApi.md#deleteEarningRule) | **DELETE** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | Delete Earning Rule [**deleteLoyaltyProgram**](LoyaltiesApi.md#deleteLoyaltyProgram) | **DELETE** /v1/loyalties/{campaignId} | Delete Loyalty Campaign [**deleteRewardAssignment1**](LoyaltiesApi.md#deleteRewardAssignment1) | **DELETE** /v1/loyalties/{campaignId}/rewards/{assignmentId} | Delete Campaign Reward Assignment [**disableEarningRule**](LoyaltiesApi.md#disableEarningRule) | **POST** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/disable | Disable Earning Rule [**enableEarningRule**](LoyaltiesApi.md#enableEarningRule) | **POST** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/enable | Enable Earning Rule [**exportLoyaltyCampaignTransactions**](LoyaltiesApi.md#exportLoyaltyCampaignTransactions) | **POST** /v1/loyalties/{campaignId}/transactions/export | Export Loyalty Campaign Transactions [**exportLoyaltyCardTransactions**](LoyaltiesApi.md#exportLoyaltyCardTransactions) | **POST** /v1/loyalties/members/{memberId}/transactions/export | Export Loyalty Card Transactions [**exportLoyaltyCardTransactions1**](LoyaltiesApi.md#exportLoyaltyCardTransactions1) | **POST** /v1/loyalties/{campaignId}/members/{memberId}/transactions/export | Export Loyalty Card Transactions with campaign ID [**getEarningRule**](LoyaltiesApi.md#getEarningRule) | **GET** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | Get Earning Rule [**getLoyaltyProgram**](LoyaltiesApi.md#getLoyaltyProgram) | **GET** /v1/loyalties/{campaignId} | Get Loyalty Campaign [**getLoyaltyTier**](LoyaltiesApi.md#getLoyaltyTier) | **GET** /v1/loyalties/{campaignId}/tiers/{loyaltyTierId} | Get Loyalty Tier [**getMember**](LoyaltiesApi.md#getMember) | **GET** /v1/loyalties/members/{memberId} | Get Member [**getMember1**](LoyaltiesApi.md#getMember1) | **GET** /v1/loyalties/{campaignId}/members/{memberId} | Get Member with campaign ID [**getRewardAssignment1**](LoyaltiesApi.md#getRewardAssignment1) | **GET** /v1/loyalties/{campaignId}/reward-assignments/{assignmentId} | Get Campaign Reward Assignments [**getRewardAssignment2**](LoyaltiesApi.md#getRewardAssignment2) | **GET** /v1/loyalties/{campaignId}/rewards/{assignmentId} | Get Campaign Reward Assignment [**getRewardDetails**](LoyaltiesApi.md#getRewardDetails) | **GET** /v1/loyalties/{campaignId}/reward-assignments/{assignmentId}/reward | Get Reward Details [**listCampaignPendingPoints**](LoyaltiesApi.md#listCampaignPendingPoints) | **GET** /v1/loyalties/{campaignId}/pending-points | List Campaign Pending Points [**listEarningRules**](LoyaltiesApi.md#listEarningRules) | **GET** /v1/loyalties/{campaignId}/earning-rules | List Earning Rules [**listLoyaltyCampaignTransactions**](LoyaltiesApi.md#listLoyaltyCampaignTransactions) | **GET** /v1/loyalties/{campaignId}/transactions | List Loyalty Campaign Transactions [**listLoyaltyCardTransactions**](LoyaltiesApi.md#listLoyaltyCardTransactions) | **GET** /v1/loyalties/members/{memberId}/transactions | List Loyalty Card Transactions [**listLoyaltyCardTransactions1**](LoyaltiesApi.md#listLoyaltyCardTransactions1) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/transactions | List Loyalty Card Transactions with campaign ID [**listLoyaltyPrograms**](LoyaltiesApi.md#listLoyaltyPrograms) | **GET** /v1/loyalties | List Loyalty Campaigns [**listLoyaltyTierEarningRules**](LoyaltiesApi.md#listLoyaltyTierEarningRules) | **GET** /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/earning-rules | List Loyalty Tier Earning Rules [**listLoyaltyTierRewards**](LoyaltiesApi.md#listLoyaltyTierRewards) | **GET** /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/rewards | List Loyalty Tier Rewards [**listLoyaltyTiers**](LoyaltiesApi.md#listLoyaltyTiers) | **GET** /v1/loyalties/{campaignId}/tiers | List Loyalty Tiers [**listMemberActivity**](LoyaltiesApi.md#listMemberActivity) | **GET** /v1/loyalties/members/{memberId}/activity | List Member Activity [**listMemberActivity1**](LoyaltiesApi.md#listMemberActivity1) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/activity | List Member Activity with campaign ID [**listMemberLoyaltyTier**](LoyaltiesApi.md#listMemberLoyaltyTier) | **GET** /v1/loyalties/members/{memberId}/tiers | List Member's Loyalty Tiers [**listMemberPendingPoints**](LoyaltiesApi.md#listMemberPendingPoints) | **GET** /v1/loyalties/members/{memberId}/pending-points | List Member Pending Points [**listMemberPendingPoints1**](LoyaltiesApi.md#listMemberPendingPoints1) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/pending-points | List Member Pending Points with campaign ID [**listMemberRewards**](LoyaltiesApi.md#listMemberRewards) | **GET** /v1/loyalties/members/{memberId}/rewards | List Member Rewards [**listMembers**](LoyaltiesApi.md#listMembers) | **GET** /v1/loyalties/{campaignId}/members | List Members [**listPointsExpiration**](LoyaltiesApi.md#listPointsExpiration) | **GET** /v1/loyalties/{campaignId}/members/{memberId}/points-expiration | List Loyalty Card Point Expiration [**listRewardAssignments1**](LoyaltiesApi.md#listRewardAssignments1) | **GET** /v1/loyalties/{campaignId}/reward-assignments | List Reward Assignments with campaign ID [**listRewardAssignments2**](LoyaltiesApi.md#listRewardAssignments2) | **GET** /v1/loyalties/{campaignId}/rewards | List Campaign Rewards [**redeemReward**](LoyaltiesApi.md#redeemReward) | **POST** /v1/loyalties/members/{memberId}/redemption | Redeem Reward [**redeemReward1**](LoyaltiesApi.md#redeemReward1) | **POST** /v1/loyalties/{campaignId}/members/{memberId}/redemption | Redeem Reward with campaign ID [**transferPoints**](LoyaltiesApi.md#transferPoints) | **POST** /v1/loyalties/{campaignId}/members/{memberId}/transfers | Transfer Loyalty Points [**updateEarningRule**](LoyaltiesApi.md#updateEarningRule) | **PUT** /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | Update Earning Rule [**updateLoyaltyCardBalance**](LoyaltiesApi.md#updateLoyaltyCardBalance) | **POST** /v1/loyalties/members/{memberId}/balance | Adjust Loyalty Card Balance [**updateLoyaltyCardBalance1**](LoyaltiesApi.md#updateLoyaltyCardBalance1) | **POST** /v1/loyalties/{campaignId}/members/{memberId}/balance | Adjust Loyalty Card Balance with campaign ID [**updateLoyaltyProgram**](LoyaltiesApi.md#updateLoyaltyProgram) | **PUT** /v1/loyalties/{campaignId} | Update Loyalty Campaign [**updateRewardAssignment1**](LoyaltiesApi.md#updateRewardAssignment1) | **PUT** /v1/loyalties/{campaignId}/rewards/{assignmentId} | Update Campaign Reward Assignment ## activateMemberPendingPoints > LoyaltiesMembersPendingPointsActivateResponseBody activateMemberPendingPoints(memberId, pendingPointsId) Activate Member Pending Points <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Activate manually the pending points and add them to the loyalty card. The pending points are determined by the pending point ID. Once activated, the pending point entry with that ID is not listed by the endpoints: List member ([with campaign ID](/api-reference/loyalties/list-member-pending-points-with-campaign-id), [without campaign ID](/api-reference/loyalties/list-member-pending-points)), [List campaign pending points](/api-reference/loyalties/list-campaign-pending-points). This **POST** method does not require a request body. <Tip> <Badge color green>Configuring pending points</Badge> Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). </Tip> ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let memberId = "memberId_example"; // String | Unique loyalty card code assigned to a particular customer. let pendingPointsId = "pendingPointsId_example"; // String | Unique pending point identifier, assigned by Voucherify. apiInstance.activateMemberPendingPoints(memberId, pendingPointsId, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **memberId** | **String**| Unique loyalty card code assigned to a particular customer. | **pendingPointsId** | **String**| Unique pending point identifier, assigned by Voucherify. | ### Return type [**LoyaltiesMembersPendingPointsActivateResponseBody**](LoyaltiesMembersPendingPointsActivateResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## addMember > LoyaltiesMembersCreateResponseBody addMember(campaignId, loyaltiesMembersCreateRequestBody) Add Member <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> This method assigns a loyalty card to a customer. It selects a [loyalty card](/api-reference/vouchers/get-voucher) 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. <Note> <Badge color blue>Auto-update campaign</Badge> In case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use **auto-update** campaign. </Note> ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_example"; // String | Unique campaign ID of the loyalty program. let loyaltiesMembersCreateRequestBody = {"customer":"source_customer_1","metadata":{"year":2022},"channel":"postman","voucher":"KpzbHUY5"}; // 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](/api-reference/publications/list-publications) endpoint. apiInstance.addMember(campaignId, loyaltiesMembersCreateRequestBody, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **String**| Unique campaign ID of the loyalty program. | **loyaltiesMembersCreateRequestBody** | [**LoyaltiesMembersCreateRequestBody**](LoyaltiesMembersCreateRequestBody.md)| 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](/api-reference/publications/list-publications) endpoint. | ### Return type [**LoyaltiesMembersCreateResponseBody**](LoyaltiesMembersCreateResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## adjustMemberPendingPoints > LoyaltiesMembersPendingPointsBalanceResponseBody adjustMemberPendingPoints(memberId, pendingPointsId, loyaltiesMembersPendingPointsBalanceRequestBody) Adjust Member Pending Points <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Adjusts the pending points with a given ID. You can add or subtract the number of points. <Tip> <Badge color green>Configuring pending points</Badge> Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). </Tip> ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let memberId = "memberId_example"; // String | Unique loyalty card code assigned to a particular customer. let pendingPointsId = "pendingPointsId_example"; // String | Unique pending point identifier, assigned by Voucherify. let loyaltiesMembersPendingPointsBalanceRequestBody = {"points":10}; // LoyaltiesMembersPendingPointsBalanceRequestBody | Define the number of pending points to be added or subtracted. apiInstance.adjustMemberPendingPoints(memberId, pendingPointsId, loyaltiesMembersPendingPointsBalanceRequestBody, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **memberId** | **String**| Unique loyalty card code assigned to a particular customer. | **pendingPointsId** | **String**| Unique pending point identifier, assigned by Voucherify. | **loyaltiesMembersPendingPointsBalanceRequestBody** | [**LoyaltiesMembersPendingPointsBalanceRequestBody**](LoyaltiesMembersPendingPointsBalanceRequestBody.md)| Define the number of pending points to be added or subtracted. | ### Return type [**LoyaltiesMembersPendingPointsBalanceResponseBody**](LoyaltiesMembersPendingPointsBalanceResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## cancelMemberPendingPoints > cancelMemberPendingPoints(memberId, pendingPointsId) Cancel Member Pending Points <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Cancel manually the pending points for the loyalty card. The pending points are determined by the pending point ID. Once canceled, the pending point entry with that ID is not listed by the endpoints: List member ([with campaign ID](/api-reference/loyalties/list-member-pending-points-with-campaign-id), [without campaign ID](/api-reference/loyalties/list-member-pending-points)), [List campaign pending points](/api-reference/loyalties/list-campaign-pending-points). This **POST** method does not require a request body and it returns an empty, 204, response. <Tip> <Badge color green>Configuring pending points</Badge> Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). </Tip> ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let memberId = "memberId_example"; // String | Unique loyalty card code assigned to a particular customer. let pendingPointsId = "pendingPointsId_example"; // String | Unique pending point identifier, assigned by Voucherify. apiInstance.cancelMemberPendingPoints(memberId, pendingPointsId, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully.'); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **memberId** | **String**| Unique loyalty card code assigned to a particular customer. | **pendingPointsId** | **String**| Unique pending point identifier, assigned by Voucherify. | ### Return type null (empty response body) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ## createEarningRule > [LoyaltiesEarningRulesCreateResponseBody] createEarningRule(campaignId, loyaltiesEarningRulesCreateRequestBodyItem) Create Earning Rule <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Create earning rules for a loyalty campaign. <Warning> <Badge color yellow>Maximum number of earning rules</Badge> You can create up to 100 earning rules per project. The limit can be customized for clients with a single-tenant setup. </Warning> ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_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. let loyaltiesEarningRulesCreateRequestBodyItem = [{"event":"order.paid","validation_rule_id":"val_7SxpdhPeBngA","loyalty":{"type":"FIXED","points":"5"},"source":{"banner":"Order paid 5 points."},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Order paid - fixed amount of points"}},{"event":"order.paid","validation_rule_id":null,"loyalty":{"type":"PROPORTIONAL","calculation_type":"ORDER_AMOUNT","order":{"amount":{"every":1,"points":1}}},"source":{"banner":"Order paid - 1 point for 1 dollar spent excluding discounts."},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Order paid- points proportional to order amount"}},{"event":"order.paid","validation_rule_id":null,"loyalty":{"type":"PROPORTIONAL","calculation_type":"ORDER_TOTAL_AMOUNT","order":{"total_amount":{"every":1,"points":1}}},"source":{"banner":"Order paid - 1 point for 1 dollar spent including discounts."},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Order paid- points proportional to order total amount"}},{"event":"order.paid","validation_rule_id":null,"loyalty":{"type":"PROPORTIONAL","calculation_type":"ORDER_METADATA","order":{"metadata":{"every":2,"points":1,"property":"number_of_store_visits"}}},"source":{"banner":"Order paid - 2 points for each store visit."},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Order paid- points proportional to numerical order metadata property "}},{"event":"order.paid","validation_rule_id":null,"loyalty":{"type":"PROPORTIONAL","calculation_type":"ORDER_ITEMS_AMOUNT","order_items":{"amount":{"every":2,"points":1,"object":"product","id":"prod_0bae32322150fd0546"}}},"source":{"banner":"Order paid - 2 points for 1 dollar spent on items excluding discounts."},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Order paid- points proportional to order items amount"}},{"event":"order.paid","validation_rule_id":null,"loyalty":{"type":"PROPORTIONAL","calculation_type":"ORDER_ITEMS_SUBTOTAL_AMOUNT","order_items":{"subtotal_amount":{"every":2,"points":1,"object":"products_collection","id":"pc_75U0dHlr7u75BJodrW1AE3t6"}}},"source":{"banner":"Order paid - 2 points for every dollar spent on the product collection."},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Order paid- points proportional to order items subtotal amount"}},{"event":"order.paid","validation_rule_id":null,"loyalty":{"type":"PROPORTIONAL","calculation_type":"ORDER_ITEMS_QUANTITY","order_items":{"quantity":{"every":1,"points":1,"object":"sku","id":"sku_0b7d7dfb090be5c619"}}},"source":{"banner":"Order paid - 1 point for every brand phone in your cart."},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Order paid - points proportional to quantity of items in a cart of a product varient."}},{"event":"order.paid","validation_rule_id":"val_7SxpdhPeBngA","loyalty":{"type":"PROPORTIONAL","calculation_type":"CUSTOMER_METADATA","customer":{"metadata":{"every":1,"points":1,"property":"customer_life_time_value"}}},"source":{"banner":"Order paid 1 point for 1 month of being a customer with us."},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Order paid - points proportional to customer metadata property"}},{"event":"customer.segment.entered","segment":{"id":"seg_OlE7DmfzMI5pHyD5VAv512r1"},"validation_rule_id":"val_7SxpdhPeBngA","loyalty":{"type":"PROPORTIONAL","calculation_type":"CUSTOMER_METADATA","customer":{"metadata":{"every":1,"points":1,"property":"customer_life_time_value"}}},"source":{"banner":"Customer entered birthday segment - 1 point for each month of being a customer with us."},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Entered segment - points proportional to customer metadata property"}},{"event":"customer.segment.entered","segment":{"id":"seg_OlE7DmfzMI5pHyD5VAv512r1"},"validation_rule_id":"val_7SxpdhPeBngA","loyalty":{"type":"FIXED","points":"5"},"source":{"banner":"Customer entered birthday segment - 5 points"},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Entered segment - fixed points"}},{"event":"page_view","validation_rule_id":"val_7SxpdhPeBngA","loyalty":{"points":3,"type":"FIXED"},"custom_event":{"schema_id":"ms_gn4Qe4xsFPf7orCArCiNVY13"},"source":{"banner":"See page - 3 points"},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Custom Event - fixed points for viewing a page"}},{"event":"page_view","validation_rule_id":"val_7SxpdhPeBngA","loyalty":{"type":"PROPORTIONAL","calculation_type":"CUSTOM_EVENT_METADATA","custom_event":{"metadata":{"every":1,"points":2,"property":"volume_number"}}},"custom_event":{"schema_id":"ms_gn4Qe4xsFPf7orCArCiNVY13"},"source":{"banner":"See page X - get 2 points multiplied by the page number"},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Custom Event - proportional points for viewing a page based on custom event metadata"}},{"event":"page_view","validation_rule_id":"val_7SxpdhPeBngA","loyalty":{"type":"PROPORTIONAL","calculation_type":"CUSTOMER_METADATA","customer":{"metadata":{"every":1,"points":2,"property":"customer_life_time_value"}}},"custom_event":{"schema_id":"ms_gn4Qe4xsFPf7orCArCiNVY13"},"source":{"banner":"Get 2 points for every month you're a customer for viewing a page"},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Custom Event - proportional points for viewing a page based on customer metadata"}},{"event":"customer.loyalty.tier.prolonged","validation_rule_id":"val_7SxpdhPeBngA","loyalty":{"type":"PROPORTIONAL","calculation_type":"CUSTOMER_METADATA","customer":{"metadata":{"every":1,"points":2,"property":"customer_life_time_value"}}},"loyalty_tier":{"id":"ltr_pudTGWasuIqxdiDM0go31OV1"},"source":{"banner":"Get 2 points for every month you're a customer when your loyalty tier is prolonged."},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Custom Event - proportional points for extending a loyalty tier based on customer metadata."}}]; // [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 apiInstance.createEarningRule(campaignId, loyaltiesEarningRulesCreateRequestBodyItem, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters 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** | [**[LoyaltiesEarningRulesCreateRequestBodyItem]**](LoyaltiesEarningRulesCreateRequestBodyItem.md)| 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 | ### Return type [**[LoyaltiesEarningRulesCreateResponseBody]**](LoyaltiesEarningRulesCreateResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## createInBulkLoyaltyTiers > [LoyaltyTier] createInBulkLoyaltyTiers(campaignId, loyaltiesTiersCreateInBulkRequestBodyItem) Create loyalty tiers <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Creates loyalty tiers for desired campaign. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_example"; // String | Unique loyalty campaign ID or name. let loyaltiesTiersCreateInBulkRequestBodyItem = [new Voucherify.LoyaltiesTiersCreateInBulkRequestBodyItem()]; // [LoyaltiesTiersCreateInBulkRequestBodyItem] | Provide tier definitions you want to add to existing loyalty campaign. apiInstance.createInBulkLoyaltyTiers(campaignId, loyaltiesTiersCreateInBulkRequestBodyItem, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **String**| Unique loyalty campaign ID or name. | **loyaltiesTiersCreateInBulkRequestBodyItem** | [**[LoyaltiesTiersCreateInBulkRequestBodyItem]**](LoyaltiesTiersCreateInBulkRequestBodyItem.md)| Provide tier definitions you want to add to existing loyalty campaign. | ### Return type [**[LoyaltyTier]**](LoyaltyTier.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## createLoyaltyProgram > LoyaltiesCreateCampaignResponseBody createLoyaltyProgram(loyaltiesCreateCampaignRequestBody) Create Loyalty Campaign <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Creates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. <Note> <Badge color blue>Global uniqueness</Badge> All codes are unique across the whole project. Voucherify wont allow to generate the same codes in any of your campaigns. </Note> <Warning> <Badge color yellow>Asynchronous action!</Badge> This is an asynchronous action, you cant read or modify a newly created campaign until the code generation is completed. See creation_status field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description. </Warning> ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let loyaltiesCreateCampaignRequestBody = {"name":"Loyalty Program 4","description":"This is a campaign description.","auto_join":true,"join_once":true,"use_voucher_metadata_schema":true,"start_date":"2016-10-26T00:00:00Z","expiration_date":"2024-10-26T00:00:00Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"activity_duration_after_publishing":"P24D","category_id":"cat_0b6152ce12414820dc","vouchers_count":2,"voucher":{"type":"LOYALTY_CARD","loyalty_card":{"points":0,"expiration_rules":{"period_type":"MONTH","period_value":3,"rounding_type":"END_OF_QUARTER"}},"redemption":{"quantity":2},"code_config":{"pattern":"L-CARD-#######"}},"metadata":{"test":true},"type":"STATIC","loyalty_tiers_expiration":{"qualification_type":"BALANCE","start_date":{"type":"IMMEDIATE"},"expiration_date":{"type":"CUSTOM","extend":"P3M","rounding":{"type":"MONTH","strategy":"END"}}}}; // LoyaltiesCreateCampaignRequestBody | Specify the loyalty campaign details. apiInstance.createLoyaltyProgram(loyaltiesCreateCampaignRequestBody, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **loyaltiesCreateCampaignRequestBody** | [**LoyaltiesCreateCampaignRequestBody**](LoyaltiesCreateCampaignRequestBody.md)| Specify the loyalty campaign details. | ### Return type [**LoyaltiesCreateCampaignResponseBody**](LoyaltiesCreateCampaignResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## createPointsExpirationExport > LoyaltiesPointsExpirationExportCreateResponseBody createPointsExpirationExport(campaignId, loyaltiesPointsExpirationExportCreateRequestBody) Export Loyalty Campaign Point Expiration <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Schedule the generation of a point expiration CSV file for a particular campaign. It can list point buckets, which can have an ACTIVE or EXPIRED status. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_example"; // String | Unique campaign ID or name. let loyaltiesPointsExpirationExportCreateRequestBody = {"parameters":{"fields":["id","campaign_id","voucher_id","status","expires_at","points"],"order":"-expires_at","filters":{"junction":"and","voucher_id":{"conditions":{"$in":["v_0aMj6Mdp0i3zuXrd9NnBKboc7746mlgF","v_YLn0WVWXSXbUfDvxgrgUbtfJ3SQIY655"]}}}}}; // LoyaltiesPointsExpirationExportCreateRequestBody | Specify the data filters, types of data to return and order in which the results should be returned. apiInstance.createPointsExpirationExport(campaignId, loyaltiesPointsExpirationExportCreateRequestBody, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **String**| Unique campaign ID or name. | **loyaltiesPointsExpirationExportCreateRequestBody** | [**LoyaltiesPointsExpirationExportCreateRequestBody**](LoyaltiesPointsExpirationExportCreateRequestBody.md)| Specify the data filters, types of data to return and order in which the results should be returned. | ### Return type [**LoyaltiesPointsExpirationExportCreateResponseBody**](LoyaltiesPointsExpirationExportCreateResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## createRewardAssignment1 > LoyaltiesRewardsCreateAssignmentResponseBody createRewardAssignment1(campaignId, loyaltiesRewardsCreateAssignmentItemRequestBody) Create Loyalty Campaign Reward Assignment <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Add rewards to a loyalty campaign. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_example"; // 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. let loyaltiesRewardsCreateAssignmentItemRequestBody = [{"reward":"rew_wg2pvCr5LDhCq4uVQZ9LhuZm","parameters":{"loyalty":{"points":2}}},{"reward":"rew_z35ffKoH0tCcck8EL56p6SIs","parameters":{"loyalty":{"points":2}}}]; // [LoyaltiesRewardsCreateAssignmentItemRequestBody] | Define the cost of the rewards in loyalty points. apiInstance.createRewardAssignment1(campaignId, loyaltiesRewardsCreateAssignmentItemRequestBody, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters 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** | [**[LoyaltiesRewardsCreateAssignmentItemRequestBody]**](LoyaltiesRewardsCreateAssignmentItemRequestBody.md)| Define the cost of the rewards in loyalty points. | ### Return type [**LoyaltiesRewardsCreateAssignmentResponseBody**](LoyaltiesRewardsCreateAssignmentResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## deleteEarningRule > deleteEarningRule(campaignId, earningRuleId) Delete Earning Rule <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> This method deletes an earning rule for a specific loyalty campaign. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_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. let earningRuleId = "earningRuleId_example"; // String | A unique earning rule ID. apiInstance.deleteEarningRule(campaignId, earningRuleId, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully.'); } }); ``` ### Parameters 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. | **earningRuleId** | **String**| A unique earning rule ID. | ### Return type null (empty response body) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ## deleteLoyaltyProgram > LoyaltiesDeleteResponseBody deleteLoyaltyProgram(campaignId, opts) Delete Loyalty Campaign <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Deletes a loyalty campaign and all related loyalty cards. This action cannot be undone. Also, it immediately removes any redemptions on loyalty cards. If the force parameter is set to false or not set at all, the loyalty campaign and all related loyalty cards will be moved to [the bin](/api-reference/bin/list-bin-entries). ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_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. let opts = { 'force': true // Boolean | If this flag is set to true, the campaign and related vouchers will be removed permanently. If it is set to false or not set at all, the loyalty campaign and all related loyalty cards will be moved to the bin. Going forward, the user will be able to create the next campaign with the same name. }; apiInstance.deleteLoyaltyProgram(campaignId, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters 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. | **force** | **Boolean**| If this flag is set to true, the campaign and related vouchers will be removed permanently. If it is set to false or not set at all, the loyalty campaign and all related loyalty cards will be moved to the bin. Going forward, the user will be able to create the next campaign with the same name. | [optional] ### Return type [**LoyaltiesDeleteResponseBody**](LoyaltiesDeleteResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## deleteRewardAssignment1 > deleteRewardAssignment1(campaignId, assignmentId) Delete Campaign Reward Assignment <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> This method deletes a reward assignment for a particular loyalty campaign. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_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. let assignmentId = "assignmentId_example"; // String | A unique reward assignment ID. apiInstance.deleteRewardAssignment1(campaignId, assignmentId, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully.'); } }); ``` ### Parameters 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. | **assignmentId** | **String**| A unique reward assignment ID. | ### Return type null (empty response body) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ## disableEarningRule > LoyaltiesEarningRulesDisableResponseBody disableEarningRule(campaignId, earningRuleId) Disable Earning Rule <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Disable an earning rule. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_example"; // String | Unique campaign ID or name. let earningRuleId = "earningRuleId_example"; // String | Unique identifier of an earning rule, assigned by Voucherify. apiInstance.disableEarningRule(campaignId, earningRuleId, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **String**| Unique campaign ID or name. | **earningRuleId** | **String**| Unique identifier of an earning rule, assigned by Voucherify. | ### Return type [**LoyaltiesEarningRulesDisableResponseBody**](LoyaltiesEarningRulesDisableResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## enableEarningRule > LoyaltiesEarningRulesEnableResponseBody enableEarningRule(campaignId, earningRuleId) Enable Earning Rule <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Enable an earning rule. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_example"; // String | Unique campaign ID or name. let earningRuleId = "earningRuleId_example"; // String | Unique identifier of an earning rule, assigned by Voucherify. apiInstance.enableEarningRule(campaignId, earningRuleId, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **String**| Unique campaign ID or name. | **earningRuleId** | **String**| Unique identifier of an earning rule, assigned by Voucherify. | ### Return type [**LoyaltiesEarningRulesEnableResponseBody**](LoyaltiesEarningRulesEnableResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## exportLoyaltyCampaignTransactions > CampaignsTransactionsExportCreateResponseBody exportLoyaltyCampaignTransactions(campaignId, loyaltiesTransactionsExportCreateRequestBody) Export Loyalty Campaign Transactions <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Export transactions is an asynchronous process that generates a CSV file with the data about or point movements on all loyalty cards in a given campaign. To export transactions: 1. In the export request, use parameters to select which fields will be exported, in what order, and which data will be filtered. 2. Use the returned id to track the export status with the [GET Export](/api-reference/exports/get-export) method. 3. In the GET Export method, when the returned status field has the DONE value, the export file has been generated. 4. Use the URL in the result property to download the file. You must be logged to your Voucherify account on a given cluster in the browser to be able to download the file. An export request will almost always result in a single file being generated by the system. However, when the data volume is large, the system may split the results into multiple files. An example export file can look as follows: <Tip> <Badge color green>Export Campaign Transactions</Badge> This method works in the same way the [POST Export Campaign Transactions](/api-reference/campaigns/export-campaign-transactions) does, but it is limited to loyalty campaigns only. The POST Export Campaign Transactions method can also export gift card campaign transactions. </Tip> ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_example"; // String | You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. let loyaltiesTransactionsExportCreateRequestBody = {"order":"-created_at","parameters":{"fields":["id","type","source_id","created_at"],"filters":{"created_at":{"conditions":{"$after":["2024-10-01T00:00:00.000Z"]}}}}}; // LoyaltiesTransactionsExportCreateRequestBody | Specify the parameters for the transaction export. apiInstance.exportLoyaltyCampaignTransactions(campaignId, loyaltiesTransactionsExportCreateRequestBody, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **String**| You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. | **loyaltiesTransactionsExportCreateRequestBody** | [**LoyaltiesTransactionsExportCreateRequestBody**](LoyaltiesTransactionsExportCreateRequestBody.md)| Specify the parameters for the transaction export. | ### Return type [**CampaignsTransactionsExportCreateResponseBody**](CampaignsTransactionsExportCreateResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## exportLoyaltyCardTransactions > LoyaltiesMembersTransactionsExportCreateResponseBody exportLoyaltyCardTransactions(memberId, loyaltiesMembersTransactionsExportCreateRequestBody) Export Loyalty Card Transactions <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Export transactions that are associated with point movements on a loyalty card. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let memberId = "memberId_example"; // String | A unique code identifying the loyalty card that you are looking to export transaction data for. let loyaltiesMembersTransactionsExportCreateRequestBody = {"parameters":{"order":"-created_at","fields":["id","type","source_id","reason","balance","amount","created_at","voucher_id","campaign_id","details","related_transaction_id"]}}; // LoyaltiesMembersTransactionsExportCreateRequestBody | Specify the parameters and filters for the transaction export. apiInstance.exportLoyaltyCardTransactions(memberId, loyaltiesMembersTransactionsExportCreateRequestBody, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **memberId** | **String**| A unique code identifying the loyalty card that you are looking to export transaction data for. | **loyaltiesMembersTransactionsExportCreateRequestBody** | [**LoyaltiesMembersTransactionsExportCreateRequestBody**](LoyaltiesMembersTransactionsExportCreateRequestBody.md)| Specify the parameters and filters for the transaction export. | ### Return type [**LoyaltiesMembersTransactionsExportCreateResponseBody**](LoyaltiesMembersTransactionsExportCreateResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## exportLoyaltyCardTransactions1 > LoyaltiesMembersTransactionsExportCreateResponseBody exportLoyaltyCardTransactions1(campaignId, memberId, loyaltiesMembersTransactionsExportCreateRequestBody) Export Loyalty Card Transactions with campaign ID <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Export transactions that are associated with point movements on a loyalty card. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_example"; // String | A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to export. let memberId = "memberId_example"; // String | A unique code identifying the loyalty card that you are looking to export transaction data for. let loyaltiesMembersTransactionsExportCreateRequestBody = {"parameters":{"order":"-created_at","fields":["id","type","source_id","reason","balance","amount","created_at","voucher_id","campaign_id","details","related_transaction_id"]}}; // LoyaltiesMembersTransactionsExportCreateRequestBody | Specify the parameters and filters for the transaction export. apiInstance.exportLoyaltyCardTransactions1(campaignId, memberId, loyaltiesMembersTransactionsExportCreateRequestBody, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters 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** | [**LoyaltiesMembersTransactionsExportCreateRequestBody**](LoyaltiesMembersTransactionsExportCreateRequestBody.md)| Specify the parameters and filters for the transaction export. | ### Return type [**LoyaltiesMembersTransactionsExportCreateResponseBody**](LoyaltiesMembersTransactionsExportCreateResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## getEarningRule > LoyaltiesEarningRulesGetResponseBody getEarningRule(campaignId, earningRuleId) Get Earning Rule <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieves an earning rule assigned to a campaign. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_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. let earningRuleId = "earningRuleId_example"; // String | A unique earning rule ID. apiInstance.getEarningRule(campaignId, earningRuleId, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters 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. | **earningRuleId** | **String**| A unique earning rule ID. | ### Return type [**LoyaltiesEarningRulesGetResponseBody**](LoyaltiesEarningRulesGetResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getLoyaltyProgram > LoyaltiesGetCampaignResponseBody getLoyaltyProgram(campaignId) Get Loyalty Campaign <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve a specific loyalty campaign. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_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. apiInstance.getLoyaltyProgram(campaignId, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters 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. | ### Return type [**LoyaltiesGetCampaignResponseBody**](LoyaltiesGetCampaignResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getLoyaltyTier > LoyaltiesTiersGetResponseBody getLoyaltyTier(campaignId, loyaltyTierId) Get Loyalty Tier <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve a loyalty tier from a loyalty campaign by the loyalty tier ID. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_example"; // String | Unique loyalty campaign ID or name. let loyaltyTierId = "loyaltyTierId_example"; // String | Unique loyalty tier ID. apiInstance.getLoyaltyTier(campaignId, loyaltyTierId, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **String**| Unique loyalty campaign ID or name. | **loyaltyTierId** | **String**| Unique loyalty tier ID. | ### Return type [**LoyaltiesTiersGetResponseBody**](LoyaltiesTiersGetResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getMember > LoyaltiesMembersGetResponseBody getMember(memberId) Get Member <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve loyalty card with the given member ID (i.e. voucher code). <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/get-member-with-campaign-id). The URL was re-designed to allow you to retrieve loyalty card details without having to provide the campaignId as a path parameter. </Note> ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let memberId = "memberId_example"; // String | Unique loyalty card code assigned to a particular customer. apiInstance.getMember(memberId, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **memberId** | **String**| Unique loyalty card code assigned to a particular customer. | ### Return type [**LoyaltiesMembersGetResponseBody**](LoyaltiesMembersGetResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getMember1 > LoyaltiesMembersGetResponseBody getMember1(campaignId, memberId) Get Member with campaign ID <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieves the loyalty card with the given member ID (i.e. voucher code). ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_example"; // String | Unique campaign ID. let memberId = "memberId_example"; // String | Unique code that identifies the loyalty card. apiInstance.getMember1(campaignId, memberId, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **String**| Unique campaign ID. | **memberId** | **String**| Unique code that identifies the loyalty card. | ### Return type [**LoyaltiesMembersGetResponseBody**](LoyaltiesMembersGetResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getRewardAssignment1 > LoyaltiesRewardAssignmentsGetResponseBody getRewardAssignment1(campaignId, assignmentId) Get Campaign Reward Assignments <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve specific reward assignment. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_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. let assignmentId = "assignmentId_example"; // String | Unique reward assignment ID. apiInstance.getRewardAssignment1(campaignId, assignmentId, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters 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. | **assignmentId** | **String**| Unique reward assignment ID. | ### Return type [**LoyaltiesRewardAssignmentsGetResponseBody**](LoyaltiesRewardAssignmentsGetResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getRewardAssignment2 > LoyaltiesRewardsGetResponseBody getRewardAssignment2(campaignId, assignmentId) Get Campaign Reward Assignment <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve specific reward assignment. <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/get-campaign-reward-assignments). </Note> ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_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. let assignmentId = "assignmentId_example"; // String | A unique reward assignment ID. apiInstance.getRewardAssignment2(campaignId, assignmentId, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters 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. | **assignmentId** | **String**| A unique reward assignment ID. | ### Return type [**LoyaltiesRewardsGetResponseBody**](LoyaltiesRewardsGetResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## getRewardDetails > LoyaltiesRewardAssignmentsRewardGetResponseBody getRewardDetails(campaignId, assignmentId) Get Reward Details <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Get reward details in the context of a loyalty campaign and reward assignment ID. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_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. let assignmentId = "assignmentId_example"; // String | Unique reward assignment ID. apiInstance.getRewardDetails(campaignId, assignmentId, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters 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. | **assignmentId** | **String**| Unique reward assignment ID. | ### Return type [**LoyaltiesRewardAssignmentsRewardGetResponseBody**](LoyaltiesRewardAssignmentsRewardGetResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## listCampaignPendingPoints > LoyaltiesPendingPointsListResponseBody listCampaignPendingPoints(campaignId, opts) List Campaign Pending Points <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Lists all pending points that are currently assigned to all loyalty cards in a campaign. Once the points are added to the card, the entry is no longer returned. <Tip> <Badge color green>Configuring pending points</Badge> Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). </Tip> ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_example"; // String | Unique campaign ID. let opts = { 'limit': 56, // Number | Limit the number of the pending point entries that the API returns in the response. 'order': new Voucherify.ParameterOrderListPendingPoints(), // ParameterOrderListPendingPoints | Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order. 'startingAfterId': "startingAfterId_example" // String | A cursor for pagination. It retrieves the results starting after a result with the given ID. }; apiInstance.listCampaignPendingPoints(campaignId, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **String**| Unique campaign ID. | **limit** | **Number**| Limit the number of the pending point entries that the API returns in the response. | [optional] **order** | [**ParameterOrderListPendingPoints**](.md)| Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order. | [optional] **startingAfterId** | **String**| A cursor for pagination. It retrieves the results starting after a result with the given ID. | [optional] ### Return type [**LoyaltiesPendingPointsListResponseBody**](LoyaltiesPendingPointsListResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## listEarningRules > LoyaltiesEarningRulesListResponseBody listEarningRules(campaignId, opts) List Earning Rules <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Returns a list of all earning rules within a given campaign. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_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. let opts = { 'limit': 56, // Number | Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. 'page': 56, // Number | Which page of results to return. The lowest value is 1. 'order': new Voucherify.ParameterOrderListEarningRules() // ParameterOrderListEarningRules | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. }; apiInstance.listEarningRules(campaignId, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters 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. | **limit** | **Number**| 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** | **Number**| Which page of results to return. The lowest value is 1. | [optional] **order** | [**ParameterOrderListEarningRules**](.md)| 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 [**LoyaltiesEarningRulesListResponseBody**](LoyaltiesEarningRulesListResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## listLoyaltyCampaignTransactions > LoyaltiesTransactionsListResponseBody listLoyaltyCampaignTransactions(campaignId, opts) List Loyalty Campaign Transactions <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieves all transactions for the campaign with the given campaign ID or campaign name. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_example"; // String | You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. let opts = { 'limit': 56, // Number | 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. 'order': new Voucherify.ParameterOrderListTransactions(), // ParameterOrderListTransactions | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. 'startingAfterId': "startingAfterId_example", // String | A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID. 'filters': new Voucherify.ParametersFiltersListCampaignTransactions() // ParametersFiltersListCampaignTransactions | Filters for listing responses. The id filter denotes the unique transaction identifier. }; apiInstance.listLoyaltyCampaignTransactions(campaignId, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **String**| You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value. | **limit** | **Number**| 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** | [**ParameterOrderListTransactions**](.md)| Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] **startingAfterId** | **String**| A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID. | [optional] **filters** | [**ParametersFiltersListCampaignTransactions**](.md)| Filters for listing responses. The id filter denotes the unique transaction identifier. | [optional] ### Return type [**LoyaltiesTransactionsListResponseBody**](LoyaltiesTransactionsListResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## listLoyaltyCardTransactions > LoyaltiesMembersTransactionsListResponseBody listLoyaltyCardTransactions(memberId, opts) List Loyalty Card Transactions <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve transaction data related to point movements for a specific loyalty card. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let memberId = "memberId_example"; // String | A unique code identifying the loyalty card that you are looking to retrieve transaction data for. let opts = { 'limit': 56, // Number | 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. 'order': new Voucherify.ParameterOrderListTransactions(), // ParameterOrderListTransactions | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. 'filters': new Voucherify.ParameterFiltersListMemberTransactions(), // ParameterFiltersListMemberTransactions | Filters for listing member transactions. id is the unique identifier of the transaction. 'startingAfterId': "startingAfterId_example" // String | A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID. }; apiInstance.listLoyaltyCardTransactions(memberId, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **memberId** | **String**| A unique code identifying the loyalty card that you are looking to retrieve transaction data for. | **limit** | **Number**| 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** | [**ParameterOrderListTransactions**](.md)| Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] **filters** | [**ParameterFiltersListMemberTransactions**](.md)| Filters for listing member transactions. id is the unique identifier of the transaction. | [optional] **startingAfterId** | **String**| A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID. | [optional] ### Return type [**LoyaltiesMembersTransactionsListResponseBody**](LoyaltiesMembersTransactionsListResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## listLoyaltyCardTransactions1 > LoyaltiesMembersTransactionsListResponseBody listLoyaltyCardTransactions1(campaignId, memberId, opts) List Loyalty Card Transactions with campaign ID <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve transaction data related to point movements for a specific loyalty card. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_example"; // String | A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to return. let memberId = "memberId_example"; // String | A unique code identifying the loyalty card that you are looking to retrieve transaction data for. let opts = { 'limit': 56, // Number | 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. 'order': new Voucherify.ParameterOrderListTransactions(), // ParameterOrderListTransactions | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. 'filters': new Voucherify.ParameterFiltersListMemberTransactions(), // ParameterFiltersListMemberTransactions | Filters for listing member transactions. id is the unique identifier of the transaction. 'startingAfterId': "startingAfterId_example" // String | A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID. }; apiInstance.listLoyaltyCardTransactions1(campaignId, memberId, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **String**| A unique identifier of the loyalty campaign containing the voucher whose transactions you would like to return. | **memberId** | **String**| A unique code identifying the loyalty card that you are looking to retrieve transaction data for. | **limit** | **Number**| 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** | [**ParameterOrderListTransactions**](.md)| Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. | [optional] **filters** | [**ParameterFiltersListMemberTransactions**](.md)| Filters for listing member transactions. id is the unique identifier of the transaction. | [optional] **startingAfterId** | **String**| A cursor for pagination. It retrieves the transactions starting after a transaction with the given ID. | [optional] ### Return type [**LoyaltiesMembersTransactionsListResponseBody**](LoyaltiesMembersTransactionsListResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## listLoyaltyPrograms > LoyaltiesListCampaignsResponseBody listLoyaltyPrograms(opts) List Loyalty Campaigns <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Returns a list of your loyalty campaigns. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let opts = { 'limit': 56, // Number | Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. 'page': 56, // Number | Which page of results to return. The lowest value is 1. 'expand': new Voucherify.ParameterExpandListCampaigns(), // ParameterExpandListCampaigns | Includes an expanded categories object in the response. If the [Areas and Stores](/orchestrate/areas-and-stores) Enterprise feature is enabled, add access_settings_assignments to return assigned areas and stores. 'order': new Voucherify.ParameterOrderListCampaigns() // ParameterOrderListCampaigns | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. }; apiInstance.listLoyaltyPrograms(opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **limit** | **Number**| 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** | **Number**| Which page of results to return. The lowest value is 1. | [optional] **expand** | [**ParameterExpandListCampaigns**](.md)| Includes an expanded categories object in the response. If the [Areas and Stores](/orchestrate/areas-and-stores) Enterprise feature is enabled, add access_settings_assignments to return assigned areas and stores. | [optional] **order** | [**ParameterOrderListCampaigns**](.md)| 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 [**LoyaltiesListCampaignsResponseBody**](LoyaltiesListCampaignsResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## listLoyaltyTierEarningRules > LoyaltiesTiersEarningRulesListResponseBody listLoyaltyTierEarningRules(campaignId, loyaltyTierId, opts) List Loyalty Tier Earning Rules <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve available earning rules for a given tier and the calculation method for earning points. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_example"; // String | Unique campaign ID or name. let loyaltyTierId = "loyaltyTierId_example"; // String | Unique loyalty tier ID. let opts = { 'limit': 56, // Number | Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. 'page': 56 // Number | Which page of results to return. The lowest value is 1. }; apiInstance.listLoyaltyTierEarningRules(campaignId, loyaltyTierId, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **String**| Unique campaign ID or name. | **loyaltyTierId** | **String**| Unique loyalty tier ID. | **limit** | **Number**| 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** | **Number**| Which page of results to return. The lowest value is 1. | [optional] ### Return type [**LoyaltiesTiersEarningRulesListResponseBody**](LoyaltiesTiersEarningRulesListResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## listLoyaltyTierRewards > LoyaltiesTiersRewardsListResponseBody listLoyaltyTierRewards(campaignId, loyaltyTierId) List Loyalty Tier Rewards <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Get available rewards for a given tier. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_example"; // String | Unique campaign ID or name. let loyaltyTierId = "loyaltyTierId_example"; // String | Unique loyalty tier ID. apiInstance.listLoyaltyTierRewards(campaignId, loyaltyTierId, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **String**| Unique campaign ID or name. | **loyaltyTierId** | **String**| Unique loyalty tier ID. | ### Return type [**LoyaltiesTiersRewardsListResponseBody**](LoyaltiesTiersRewardsListResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## listLoyaltyTiers > LoyaltiesTiersListResponseBody listLoyaltyTiers(campaignId, opts) List Loyalty Tiers <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve a list of loyalty tiers which were added to the loyalty program. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_example"; // String | Unique loyalty campaign ID or name. let opts = { 'limit': 56, // Number | 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. 'order': new Voucherify.ParameterOrderListLoyaltyTiers() // ParameterOrderListLoyaltyTiers | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. }; apiInstance.listLoyaltyTiers(campaignId, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **String**| Unique loyalty campaign ID or name. | **limit** | **Number**| 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** | [**ParameterOrderListLoyaltyTiers**](.md)| 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 [**LoyaltiesTiersListResponseBody**](LoyaltiesTiersListResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## listMemberActivity > LoyaltiesMemberActivityListResponseBody listMemberActivity(memberId, opts) List Member Activity <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-member-activity-with-campaign-id). The URL was re-designed to allow you to get member activities without having to provide the campaignId as a path parameter. </Note> Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let memberId = "memberId_example"; // String | Unique loyalty card assigned to a particular customer. let opts = { 'limit': 56, // Number | 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. 'order': new Voucherify.ParameterOrderCreatedAt(), // 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. 'startingAfterId': "startingAfterId_example" // String | A cursor for pagination. It retrieves the events starting after an event with the given ID. }; apiInstance.listMemberActivity(memberId, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **memberId** | **String**| Unique loyalty card assigned to a particular customer. | **limit** | **Number**| 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**](.md)| 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] ### Return type [**LoyaltiesMemberActivityListResponseBody**](LoyaltiesMemberActivityListResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## listMemberActivity1 > LoyaltiesMemberActivityListResponseBody listMemberActivity1(campaignId, memberId, opts) List Member Activity with campaign ID <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_example"; // String | Unique campaign ID. let memberId = "memberId_example"; // String | A code that identifies the loyalty card. let opts = { 'limit': 56, // Number | 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. 'order': new Voucherify.ParameterOrderCreatedAt(), // 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. 'startingAfterId': "startingAfterId_example" // String | A cursor for pagination. It retrieves the events starting after an event with the given ID. }; apiInstance.listMemberActivity1(campaignId, memberId, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **String**| Unique campaign ID. | **memberId** | **String**| A code that identifies the loyalty card. | **limit** | **Number**| 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**](.md)| 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] ### Return type [**LoyaltiesMemberActivityListResponseBody**](LoyaltiesMemberActivityListResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## listMemberLoyaltyTier > LoyaltiesMembersTiersListResponseBody listMemberLoyaltyTier(memberId) List Member's Loyalty Tiers <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Retrieve member tiers using the loyalty card ID. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let memberId = "memberId_example"; // String | Unique loyalty card assigned to a particular customer. apiInstance.listMemberLoyaltyTier(memberId, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **memberId** | **String**| Unique loyalty card assigned to a particular customer. | ### Return type [**LoyaltiesMembersTiersListResponseBody**](LoyaltiesMembersTiersListResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## listMemberPendingPoints > LoyaltiesMembersPendingPointsListResponseBody listMemberPendingPoints(memberId, opts) List Member Pending Points <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-member-pending-points-with-campaign-id). The URL was re-designed to list member pending points without having to provide the campaignId as a path parameter. </Note> Lists all pending points that are currently assigned to the loyalty card. Once the points are added to the card, the entry is no longer returned. <Tip> <Badge color green>Configuring pending points</Badge> Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). </Tip> ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let memberId = "memberId_example"; // String | Unique loyalty card code assigned to a particular customer. let opts = { 'limit': 56, // Number | Limit the number of the pending point entries that the API returns in the response. 'order': new Voucherify.ParameterOrderListPendingPoints(), // ParameterOrderListPendingPoints | Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order. 'startingAfterId': "startingAfterId_example" // String | A cursor for pagination. It retrieves the results starting after a result with the given ID. }; apiInstance.listMemberPendingPoints(memberId, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **memberId** | **String**| Unique loyalty card code assigned to a particular customer. | **limit** | **Number**| Limit the number of the pending point entries that the API returns in the response. | [optional] **order** | [**ParameterOrderListPendingPoints**](.md)| Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order. | [optional] **startingAfterId** | **String**| A cursor for pagination. It retrieves the results starting after a result with the given ID. | [optional] ### Return type [**LoyaltiesMembersPendingPointsListResponseBody**](LoyaltiesMembersPendingPointsListResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## listMemberPendingPoints1 > LoyaltiesMembersPendingPointsListResponseBody listMemberPendingPoints1(campaignId, memberId, opts) List Member Pending Points with campaign ID <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Lists all pending points that are currently assigned to the loyalty card. Once the points are added to the card, the entry is no longer returned. <Tip> <Badge color green>Configuring pending points</Badge> Pending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule). </Tip> ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_example"; // String | Unique campaign ID. let memberId = "memberId_example"; // String | Unique loyalty card code assigned to a particular customer. let opts = { 'limit': 56, // Number | Limit the number of the pending point entries that the API returns in the response. 'order': new Voucherify.ParameterOrderListPendingPoints(), // ParameterOrderListPendingPoints | Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order. 'startingAfterId': "startingAfterId_example" // String | A cursor for pagination. It retrieves the results starting after a result with the given ID. }; apiInstance.listMemberPendingPoints1(campaignId, memberId, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **String**| Unique campaign ID. | **memberId** | **String**| Unique loyalty card code assigned to a particular customer. | **limit** | **Number**| Limit the number of the pending point entries that the API returns in the response. | [optional] **order** | [**ParameterOrderListPendingPoints**](.md)| Orders the pending point entries according the pending point entry ID. The dash - preceding a sorting option means sorting in a descending order. | [optional] **startingAfterId** | **String**| A cursor for pagination. It retrieves the results starting after a result with the given ID. | [optional] ### Return type [**LoyaltiesMembersPendingPointsListResponseBody**](LoyaltiesMembersPendingPointsListResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## listMemberRewards > LoyaltiesMembersRewardsListResponseBody listMemberRewards(memberId, opts) List Member Rewards <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> 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 ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let memberId = "memberId_example"; // String | Unique loyalty card assigned to a particular customer. let opts = { 'affordableOnly': true // Boolean | 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. }; apiInstance.listMemberRewards(memberId, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **memberId** | **String**| Unique loyalty card assigned to a particular customer. | **affordableOnly** | **Boolean**| 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 [**LoyaltiesMembersRewardsListResponseBody**](LoyaltiesMembersRewardsListResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## listMembers > LoyaltiesListMembersResponseBody listMembers(campaignId, opts) List Members <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Returns a list of your loyalty cards. The loyalty cards are sorted by creation date, with the most recent loyalty cards appearing first. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_example"; // String | Unique campaign ID of the loyalty program. let opts = { 'limit': 56, // Number | Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. 'page': 56, // Number | Which page of results to return. The lowest value is 1. 'customer': "customer_example", // String | A tracking identifier of a customer who is the holder of the vouchers. It can be an id generated by Voucherify or the source_id. Remember to use the proper URL escape codes if the source_id contains special characters. 'createdAt': new Voucherify.ParameterCreatedBeforeAfter(), // 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 'updatedAt': new Voucherify.ParameterUpdatedBeforeAfter(), // ParameterUpdatedBeforeAfter | A filter on the list based on the object updated_at field. The value is a dictionary with the following options: before, after. A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [updated_at][before] 2017-09-08T13:52:18.227Z 'order': new Voucherify.ParameterOrderVouchers(), // ParameterOrderVouchers | Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. 'code': "code_example", // String | 'ids': ["null"] // [String] | }; apiInstance.listMembers(campaignId, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **String**| Unique campaign ID of the loyalty program. | **limit** | **Number**| 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** | **Number**| Which page of results to return. The lowest value is 1. | [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] **createdAt** | [**ParameterCreatedBeforeAfter**](.md)| 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] **updatedAt** | [**ParameterUpdatedBeforeAfter**](.md)| 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**](.md)| 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]**](String.md)| | [optional] ### Return type [**LoyaltiesListMembersResponseBody**](LoyaltiesListMembersResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## listPointsExpiration > LoyaltiesMembersPointsExpirationListResponseBody listPointsExpiration(campaignId, memberId, opts) List Loyalty Card Point Expiration <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> 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](/api-reference/exports/create-export) to retrieve a list of both ACTIVE and EXPIRED point buckets. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_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. let memberId = "memberId_example"; // String | Loyalty card code. let opts = { 'limit': 56, // Number | Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. 'page': 56 // Number | Which page of results to return. The lowest value is 1. }; apiInstance.listPointsExpiration(campaignId, memberId, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters 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. | **memberId** | **String**| Loyalty card code. | **limit** | **Number**| 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** | **Number**| Which page of results to return. The lowest value is 1. | [optional] ### Return type [**LoyaltiesMembersPointsExpirationListResponseBody**](LoyaltiesMembersPointsExpirationListResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## listRewardAssignments1 > LoyaltiesRewardAssignmentsListResponseBody listRewardAssignments1(campaignId, opts) List Reward Assignments with campaign ID <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Returns reward assignments from a given loyalty campaign. <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-campaign-rewards). The URL was re-designed to be more contextual to the type of data returned in the response. </Note> ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_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. let opts = { 'limit': 56, // Number | Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. 'page': 56, // Number | Which page of results to return. The lowest value is 1. 'assignmentId': "assignmentId_example" // String | A unique reward assignment ID. }; apiInstance.listRewardAssignments1(campaignId, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters 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. | **limit** | **Number**| 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** | **Number**| Which page of results to return. The lowest value is 1. | [optional] **assignmentId** | **String**| A unique reward assignment ID. | [optional] ### Return type [**LoyaltiesRewardAssignmentsListResponseBody**](LoyaltiesRewardAssignmentsListResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## listRewardAssignments2 > LoyaltiesRewardsListAssignmentsResponseBody listRewardAssignments2(campaignId, opts) List Campaign Rewards <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Returns active rewards from a given loyalty campaign. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_example"; // 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. let opts = { 'limit': 56, // Number | Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. 'page': 56, // Number | Which page of results to return. The lowest value is 1. 'assignmentId': "assignmentId_example" // String | A unique reward assignment ID. }; apiInstance.listRewardAssignments2(campaignId, opts, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters 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. | **limit** | **Number**| 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** | **Number**| Which page of results to return. The lowest value is 1. | [optional] **assignmentId** | **String**| A unique reward assignment ID. | [optional] ### Return type [**LoyaltiesRewardsListAssignmentsResponseBody**](LoyaltiesRewardsListAssignmentsResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## redeemReward > LoyaltiesMembersRedemptionRedeemResponseBody redeemReward(memberId, loyaltiesMembersRedemptionRedeemRequestBody) Redeem Reward <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/redeem-reward-with-campaign-id). The URL was re-designed to allow you to redeem a reward without having to provide the campaignId as a path parameter. </Note> ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let memberId = "memberId_example"; // String | Unique loyalty card assigned to a particular customer. let loyaltiesMembersRedemptionRedeemRequestBody = {"reward":{"id":"rew_INt3fGH3n7xIr3ZQcq4kkUZ1","points":100},"order":{"items":[{"product_id":"prod_0c5d6689b39320059b","quantity":"1"},{"product_id":"prod_0b2c36568000039138","quantity":"2"}]}}; // 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. apiInstance.redeemReward(memberId, loyaltiesMembersRedemptionRedeemRequestBody, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **memberId** | **String**| Unique loyalty card assigned to a particular customer. | **loyaltiesMembersRedemptionRedeemRequestBody** | [**LoyaltiesMembersRedemptionRedeemRequestBody**](LoyaltiesMembersRedemptionRedeemRequestBody.md)| 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. | ### Return type [**LoyaltiesMembersRedemptionRedeemResponseBody**](LoyaltiesMembersRedemptionRedeemResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## redeemReward1 > LoyaltiesMembersRedemptionRedeemResponseBody redeemReward1(campaignId, memberId, loyaltiesMembersRedemptionRedeemRequestBody) Redeem Reward with campaign ID <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> 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 ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_example"; // String | Unique campaign ID. let memberId = "memberId_example"; // String | A code that identifies the loyalty card. let loyaltiesMembersRedemptionRedeemRequestBody = {"reward":{"id":"rew_INt3fGH3n7xIr3ZQcq4kkUZ1","points":100},"order":{"items":[{"product_id":"prod_0c5d6689b39320059b","quantity":"1"},{"product_id":"prod_0b2c36568000039138","quantity":"2"}]}}; // 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. apiInstance.redeemReward1(campaignId, memberId, loyaltiesMembersRedemptionRedeemRequestBody, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **String**| Unique campaign ID. | **memberId** | **String**| A code that identifies the loyalty card. | **loyaltiesMembersRedemptionRedeemRequestBody** | [**LoyaltiesMembersRedemptionRedeemRequestBody**](LoyaltiesMembersRedemptionRedeemRequestBody.md)| 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. | ### Return type [**LoyaltiesMembersRedemptionRedeemResponseBody**](LoyaltiesMembersRedemptionRedeemResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## transferPoints > LoyaltiesMembersTransfersCreateResponseBody transferPoints(campaignId, memberId, loyaltiesTransferPoints) Transfer Loyalty Points <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Transfer points between different loyalty cards which have holders. Provide the campaign ID and the loyalty card ID you want the points to be transferred to as path parameters. In the request body, provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. Transfer works only for loyalty cards that have holders, meaning the cards were published to customers. The transferred points expire according to the target program expiration rules. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_example"; // String | A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). let memberId = "memberId_example"; // String | A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). let loyaltiesTransferPoints = [{"code":"0PmQ7JQI","points":1},{"code":"kCeufB8i","points":1}]; // [LoyaltiesTransferPoints] | Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. apiInstance.transferPoints(campaignId, memberId, loyaltiesTransferPoints, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **String**| A unique identifier of the loyalty campaign containing the voucher to which the loyalty points will be sent (destination). | **memberId** | **String**| A unique code identifying the loyalty card to which the user wants to transfer loyalty points (destination). | **loyaltiesTransferPoints** | [**[LoyaltiesTransferPoints]**](LoyaltiesTransferPoints.md)| Provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card. | ### Return type [**LoyaltiesMembersTransfersCreateResponseBody**](LoyaltiesMembersTransfersCreateResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## updateEarningRule > LoyaltiesEarningRulesUpdateResponseBody updateEarningRule(campaignId, earningRuleId, loyaltiesEarningRulesUpdateRequestBody) Update Earning Rule <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Update an earning rule definition. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_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. let earningRuleId = "earningRuleId_example"; // String | A unique earning rule ID. let loyaltiesEarningRulesUpdateRequestBody = {"validation_rule_id":"val_7SxpdhPeBngA","loyalty":{"type":"FIXED","points":"5"},"source":{"banner":"Order paid 5 points."},"active":true,"start_date":"2022-11-02T13:00:00.000Z","expiration_date":"2023-03-03T14:30:00.000Z","validity_timeframe":{"duration":"PT1H","interval":"P1D"},"validity_day_of_week":[0,1,2,3,4,5],"metadata":{"Type":"Order paid - fixed amount of points"}}; // LoyaltiesEarningRulesUpdateRequestBody | Specify the parameters that you would like to update for the given earning rule. apiInstance.updateEarningRule(campaignId, earningRuleId, loyaltiesEarningRulesUpdateRequestBody, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters 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. | **earningRuleId** | **String**| A unique earning rule ID. | **loyaltiesEarningRulesUpdateRequestBody** | [**LoyaltiesEarningRulesUpdateRequestBody**](LoyaltiesEarningRulesUpdateRequestBody.md)| Specify the parameters that you would like to update for the given earning rule. | ### Return type [**LoyaltiesEarningRulesUpdateResponseBody**](LoyaltiesEarningRulesUpdateResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## updateLoyaltyCardBalance > LoyaltiesMembersBalanceUpdateResponseBody updateLoyaltyCardBalance(memberId, loyaltiesMembersBalanceUpdateRequestBody) Adjust Loyalty Card Balance <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> This method gives adds or removes balance to an existing loyalty card that is assigned to a holder. The removal of points will consume the points that expire the soonest. <Warning> <Badge color yellow>Async Action</Badge> This is an async action. If you want to perform several add or remove loyalty card balance actions in a short time and their order matters, set up sufficient time-out between the calls. </Warning> <Note> <Badge color blue>Alternative endpoint</Badge> This endpoint is an alternative to this [endpoint](/api-reference/loyalties/adjust-loyalty-card-balance-with-campaign-id). 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. </Note> ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let memberId = "memberId_example"; // String | Unique loyalty card assigned to a particular customer. let loyaltiesMembersBalanceUpdateRequestBody = {"points":-100}; // LoyaltiesMembersBalanceUpdateRequestBody | Specify the point adjustment along with the expiration mechanism. apiInstance.updateLoyaltyCardBalance(memberId, loyaltiesMembersBalanceUpdateRequestBody, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **memberId** | **String**| Unique loyalty card assigned to a particular customer. | **loyaltiesMembersBalanceUpdateRequestBody** | [**LoyaltiesMembersBalanceUpdateRequestBody**](LoyaltiesMembersBalanceUpdateRequestBody.md)| Specify the point adjustment along with the expiration mechanism. | ### Return type [**LoyaltiesMembersBalanceUpdateResponseBody**](LoyaltiesMembersBalanceUpdateResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## updateLoyaltyCardBalance1 > LoyaltiesMembersBalanceUpdateResponseBody updateLoyaltyCardBalance1(campaignId, memberId, loyaltiesMembersBalanceUpdateRequestBody) Adjust Loyalty Card Balance with campaign ID <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> This method adds or removes balance to an existing loyalty card that is assigned to a holder. The removal of points will consume the points that expire the soonest. <Warning> <Badge color yellow>Async Action</Badge> This is an async action. If you want to perform several add or remove loyalty card balance actions in a short time and their order matters, set up sufficient time-out between the calls. </Warning> ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_example"; // String | Unique campaign ID. let memberId = "memberId_example"; // String | A code that identifies the loyalty card. let loyaltiesMembersBalanceUpdateRequestBody = {"points":100,"expiration_type":"CUSTOM_DATE","expiration_date":"2023-05-30"}; // LoyaltiesMembersBalanceUpdateRequestBody | Specify the point adjustment along with the expiration mechanism. apiInstance.updateLoyaltyCardBalance1(campaignId, memberId, loyaltiesMembersBalanceUpdateRequestBody, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaignId** | **String**| Unique campaign ID. | **memberId** | **String**| A code that identifies the loyalty card. | **loyaltiesMembersBalanceUpdateRequestBody** | [**LoyaltiesMembersBalanceUpdateRequestBody**](LoyaltiesMembersBalanceUpdateRequestBody.md)| Specify the point adjustment along with the expiration mechanism. | ### Return type [**LoyaltiesMembersBalanceUpdateResponseBody**](LoyaltiesMembersBalanceUpdateResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## updateLoyaltyProgram > LoyaltiesUpdateCampaignResponseBody updateLoyaltyProgram(campaignId, loyaltiesUpdateCampaignRequestBody) Update Loyalty Campaign <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Updates a loyalty program. Fields other than those specified in the allowed request body payload wont be modified (even if provided they are silently skipped). Any parameters not provided will be left unchanged. This method will update the [loyalty cards](/api-reference/loyalties/get-member) which have not been published or redeemed yet. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_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. let loyaltiesUpdateCampaignRequestBody = {"description":"This is a campaign description. Updated","auto_join":false,"join_once":false,"start_date":"2013-10-26T00:00:00Z","expiration_date":"2025-10-26T00:00:00Z","validity_timeframe":{"duration":"PT2H","interval":"P2D"},"validity_day_of_week":[0,1,2,3,4,5,6],"activity_duration_after_publishing":"P25D","category_id":"cat_0b6152ce12414820dd","loyalty_card":{"points":1,"expiration_rules":{"period_type":"MONTH","period_value":4,"rounding_type":"END_OF_YEAR"}},"metadata":{"test":false},"type":"AUTO_UPDATE","loyalty_tiers_expiration":{"qualification_type":"BALANCE","start_date":{"type":"IMMEDIATE"},"expiration_date":{"type":"CUSTOM","extend":"P4M","rounding":{"type":"CUSTOM","unit":"MONTH","value":1}}}}; // LoyaltiesUpdateCampaignRequestBody | Specify the new values for the parameters that you would like to update for the given loyalty campaign. apiInstance.updateLoyaltyProgram(campaignId, loyaltiesUpdateCampaignRequestBody, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters 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. | **loyaltiesUpdateCampaignRequestBody** | [**LoyaltiesUpdateCampaignRequestBody**](LoyaltiesUpdateCampaignRequestBody.md)| Specify the new values for the parameters that you would like to update for the given loyalty campaign. | ### Return type [**LoyaltiesUpdateCampaignResponseBody**](LoyaltiesUpdateCampaignResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## updateRewardAssignment1 > LoyaltiesRewardsUpdateAssignmentResponseBody updateRewardAssignment1(campaignId, assignmentId, loyaltiesRewardsUpdateAssignmentRequestBody) Update Campaign Reward Assignment <Warning> <Badge color yellow>Legacy loyalty API</Badge> This endpoint belongs to the legacy loyalty API (/v1/loyalties). Voucherify will not develop new features for this API. However, critical issues may still receive fixes. For new integrations, use [Loyalty v2](/build/loyalty-overview). If you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support Contact Voucherify support). </Warning> Updates rewards parameters, i.e. the points cost for the specific reward. ### Example ```javascript import Voucherify from 'voucherify'; let defaultClient = Voucherify.ApiClient.instance; // Configure API key authorization: X-App-Id let X-App-Id = defaultClient.authentications['X-App-Id']; X-App-Id.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Id.apiKeyPrefix = 'Token'; // Configure API key authorization: X-App-Token let X-App-Token = defaultClient.authentications['X-App-Token']; X-App-Token.apiKey = 'YOUR API KEY'; // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //X-App-Token.apiKeyPrefix = 'Token'; // Configure OAuth2 access token for authorization: X-Voucherify-OAuth let X-Voucherify-OAuth = defaultClient.authentications['X-Voucherify-OAuth']; X-Voucherify-OAuth.accessToken = 'YOUR ACCESS TOKEN'; let apiInstance = new Voucherify.LoyaltiesApi(); let campaignId = "campaignId_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. let assignmentId = "assignmentId_example"; // String | A unique reward assignment ID. let loyaltiesRewardsUpdateAssignmentRequestBody = {"parameters":{"loyalty":{"points":3}}}; // LoyaltiesRewardsUpdateAssignmentRequestBody | Update the points cost for the reward assignment. apiInstance.updateRewardAssignment1(campaignId, assignmentId, loyaltiesRewardsUpdateAssignmentRequestBody, (error, data, response) => { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }); ``` ### Parameters 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. | **assignmentId** | **String**| A unique reward assignment ID. | **loyaltiesRewardsUpdateAssignmentRequestBody** | [**LoyaltiesRewardsUpdateAssignmentRequestBody**](LoyaltiesRewardsUpdateAssignmentRequestBody.md)| Update the points cost for the reward assignment. | ### Return type [**LoyaltiesRewardsUpdateAssignmentResponseBody**](LoyaltiesRewardsUpdateAssignmentResponseBody.md) ### Authorization [X-App-Id](../README.md#X-App-Id), [X-App-Token](../README.md#X-App-Token), [X-Voucherify-OAuth](../README.md#X-Voucherify-OAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json