Documentation Index
Fetch the complete documentation index at: https://voucherify-pz-test2.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Client-side
Check Eligibility (client-side)
Generate a list of redeemables that are applicable in the context of the customer and order.
The new qualifications method is an improved version of Campaign Qualifications, Voucher Qualifications, and Promotions Validation API requests. The new qualification method introduces the following improvements:
- Qualification results are returned faster
- No limit on the number of returned redeemables
- Introduces new qualification scenarios, not available in the previous version
π Scenario Guide
Read our dedicated guide to learn about some use cases this endpoint can cover here.
Paging
The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables. To get the next batch of redeemables, you need to use the starting_after cursor.
To process of paging the redeemables works in the following manner:
- You send the first API request for Qualifications without the
starting_afterparameter. - The response will contain a parameter named
has_more. If the parameterβs value is set totrue, then more redeemables are available. - Get the value of the
created_atparameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables. - Send another API request for Qualification with the
starting_afterparameter set to the value taken from thecreated_atparameter from the last returned redeemable. - Voucherify will return the next page of redeemables.
- If the
has_moreparameter is set totrue, apply steps 3-5 to get the next page of redeemables.
