Skip to main content
POST
/
v1
/
qualifications
Check Eligibility
curl --request POST \
  --url https://{cluster}.voucherify.io/v1/qualifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '{
  "scenario": "ALL",
  "options": {
    "limit": 10,
    "expand": [
      "redeemable"
    ],
    "sorting_rule": "DEFAULT"
  }
}'
{
  "redeemables": {
    "object": "list",
    "data_ref": "data",
    "data": [
      {
        "id": "BUNDLE-PROD-1c",
        "object": "voucher",
        "created_at": "2025-03-26T11:00:17.987Z",
        "result": {
          "discount": {
            "type": "AMOUNT",
            "effect": "APPLY_TO_ITEMS",
            "amount_off": 900,
            "aggregated_amount_limit": 9000,
            "is_dynamic": false
          },
          "bundle": {
            "quantity": 0,
            "identified": [
              {
                "id": "prod_0fc35dfe978defeb6b",
                "object": "product",
                "item_index": 0,
                "item_quantity": 1
              },
              {
                "id": "prod_0fc35dfeaa0defeb73",
                "object": "product",
                "item_index": 1,
                "item_quantity": 1
              },
              {
                "id": "prod_0fc35dfeabcdefeb80",
                "object": "product",
                "item_index": 2,
                "item_quantity": 2
              }
            ],
            "missing": [
              {
                "id": "prod_0fc35dfe978defeb6b",
                "object": "product",
                "item_quantity": 1
              },
              {
                "id": "pc_pWu3TzRFhJ99Xak7Z7QlynNa",
                "object": "products_collection",
                "item_quantity": 2
              }
            ]
          }
        },
        "order": {
          "amount": 5496,
          "total_amount": 5496,
          "items": [
            {
              "object": "order_item",
              "id": "ordli_105e1f56dc0bc19187",
              "quantity": 1,
              "initial_quantity": 1,
              "amount": 2499,
              "initial_amount": 2499,
              "price": 2499,
              "subtotal_amount": 2499,
              "product": {
                "id": "prod_0fc35dfe978defeb6b",
                "source_id": "star-th-bottle",
                "name": "Star Thermal Bottle",
                "metadata": {
                  "brand": "Star"
                },
                "price": 2499
              }
            },
            {
              "object": "order_item",
              "id": "ordli_105e1f56dc0bc19188",
              "quantity": 1,
              "initial_quantity": 1,
              "amount": 1999,
              "initial_amount": 1999,
              "price": 1999,
              "subtotal_amount": 1999,
              "product": {
                "id": "prod_0fc35dfeaa0defeb73",
                "source_id": "adv-tshirt",
                "name": "Adventure T-shirt",
                "metadata": {
                  "brand": "Adventure"
                },
                "price": 1999
              }
            },
            {
              "object": "order_item",
              "id": "ordli_105e1f56dc0bc19189",
              "quantity": 2,
              "initial_quantity": 2,
              "amount": 998,
              "initial_amount": 998,
              "price": 499,
              "subtotal_amount": 998,
              "product": {
                "id": "prod_0fc35dfeabcdefeb80",
                "source_id": "adv-scks",
                "name": "Adventure Socks",
                "metadata": {
                  "brand": "Adventure"
                },
                "price": 499
              }
            }
          ],
          "customer_id": null,
          "referrer_id": null,
          "object": "order"
        },
        "applicable_to": {
          "data": [
            {
              "object": "products_collection",
              "id": "pc_nw1xRgXB8cBzDJSrSbdSqJP4",
              "effect": "APPLY_TO_EVERY",
              "skip_initially": 0,
              "repeat": 1,
              "target": "ITEM"
            }
          ],
          "total": 1,
          "data_ref": "data",
          "object": "list"
        },
        "inapplicable_to": {
          "data": [],
          "total": 0,
          "data_ref": "data",
          "object": "list"
        },
        "metadata": {},
        "campaign_id": "camp_vzuF8JZdh1tdQqw3R6rS63ci",
        "campaign_name": "Bundle-Product-Discount",
        "validation_rules_assignments": {
          "object": "list",
          "data_ref": "data",
          "data": [
            {
              "id": "asgm_e9RsrtXBMCJ5ti1S",
              "rule_id": "val_g1rAIcaPuxAd",
              "related_object_id": "v_XXSJVTBFFKLPiy585UqtTPiYJMF1bnBW",
              "related_object_type": "voucher",
              "object": "validation_rules_assignment",
              "validation_status": "VALID"
            }
          ],
          "total": 1
        }
      }
    ],
    "total": 1,
    "has_more": true,
    "more_starting_after": "2025-03-26T11:00:17.987Z"
  },
  "tracking_id": "track_C7TLT9aBmso=",
  "order": {
    "items": [
      {
        "object": "order_item",
        "id": "ordli_105e1f56dc0bc19187",
        "quantity": 1,
        "product": {
          "id": "prod_0fc35dfe978defeb6b",
          "source_id": "star-th-bottle",
          "name": "Star Thermal Bottle",
          "metadata": {
            "brand": "Star"
          },
          "price": 2499
        }
      },
      {
        "object": "order_item",
        "id": "ordli_105e1f56dc0bc19188",
        "quantity": 1,
        "product": {
          "id": "prod_0fc35dfeaa0defeb73",
          "source_id": "adv-tshirt",
          "name": "Adventure T-shirt",
          "metadata": {
            "brand": "Adventure"
          },
          "price": 1999
        }
      },
      {
        "object": "order_item",
        "id": "ordli_105e1f56dc0bc19189",
        "quantity": 2,
        "product": {
          "id": "prod_0fc35dfeabcdefeb80",
          "source_id": "adv-scks",
          "name": "Adventure Socks",
          "metadata": {
            "brand": "Adventure"
          },
          "price": 499
        }
      }
    ],
    "customer_id": null,
    "referrer_id": null,
    "object": "order"
  },
  "stacking_rules": {
    "redeemables_limit": 30,
    "applicable_redeemables_limit": 5,
    "applicable_exclusive_redeemables_limit": 1,
    "exclusive_categories": [],
    "joint_categories": [],
    "redeemables_application_mode": "PARTIAL",
    "redeemables_sorting_rule": "REQUESTED_ORDER",
    "redeemables_no_effect_rule": "REDEEM_ANYWAY",
    "redeemables_products_application_mode": "STACK",
    "redeemables_rollback_order_mode": "WITH_ORDER"
  }
}

Authorizations

X-App-Id
string
header
required
X-App-Token
string
header
required
Authorization
string
header
required

Body

application/json
customer
object
order
object
tracking_id
string
scenario
enum<string>
Available options:
ALL,
CUSTOMER_WALLET,
AUDIENCE_ONLY,
PRODUCTS,
PRODUCTS_DISCOUNT,
PROMOTION_STACKS,
PRODUCTS_BY_CUSTOMER,
PRODUCTS_DISCOUNT_BY_CUSTOMER
options
object
session
object
metadata
object

Response

200 - application/json
redeemables
object
tracking_id
string
order
object
stacking_rules
object