Skip to main content
POST
/
client
/
v1
/
qualifications
Check Eligibility (client-side)
curl --request POST \
  --url https://{cluster}.voucherify.io/client/v1/qualifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Application-Id: <api-key>' \
  --header 'X-Client-Token: <api-key>' \
  --data '{
  "customer": {
    "id": "<string>",
    "source_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "birthday": "2023-12-25",
    "birthdate": "2023-12-25",
    "address": {
      "city": "<string>",
      "state": "<string>",
      "line_1": "<string>",
      "line_2": "<string>",
      "country": "<string>",
      "postal_code": "<string>"
    },
    "metadata": {}
  },
  "order": {
    "id": "<string>",
    "source_id": "<string>",
    "status": "CREATED",
    "amount": 123,
    "initial_amount": 123,
    "discount_amount": 123,
    "items": [
      {
        "sku_id": "<string>",
        "product_id": "<string>",
        "related_object": "product",
        "source_id": "<string>",
        "quantity": 123,
        "discount_quantity": 123,
        "initial_quantity": 123,
        "amount": 123,
        "discount_amount": 123,
        "initial_amount": 123,
        "price": 123,
        "product": {
          "id": "<string>",
          "source_id": "<string>",
          "override": true,
          "name": "<string>",
          "metadata": {},
          "price": 123
        },
        "sku": {
          "id": "<string>",
          "source_id": "<string>",
          "override": true,
          "sku": "<string>",
          "price": 123,
          "metadata": {}
        },
        "metadata": {}
      }
    ],
    "metadata": {}
  },
  "tracking_id": "<string>",
  "scenario": "ALL",
  "options": {
    "limit": 49,
    "starting_after": "2021-09-08T13:52:18.227Z",
    "filters": {
      "junction": "and",
      "category_id": {
        "conditions": {
          "$is": [
            "<string>"
          ],
          "$is_not": [
            "<string>"
          ],
          "$has_value": [
            "<string>"
          ],
          "$is_unknown": [
            "<string>"
          ],
          "$in": [
            "<string>"
          ],
          "$not_in": [
            "<string>"
          ]
        }
      },
      "campaign_id": {
        "conditions": {
          "$is": [
            "<string>"
          ],
          "$is_not": [
            "<string>"
          ],
          "$has_value": [
            "<string>"
          ],
          "$is_unknown": [
            "<string>"
          ],
          "$in": [
            "<string>"
          ],
          "$not_in": [
            "<string>"
          ]
        }
      },
      "campaign_type": {
        "conditions": {
          "$is": [
            "PROMOTION"
          ],
          "$is_not": [
            "PROMOTION"
          ],
          "$in": [
            "PROMOTION"
          ],
          "$not_in": [
            "PROMOTION"
          ]
        }
      },
      "resource_id": {
        "conditions": {
          "$is": [
            "<string>"
          ],
          "$is_not": [
            "<string>"
          ],
          "$has_value": [
            "<string>"
          ],
          "$is_unknown": [
            "<string>"
          ],
          "$in": [
            "<string>"
          ],
          "$not_in": [
            "<string>"
          ]
        }
      },
      "resource_type": {
        "conditions": {
          "$is": [
            "campaign"
          ],
          "$is_not": [
            "campaign"
          ],
          "$in": [
            "campaign"
          ],
          "$not_in": [
            "campaign"
          ]
        }
      },
      "voucher_type": {
        "conditions": {
          "$is": [
            "<string>"
          ],
          "$is_not": [
            "<string>"
          ],
          "$has_value": [
            "<string>"
          ],
          "$is_unknown": [
            "<string>"
          ],
          "$in": [
            "<string>"
          ],
          "$not_in": [
            "<string>"
          ]
        }
      },
      "code": {
        "conditions": {
          "$is": [
            "<string>"
          ],
          "$is_not": [
            "<string>"
          ],
          "$has_value": [
            "<string>"
          ],
          "$is_unknown": [
            "<string>"
          ],
          "$in": [
            "<string>"
          ],
          "$not_in": [
            "<string>"
          ]
        }
      },
      "holder_role": {
        "conditions": {
          "$is": [
            "OWNER"
          ],
          "$is_not": [
            "OWNER"
          ],
          "$in": [
            "OWNER"
          ],
          "$not_in": [
            "OWNER"
          ]
        }
      }
    },
    "expand": [
      "redeemable"
    ],
    "sorting_rule": "BEST_DEAL"
  },
  "session": {
    "type": "LOCK"
  },
  "metadata": {}
}'
{
  "redeemables": {
    "object": "list",
    "data_ref": "data",
    "data": [
      {
        "id": "<string>",
        "object": "campaign",
        "created_at": "2022-03-09T11:19:04.819Z",
        "result": {
          "discount": {
            "type": "<any>",
            "amount_off": "<any>",
            "amount_off_formula": "<any>",
            "aggregated_amount_limit": "<any>",
            "effect": "<any>",
            "is_dynamic": "<any>"
          },
          "bundle": {
            "quantity": "<any>",
            "limit": "<any>",
            "identified": "<any>",
            "missing": "<any>"
          },
          "gift": {
            "balance": "<any>",
            "credits": "<any>",
            "locked_credits": "<any>"
          },
          "loyalty_card": {
            "points": "<any>",
            "balance": "<any>",
            "exchange_ratio": "<any>",
            "points_ratio": "<any>",
            "transfers": "<any>"
          },
          "error": {
            "code": "<any>",
            "key": "<any>",
            "message": "<any>",
            "details": "<any>",
            "request_id": "<any>",
            "resource_id": "<any>",
            "resource_type": "<any>",
            "error": "<any>"
          }
        },
        "order": {
          "id": "<string>",
          "source_id": "<string>",
          "status": "CREATED",
          "amount": 123,
          "initial_amount": 123,
          "discount_amount": 123,
          "items_discount_amount": 123,
          "total_discount_amount": 123,
          "total_amount": 123,
          "applied_discount_amount": 123,
          "items_applied_discount_amount": 123,
          "total_applied_discount_amount": 123,
          "metadata": {},
          "object": "order",
          "created_at": "2021-12-22T10:13:06.487Z",
          "updated_at": "2021-12-22T10:14:45.316Z",
          "customer_id": "cust_7iUa6ICKyU6gH40dBU25kQU1",
          "referrer_id": "cust_nM4jqPiaXUvQdVSA6vTRUnix",
          "customer": {
            "id": "<any>",
            "object": "<any>"
          },
          "referrer": {
            "id": "<any>",
            "object": "<any>"
          },
          "redemptions": {},
          "items": [
            "<any>"
          ]
        },
        "validation_rule_id": "<string>",
        "applicable_to": {
          "data": [
            "<any>"
          ],
          "total": 1,
          "object": "list",
          "data_ref": "data"
        },
        "inapplicable_to": {
          "data": [
            "<any>"
          ],
          "total": 1,
          "object": "list",
          "data_ref": "data"
        },
        "metadata": {},
        "categories": [
          {
            "id": "<any>",
            "name": "<any>",
            "hierarchy": "<any>",
            "object": "<any>",
            "created_at": "<any>",
            "updated_at": "<any>",
            "stacking_rules_type": "<any>"
          }
        ],
        "banner": "Order Paid - You will get 100 points",
        "name": "promotion_tier_get_points",
        "campaign_name": "PromotionCampaign",
        "campaign_id": "camp_Mow7u4gSxagLlZ2oDQ01ZS5N",
        "validation_rules_assignments": {
          "object": "list",
          "data_ref": "data",
          "data": [
            "<any>"
          ],
          "total": 1
        },
        "redeemables": [
          {
            "id": "<string>",
            "object": "campaign",
            "created_at": "2022-03-09T11:19:04.819Z",
            "result": {
              "discount": {
                "type": "<any>",
                "amount_off": "<any>",
                "amount_off_formula": "<any>",
                "aggregated_amount_limit": "<any>",
                "effect": "<any>",
                "is_dynamic": "<any>"
              },
              "bundle": {
                "quantity": "<any>",
                "limit": "<any>",
                "identified": "<any>",
                "missing": "<any>"
              },
              "gift": {
                "balance": "<any>",
                "credits": "<any>",
                "locked_credits": "<any>"
              },
              "loyalty_card": {
                "points": "<any>",
                "balance": "<any>",
                "exchange_ratio": "<any>",
                "points_ratio": "<any>",
                "transfers": "<any>"
              },
              "error": {
                "code": "<any>",
                "key": "<any>",
                "message": "<any>",
                "details": "<any>",
                "request_id": "<any>",
                "resource_id": "<any>",
                "resource_type": "<any>",
                "error": "<any>"
              }
            },
            "order": {
              "id": "<string>",
              "source_id": "<string>",
              "status": "CREATED",
              "amount": 123,
              "initial_amount": 123,
              "discount_amount": 123,
              "items_discount_amount": 123,
              "total_discount_amount": 123,
              "total_amount": 123,
              "applied_discount_amount": 123,
              "items_applied_discount_amount": 123,
              "total_applied_discount_amount": 123,
              "metadata": {},
              "object": "order",
              "created_at": "2021-12-22T10:13:06.487Z",
              "updated_at": "2021-12-22T10:14:45.316Z",
              "customer_id": "cust_7iUa6ICKyU6gH40dBU25kQU1",
              "referrer_id": "cust_nM4jqPiaXUvQdVSA6vTRUnix",
              "customer": {
                "id": "<any>",
                "object": "<any>"
              },
              "referrer": {
                "id": "<any>",
                "object": "<any>"
              },
              "redemptions": {},
              "items": [
                "<any>"
              ]
            },
            "validation_rule_id": "<string>",
            "applicable_to": {
              "data": [
                "<any>"
              ],
              "total": 1,
              "object": "list",
              "data_ref": "data"
            },
            "inapplicable_to": {
              "data": [
                "<any>"
              ],
              "total": 1,
              "object": "list",
              "data_ref": "data"
            },
            "metadata": {},
            "categories": [
              {
                "id": "<any>",
                "name": "<any>",
                "hierarchy": "<any>",
                "object": "<any>",
                "created_at": "<any>",
                "updated_at": "<any>",
                "stacking_rules_type": "<any>"
              }
            ],
            "banner": "Order Paid - You will get 100 points",
            "name": "promotion_tier_get_points",
            "campaign_name": "PromotionCampaign",
            "campaign_id": "camp_Mow7u4gSxagLlZ2oDQ01ZS5N",
            "validation_rules_assignments": {
              "object": "list",
              "data_ref": "data",
              "data": [
                "<any>"
              ],
              "total": 1
            }
          }
        ]
      }
    ],
    "total": 5,
    "has_more": true,
    "more_starting_after": "2023-10-31T12:13:16.374Z"
  },
  "tracking_id": "<string>",
  "order": {
    "id": "<string>",
    "source_id": "<string>",
    "status": "CREATED",
    "amount": 123,
    "initial_amount": 123,
    "discount_amount": 123,
    "items_discount_amount": 123,
    "total_discount_amount": 123,
    "total_amount": 123,
    "applied_discount_amount": 123,
    "items_applied_discount_amount": 123,
    "total_applied_discount_amount": 123,
    "metadata": {},
    "object": "order",
    "created_at": "2021-12-22T10:13:06.487Z",
    "updated_at": "2021-12-22T10:14:45.316Z",
    "customer_id": "cust_7iUa6ICKyU6gH40dBU25kQU1",
    "referrer_id": "cust_nM4jqPiaXUvQdVSA6vTRUnix",
    "customer": {
      "id": "<any>",
      "object": "<any>"
    },
    "referrer": {
      "id": "<any>",
      "object": "<any>"
    },
    "redemptions": {},
    "items": [
      {
        "id": "<string>",
        "sku_id": "<string>",
        "product_id": "<string>",
        "related_object": "product",
        "source_id": "<string>",
        "quantity": 123,
        "discount_quantity": 123,
        "initial_quantity": 123,
        "amount": 123,
        "discount_amount": 123,
        "applied_discount_amount": 123,
        "applied_discount_quantity": 123,
        "applied_quantity": 123,
        "applied_quantity_amount": 123,
        "initial_amount": 123,
        "price": 123,
        "subtotal_amount": 123,
        "product": {
          "id": "<string>",
          "source_id": "<string>",
          "override": true,
          "name": "<string>",
          "metadata": {},
          "price": 123
        },
        "sku": {
          "id": "<string>",
          "source_id": "<string>",
          "override": true,
          "sku": "<string>",
          "price": 123,
          "metadata": {}
        },
        "object": "order_item",
        "metadata": {},
        "application_details": [
          {
            "source_index": 1,
            "source_applied_quantity": -2,
            "source_applied_quantity_amount": -1,
            "target_index": 123,
            "target_applied_quantity": 123,
            "target_applied_quantity_amount": 123,
            "target_applied_discount_amount": 123
          }
        ]
      }
    ]
  },
  "stacking_rules": {
    "redeemables_limit": 30,
    "applicable_redeemables_limit": 5,
    "applicable_redeemables_per_category_limit": 1,
    "applicable_redeemables_category_limits": {},
    "applicable_exclusive_redeemables_limit": 1,
    "applicable_exclusive_redeemables_per_category_limit": 1,
    "exclusive_categories": [
      "<string>"
    ],
    "joint_categories": [
      "<string>"
    ],
    "redeemables_application_mode": "ALL",
    "redeemables_sorting_rule": "REQUESTED_ORDER",
    "redeemables_products_application_mode": "STACK",
    "redeemables_no_effect_rule": "REDEEM_ANYWAY",
    "no_effect_skip_categories": [
      "<string>"
    ],
    "no_effect_redeem_anyway_categories": [
      "<string>"
    ],
    "redeemables_rollback_order_mode": "WITH_ORDER"
  }
}

Authorizations

X-Client-Application-Id
string
header
required
X-Client-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