Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
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 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 per page. 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_after parameter.
  • The response will contain a parameter named has_more. If the parameter's value is set to true, then more redeemables are available.
  • Get the value of the created_at parameter 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_after parameter set to the value taken from the created_at parameter from the last returned redeemable.
  • Voucherify will return the next page of redeemables.
  • If the has_more parameter is set to true, apply steps 3-5 to get the next page of redeemables.

Caching

Qualification has a 5-minute cache for the returned results. If you change your campaign settings or validation rules, the changes will apply to qualification results after the cache refreshes.

post/client/v1/qualifications

Request body

tracking_idstring

Is correspondent to Customer's source_id

scenario'ALL' | 'CUSTOMER_WALLET' | 'AUDIENCE_ONLY' | 'PRODUCTS' | 'PRODUCTS_DISCOUNT' | 'PROMOTION_STACKS' | 'PRODUCTS_BY_CUSTOMER' | 'PRODUCTS_DISCOUNT_BY_CUSTOMER'

Defines the scenario Voucherify should consider during the qualification process.

  • ALL - Scenario that returns all redeemables available for the customer in one API request. This scenario is used by default when no value is selected.
  • CUSTOMER_WALLET - returns vouchers applicable to the customer's cart based on the vouchers assigned to the customer's profile.
  • AUDIENCE_ONLY - returns all vouchers, promotion tiers, and campaigns available to the customer. Voucherify validates the rules based on the customer profile only.
  • PRODUCTS - returns all promotions available for the products (when a discount is defined to be applied to the item or when the item is required in the validation rule).
  • PRODUCTS_DISCOUNT - returns all promotions available for products when a discount is defined as applicable to specific item(s).
  • PROMOTION_STACKS - returns the applicable promotion stacks.
  • PRODUCTS_BY_CUSTOMER - returns all promotions available for a customer for the products (when a discount is defined to be applied to the item or when the item is required in the validation rule).
  • PRODUCTS_DISCOUNT_BY_CUSTOMER - returns all promotions available for a customer for products when a discount is defined as applicable to specific item(s).
metadataobject

A set of key/value pairs that you can send in the request body to check against redeemables requiring redemption metadata validation rules to be satisfied. The validation runs against rules that are defined through the Create Validation Rules endpoint or with the Validation Rule Builder in the the Dashboard.

Example request

{
  "options": {
    "starting_after": "2021-09-08T13:52:18.227Z"
  }
}

Response

Returns a qualifications object.

tracking_idstring

This identifier is generated during voucher qualification based on your internal id (e.g., email, database ID). This is a hashed customer source ID.