voucherify 8.1.0 → 8.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Dockerfile +1 -1
- data/ENDPOINTS-COVERAGE.md +55 -55
- data/Gemfile.lock +2 -2
- data/README.md +5 -0
- data/docs/CampaignsApi.md +7 -7
- data/docs/ClientSideApi.md +2 -2
- data/docs/CustomersApi.md +5 -5
- data/docs/ErrorError.md +1 -1
- data/docs/ExportParameters.md +2 -2
- data/docs/ExportsApi.md +6 -6
- data/docs/ExportsCreateRequestBodyParameters.md +2 -2
- data/docs/ExportsCreateResponseBodyParameters.md +2 -2
- data/docs/ExportsGetResponseBodyParameters.md +2 -2
- data/docs/LoyaltiesApi.md +52 -52
- data/docs/ManagementApi.md +26 -26
- data/docs/MetadataSchemasApi.md +2 -2
- data/docs/OrdersApi.md +2 -2
- data/docs/ProductCollectionsApi.md +1 -1
- data/docs/ProductsApi.md +4 -4
- data/docs/PublicationsApi.md +3 -3
- data/docs/QualificationsApi.md +1 -1
- data/docs/RedemptionRewardResultParametersCoin.md +1 -1
- data/docs/RedemptionsApi.md +3 -3
- data/docs/RedemptionsRedeemRequestBodyOptions.md +1 -0
- data/docs/ReferralsApi.md +4 -4
- data/docs/RewardsCreateRequestBodyParametersCoin.md +1 -1
- data/docs/RewardsUpdateRequestBodyParametersCoin.md +1 -1
- data/docs/SegmentsApi.md +1 -1
- data/docs/TemplatesApi.md +7 -7
- data/docs/ValidationRulesApi.md +2 -2
- data/docs/ValidationsValidateRequestBodyOptions.md +1 -0
- data/docs/VouchersApi.md +8 -8
- data/lib/VoucherifySdk/api/campaigns_api.rb +14 -14
- data/lib/VoucherifySdk/api/client_side_api.rb +4 -4
- data/lib/VoucherifySdk/api/customers_api.rb +10 -10
- data/lib/VoucherifySdk/api/exports_api.rb +8 -8
- data/lib/VoucherifySdk/api/loyalties_api.rb +104 -104
- data/lib/VoucherifySdk/api/management_api.rb +52 -52
- data/lib/VoucherifySdk/api/metadata_schemas_api.rb +4 -4
- data/lib/VoucherifySdk/api/orders_api.rb +4 -4
- data/lib/VoucherifySdk/api/product_collections_api.rb +2 -2
- data/lib/VoucherifySdk/api/products_api.rb +8 -8
- data/lib/VoucherifySdk/api/publications_api.rb +6 -6
- data/lib/VoucherifySdk/api/qualifications_api.rb +2 -2
- data/lib/VoucherifySdk/api/redemptions_api.rb +6 -6
- data/lib/VoucherifySdk/api/referrals_api.rb +8 -8
- data/lib/VoucherifySdk/api/segments_api.rb +2 -2
- data/lib/VoucherifySdk/api/templates_api.rb +14 -14
- data/lib/VoucherifySdk/api/validation_rules_api.rb +4 -4
- data/lib/VoucherifySdk/api/vouchers_api.rb +16 -16
- data/lib/VoucherifySdk/models/error_error.rb +2 -2
- data/lib/VoucherifySdk/models/export.rb +1 -1
- data/lib/VoucherifySdk/models/export_parameters.rb +3 -3
- data/lib/VoucherifySdk/models/exports_create_request_body.rb +1 -1
- data/lib/VoucherifySdk/models/exports_create_request_body_parameters.rb +3 -3
- data/lib/VoucherifySdk/models/exports_create_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/exports_create_response_body_parameters.rb +3 -3
- data/lib/VoucherifySdk/models/exports_get_response_body.rb +1 -1
- data/lib/VoucherifySdk/models/exports_get_response_body_parameters.rb +3 -3
- data/lib/VoucherifySdk/models/redemption_reward_result_parameters_coin.rb +1 -1
- data/lib/VoucherifySdk/models/redemptions_redeem_request_body_options.rb +28 -6
- data/lib/VoucherifySdk/models/rewards_create_request_body_parameters_coin.rb +1 -1
- data/lib/VoucherifySdk/models/rewards_update_request_body_parameters_coin.rb +1 -1
- data/lib/VoucherifySdk/models/validations_redeemable_skipped_result_details.rb +1 -1
- data/lib/VoucherifySdk/models/validations_validate_request_body_options.rb +28 -6
- data/lib/VoucherifySdk/version.rb +1 -1
- metadata +32 -32
data/docs/LoyaltiesApi.md
CHANGED
|
@@ -64,7 +64,7 @@ All URIs are relative to *https://api.voucherify.io*
|
|
|
64
64
|
|
|
65
65
|
Activate Member Pending Points
|
|
66
66
|
|
|
67
|
-
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.
|
|
67
|
+
<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>
|
|
68
68
|
|
|
69
69
|
### Examples
|
|
70
70
|
|
|
@@ -124,7 +124,7 @@ end
|
|
|
124
124
|
|
|
125
125
|
Add Member
|
|
126
126
|
|
|
127
|
-
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.
|
|
127
|
+
<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>
|
|
128
128
|
|
|
129
129
|
### Examples
|
|
130
130
|
|
|
@@ -186,7 +186,7 @@ end
|
|
|
186
186
|
|
|
187
187
|
Adjust Member Pending Points
|
|
188
188
|
|
|
189
|
-
Adjusts the pending points with a given ID. You can add or subtract the number of points.
|
|
189
|
+
<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>
|
|
190
190
|
|
|
191
191
|
### Examples
|
|
192
192
|
|
|
@@ -250,7 +250,7 @@ end
|
|
|
250
250
|
|
|
251
251
|
Cancel Member Pending Points
|
|
252
252
|
|
|
253
|
-
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.
|
|
253
|
+
<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>
|
|
254
254
|
|
|
255
255
|
### Examples
|
|
256
256
|
|
|
@@ -309,7 +309,7 @@ nil (empty response body)
|
|
|
309
309
|
|
|
310
310
|
Create Earning Rule
|
|
311
311
|
|
|
312
|
-
Create earning rules for a loyalty campaign.
|
|
312
|
+
<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>
|
|
313
313
|
|
|
314
314
|
### Examples
|
|
315
315
|
|
|
@@ -371,7 +371,7 @@ end
|
|
|
371
371
|
|
|
372
372
|
Create loyalty tiers
|
|
373
373
|
|
|
374
|
-
Creates loyalty tiers for desired campaign.
|
|
374
|
+
<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.
|
|
375
375
|
|
|
376
376
|
### Examples
|
|
377
377
|
|
|
@@ -433,7 +433,7 @@ end
|
|
|
433
433
|
|
|
434
434
|
Create Loyalty Campaign
|
|
435
435
|
|
|
436
|
-
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.
|
|
436
|
+
<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>
|
|
437
437
|
|
|
438
438
|
### Examples
|
|
439
439
|
|
|
@@ -493,7 +493,7 @@ end
|
|
|
493
493
|
|
|
494
494
|
Export Loyalty Campaign Point Expiration
|
|
495
495
|
|
|
496
|
-
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.
|
|
496
|
+
<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.
|
|
497
497
|
|
|
498
498
|
### Examples
|
|
499
499
|
|
|
@@ -555,7 +555,7 @@ end
|
|
|
555
555
|
|
|
556
556
|
Create Loyalty Campaign Reward Assignment
|
|
557
557
|
|
|
558
|
-
Add rewards to a loyalty campaign.
|
|
558
|
+
<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.
|
|
559
559
|
|
|
560
560
|
### Examples
|
|
561
561
|
|
|
@@ -617,7 +617,7 @@ end
|
|
|
617
617
|
|
|
618
618
|
Delete Earning Rule
|
|
619
619
|
|
|
620
|
-
This method deletes an earning rule for a specific loyalty campaign.
|
|
620
|
+
<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.
|
|
621
621
|
|
|
622
622
|
### Examples
|
|
623
623
|
|
|
@@ -676,7 +676,7 @@ nil (empty response body)
|
|
|
676
676
|
|
|
677
677
|
Delete Loyalty Campaign
|
|
678
678
|
|
|
679
|
-
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).
|
|
679
|
+
<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).
|
|
680
680
|
|
|
681
681
|
### Examples
|
|
682
682
|
|
|
@@ -738,7 +738,7 @@ end
|
|
|
738
738
|
|
|
739
739
|
Delete Campaign Reward Assignment
|
|
740
740
|
|
|
741
|
-
This method deletes a reward assignment for a particular loyalty campaign.
|
|
741
|
+
<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.
|
|
742
742
|
|
|
743
743
|
### Examples
|
|
744
744
|
|
|
@@ -797,7 +797,7 @@ nil (empty response body)
|
|
|
797
797
|
|
|
798
798
|
Disable Earning Rule
|
|
799
799
|
|
|
800
|
-
Disable an earning rule.
|
|
800
|
+
<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.
|
|
801
801
|
|
|
802
802
|
### Examples
|
|
803
803
|
|
|
@@ -857,7 +857,7 @@ end
|
|
|
857
857
|
|
|
858
858
|
Enable Earning Rule
|
|
859
859
|
|
|
860
|
-
Enable an earning rule.
|
|
860
|
+
<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.
|
|
861
861
|
|
|
862
862
|
### Examples
|
|
863
863
|
|
|
@@ -917,7 +917,7 @@ end
|
|
|
917
917
|
|
|
918
918
|
Export Loyalty Campaign Transactions
|
|
919
919
|
|
|
920
|
-
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:
|
|
920
|
+
<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>
|
|
921
921
|
|
|
922
922
|
### Examples
|
|
923
923
|
|
|
@@ -979,7 +979,7 @@ end
|
|
|
979
979
|
|
|
980
980
|
Export Loyalty Card Transactions
|
|
981
981
|
|
|
982
|
-
Export transactions that are associated with point movements on a loyalty card.
|
|
982
|
+
<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.
|
|
983
983
|
|
|
984
984
|
### Examples
|
|
985
985
|
|
|
@@ -1041,7 +1041,7 @@ end
|
|
|
1041
1041
|
|
|
1042
1042
|
Export Loyalty Card Transactions with campaign ID
|
|
1043
1043
|
|
|
1044
|
-
Export transactions that are associated with point movements on a loyalty card.
|
|
1044
|
+
<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.
|
|
1045
1045
|
|
|
1046
1046
|
### Examples
|
|
1047
1047
|
|
|
@@ -1105,7 +1105,7 @@ end
|
|
|
1105
1105
|
|
|
1106
1106
|
Get Earning Rule
|
|
1107
1107
|
|
|
1108
|
-
Retrieves an earning rule assigned to a campaign.
|
|
1108
|
+
<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.
|
|
1109
1109
|
|
|
1110
1110
|
### Examples
|
|
1111
1111
|
|
|
@@ -1165,7 +1165,7 @@ end
|
|
|
1165
1165
|
|
|
1166
1166
|
Get Loyalty Campaign
|
|
1167
1167
|
|
|
1168
|
-
Retrieve a specific loyalty campaign.
|
|
1168
|
+
<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.
|
|
1169
1169
|
|
|
1170
1170
|
### Examples
|
|
1171
1171
|
|
|
@@ -1223,7 +1223,7 @@ end
|
|
|
1223
1223
|
|
|
1224
1224
|
Get Loyalty Tier
|
|
1225
1225
|
|
|
1226
|
-
Retrieve a loyalty tier from a loyalty campaign by the loyalty tier ID.
|
|
1226
|
+
<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.
|
|
1227
1227
|
|
|
1228
1228
|
### Examples
|
|
1229
1229
|
|
|
@@ -1283,7 +1283,7 @@ end
|
|
|
1283
1283
|
|
|
1284
1284
|
Get Member
|
|
1285
1285
|
|
|
1286
|
-
Retrieve loyalty card with the given member ID (i.e. voucher code).
|
|
1286
|
+
<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>
|
|
1287
1287
|
|
|
1288
1288
|
### Examples
|
|
1289
1289
|
|
|
@@ -1341,7 +1341,7 @@ end
|
|
|
1341
1341
|
|
|
1342
1342
|
Get Member with campaign ID
|
|
1343
1343
|
|
|
1344
|
-
Retrieves the loyalty card with the given member ID (i.e. voucher code).
|
|
1344
|
+
<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).
|
|
1345
1345
|
|
|
1346
1346
|
### Examples
|
|
1347
1347
|
|
|
@@ -1401,7 +1401,7 @@ end
|
|
|
1401
1401
|
|
|
1402
1402
|
Get Campaign Reward Assignments
|
|
1403
1403
|
|
|
1404
|
-
Retrieve specific reward assignment.
|
|
1404
|
+
<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.
|
|
1405
1405
|
|
|
1406
1406
|
### Examples
|
|
1407
1407
|
|
|
@@ -1461,7 +1461,7 @@ end
|
|
|
1461
1461
|
|
|
1462
1462
|
Get Campaign Reward Assignment
|
|
1463
1463
|
|
|
1464
|
-
Retrieve specific reward assignment.
|
|
1464
|
+
<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>
|
|
1465
1465
|
|
|
1466
1466
|
### Examples
|
|
1467
1467
|
|
|
@@ -1521,7 +1521,7 @@ end
|
|
|
1521
1521
|
|
|
1522
1522
|
Get Reward Details
|
|
1523
1523
|
|
|
1524
|
-
Get reward details in the context of a loyalty campaign and reward assignment ID.
|
|
1524
|
+
<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.
|
|
1525
1525
|
|
|
1526
1526
|
### Examples
|
|
1527
1527
|
|
|
@@ -1581,7 +1581,7 @@ end
|
|
|
1581
1581
|
|
|
1582
1582
|
List Campaign Pending Points
|
|
1583
1583
|
|
|
1584
|
-
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.
|
|
1584
|
+
<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>
|
|
1585
1585
|
|
|
1586
1586
|
### Examples
|
|
1587
1587
|
|
|
@@ -1647,7 +1647,7 @@ end
|
|
|
1647
1647
|
|
|
1648
1648
|
List Earning Rules
|
|
1649
1649
|
|
|
1650
|
-
Returns a list of all earning rules within a given campaign.
|
|
1650
|
+
<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.
|
|
1651
1651
|
|
|
1652
1652
|
### Examples
|
|
1653
1653
|
|
|
@@ -1713,7 +1713,7 @@ end
|
|
|
1713
1713
|
|
|
1714
1714
|
List Loyalty Campaign Transactions
|
|
1715
1715
|
|
|
1716
|
-
Retrieves all transactions for the campaign with the given campaign ID or campaign name.
|
|
1716
|
+
<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.
|
|
1717
1717
|
|
|
1718
1718
|
### Examples
|
|
1719
1719
|
|
|
@@ -1781,7 +1781,7 @@ end
|
|
|
1781
1781
|
|
|
1782
1782
|
List Loyalty Card Transactions
|
|
1783
1783
|
|
|
1784
|
-
Retrieve transaction data related to point movements for a specific loyalty card.
|
|
1784
|
+
<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.
|
|
1785
1785
|
|
|
1786
1786
|
### Examples
|
|
1787
1787
|
|
|
@@ -1847,7 +1847,7 @@ end
|
|
|
1847
1847
|
|
|
1848
1848
|
List Loyalty Card Transactions with campaign ID
|
|
1849
1849
|
|
|
1850
|
-
Retrieve transaction data related to point movements for a specific loyalty card.
|
|
1850
|
+
<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.
|
|
1851
1851
|
|
|
1852
1852
|
### Examples
|
|
1853
1853
|
|
|
@@ -1915,7 +1915,7 @@ end
|
|
|
1915
1915
|
|
|
1916
1916
|
List Loyalty Campaigns
|
|
1917
1917
|
|
|
1918
|
-
Returns a list of your loyalty campaigns.
|
|
1918
|
+
<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.
|
|
1919
1919
|
|
|
1920
1920
|
### Examples
|
|
1921
1921
|
|
|
@@ -1979,7 +1979,7 @@ end
|
|
|
1979
1979
|
|
|
1980
1980
|
List Loyalty Tier Earning Rules
|
|
1981
1981
|
|
|
1982
|
-
Retrieve available earning rules for a given tier and the calculation method for earning points.
|
|
1982
|
+
<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.
|
|
1983
1983
|
|
|
1984
1984
|
### Examples
|
|
1985
1985
|
|
|
@@ -2045,7 +2045,7 @@ end
|
|
|
2045
2045
|
|
|
2046
2046
|
List Loyalty Tier Rewards
|
|
2047
2047
|
|
|
2048
|
-
Get available rewards for a given tier.
|
|
2048
|
+
<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.
|
|
2049
2049
|
|
|
2050
2050
|
### Examples
|
|
2051
2051
|
|
|
@@ -2105,7 +2105,7 @@ end
|
|
|
2105
2105
|
|
|
2106
2106
|
List Loyalty Tiers
|
|
2107
2107
|
|
|
2108
|
-
Retrieve a list of loyalty tiers which were added to the loyalty program.
|
|
2108
|
+
<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.
|
|
2109
2109
|
|
|
2110
2110
|
### Examples
|
|
2111
2111
|
|
|
@@ -2169,7 +2169,7 @@ end
|
|
|
2169
2169
|
|
|
2170
2170
|
List Member Activity
|
|
2171
2171
|
|
|
2172
|
-
|
|
2172
|
+
<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.
|
|
2173
2173
|
|
|
2174
2174
|
### Examples
|
|
2175
2175
|
|
|
@@ -2235,7 +2235,7 @@ end
|
|
|
2235
2235
|
|
|
2236
2236
|
List Member Activity with campaign ID
|
|
2237
2237
|
|
|
2238
|
-
Retrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.
|
|
2238
|
+
<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.
|
|
2239
2239
|
|
|
2240
2240
|
### Examples
|
|
2241
2241
|
|
|
@@ -2303,7 +2303,7 @@ end
|
|
|
2303
2303
|
|
|
2304
2304
|
List Member's Loyalty Tiers
|
|
2305
2305
|
|
|
2306
|
-
Retrieve member tiers using the loyalty card ID.
|
|
2306
|
+
<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.
|
|
2307
2307
|
|
|
2308
2308
|
### Examples
|
|
2309
2309
|
|
|
@@ -2361,7 +2361,7 @@ end
|
|
|
2361
2361
|
|
|
2362
2362
|
List Member Pending Points
|
|
2363
2363
|
|
|
2364
|
-
|
|
2364
|
+
<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>
|
|
2365
2365
|
|
|
2366
2366
|
### Examples
|
|
2367
2367
|
|
|
@@ -2427,7 +2427,7 @@ end
|
|
|
2427
2427
|
|
|
2428
2428
|
List Member Pending Points with campaign ID
|
|
2429
2429
|
|
|
2430
|
-
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.
|
|
2430
|
+
<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>
|
|
2431
2431
|
|
|
2432
2432
|
### Examples
|
|
2433
2433
|
|
|
@@ -2495,7 +2495,7 @@ end
|
|
|
2495
2495
|
|
|
2496
2496
|
List Member Rewards
|
|
2497
2497
|
|
|
2498
|
-
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.
|
|
2498
|
+
<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.
|
|
2499
2499
|
|
|
2500
2500
|
### Examples
|
|
2501
2501
|
|
|
@@ -2557,7 +2557,7 @@ end
|
|
|
2557
2557
|
|
|
2558
2558
|
List Members
|
|
2559
2559
|
|
|
2560
|
-
Returns a list of your loyalty cards. The loyalty cards are sorted by creation date, with the most recent loyalty cards appearing first.
|
|
2560
|
+
<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.
|
|
2561
2561
|
|
|
2562
2562
|
### Examples
|
|
2563
2563
|
|
|
@@ -2633,7 +2633,7 @@ end
|
|
|
2633
2633
|
|
|
2634
2634
|
List Loyalty Card Point Expiration
|
|
2635
2635
|
|
|
2636
|
-
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.
|
|
2636
|
+
<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.
|
|
2637
2637
|
|
|
2638
2638
|
### Examples
|
|
2639
2639
|
|
|
@@ -2699,7 +2699,7 @@ end
|
|
|
2699
2699
|
|
|
2700
2700
|
List Reward Assignments with campaign ID
|
|
2701
2701
|
|
|
2702
|
-
Returns reward assignments from a given loyalty campaign.
|
|
2702
|
+
<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>
|
|
2703
2703
|
|
|
2704
2704
|
### Examples
|
|
2705
2705
|
|
|
@@ -2765,7 +2765,7 @@ end
|
|
|
2765
2765
|
|
|
2766
2766
|
List Campaign Rewards
|
|
2767
2767
|
|
|
2768
|
-
Returns active rewards from a given loyalty campaign.
|
|
2768
|
+
<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.
|
|
2769
2769
|
|
|
2770
2770
|
### Examples
|
|
2771
2771
|
|
|
@@ -2831,7 +2831,7 @@ end
|
|
|
2831
2831
|
|
|
2832
2832
|
Redeem Reward
|
|
2833
2833
|
|
|
2834
|
-
|
|
2834
|
+
<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>
|
|
2835
2835
|
|
|
2836
2836
|
### Examples
|
|
2837
2837
|
|
|
@@ -2893,7 +2893,7 @@ end
|
|
|
2893
2893
|
|
|
2894
2894
|
Redeem Reward with campaign ID
|
|
2895
2895
|
|
|
2896
|
-
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.
|
|
2896
|
+
<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.
|
|
2897
2897
|
|
|
2898
2898
|
### Examples
|
|
2899
2899
|
|
|
@@ -2957,7 +2957,7 @@ end
|
|
|
2957
2957
|
|
|
2958
2958
|
Transfer Loyalty Points
|
|
2959
2959
|
|
|
2960
|
-
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.
|
|
2960
|
+
<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.
|
|
2961
2961
|
|
|
2962
2962
|
### Examples
|
|
2963
2963
|
|
|
@@ -3021,7 +3021,7 @@ end
|
|
|
3021
3021
|
|
|
3022
3022
|
Update Earning Rule
|
|
3023
3023
|
|
|
3024
|
-
Update an earning rule definition.
|
|
3024
|
+
<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.
|
|
3025
3025
|
|
|
3026
3026
|
### Examples
|
|
3027
3027
|
|
|
@@ -3085,7 +3085,7 @@ end
|
|
|
3085
3085
|
|
|
3086
3086
|
Adjust Loyalty Card Balance
|
|
3087
3087
|
|
|
3088
|
-
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.
|
|
3088
|
+
<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>
|
|
3089
3089
|
|
|
3090
3090
|
### Examples
|
|
3091
3091
|
|
|
@@ -3147,7 +3147,7 @@ end
|
|
|
3147
3147
|
|
|
3148
3148
|
Adjust Loyalty Card Balance with campaign ID
|
|
3149
3149
|
|
|
3150
|
-
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.
|
|
3150
|
+
<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>
|
|
3151
3151
|
|
|
3152
3152
|
### Examples
|
|
3153
3153
|
|
|
@@ -3211,7 +3211,7 @@ end
|
|
|
3211
3211
|
|
|
3212
3212
|
Update Loyalty Campaign
|
|
3213
3213
|
|
|
3214
|
-
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.
|
|
3214
|
+
<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.
|
|
3215
3215
|
|
|
3216
3216
|
### Examples
|
|
3217
3217
|
|
|
@@ -3273,7 +3273,7 @@ end
|
|
|
3273
3273
|
|
|
3274
3274
|
Update Campaign Reward Assignment
|
|
3275
3275
|
|
|
3276
|
-
Updates rewards parameters, i.e. the points cost for the specific reward.
|
|
3276
|
+
<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.
|
|
3277
3277
|
|
|
3278
3278
|
### Examples
|
|
3279
3279
|
|