Skip to main content
POST
/
v1
/
validations
curl --request POST \
--url https://{cluster}.voucherify.io/v1/validations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>' \
--data '{
"redeemables": [
{
"object": "voucher",
"id": "BLCKFRDY"
}
],
"order": {
"amount": 5500
}
}'
{
"id": "valid_101740aa2869354c6d",
"valid": false,
"redeemables": [
{
"status": "INAPPLICABLE",
"id": "eee33463",
"object": "voucher",
"result": {
"error": {
"code": 404,
"key": "not_found",
"message": "Resource not found",
"details": "Cannot find voucher with id eee33463",
"request_id": "v-0c6c6e20dc42940f0b",
"resource_id": "eee33463",
"resource_type": "voucher"
}
}
},
{
"status": "SKIPPED",
"id": "promo_Mwy9XpA0TLctSGriM5kum0qp",
"object": "promotion_tier",
"result": {}
}
],
"tracking_id": "track_VAVW6qltuo1/z+G2GI2LPw==",
"stacking_rules": {
"redeemables_limit": 30,
"applicable_redeemables_limit": 30,
"applicable_exclusive_redeemables_limit": 5,
"applicable_redeemables_per_category_limit": 30,
"applicable_redeemables_category_limits": {},
"exclusive_categories": [
"cat_0e1d0ba106c17fa350"
],
"joint_categories": [
"cat_0e1d0ba99c2fff2b51"
],
"redeemables_application_mode": "PARTIAL",
"redeemables_sorting_rule": "REQUESTED_ORDER",
"redeemables_no_effect_rule": "REDEEM_ANYWAY",
"no_effect_skip_categories": [
"cat_0e156dab8f2e43873a"
],
"no_effect_redeem_anyway_categories": [
"cat_0e1d0ba106c17fa350"
],
"redeemables_products_application_mode": "STACK",
"redeemables_rollback_order_mode": "WITHOUT_ORDER",
"grouped_redeemables_sorting_rule": "JOINT_ALWAYS_LAST"
}
}

Authorizations

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

Body

application/json
redeemables
(Voucher Redeemable · object | Promotion Tier Redeemable · object | Promotion Stack Redeemable · object | Gift Card Redeemable · object | Loyalty Card Redeemable · object)[]
required
Required array length: 1 - 30 elements
  • Voucher Redeemable
  • Promotion Tier Redeemable
  • Promotion Stack Redeemable
  • Gift Card Redeemable
  • Loyalty Card Redeemable
options
object
order
object
customer
object
session
object
tracking_id
string
metadata
object

Response

valid
boolean
required
redeemables
(Applicable Redeemable · object | Inapplicable Redeemable · object | Skipped Redeemable · object)[]
required
  • Applicable Redeemable
  • Inapplicable Redeemable
  • Skipped Redeemable
stacking_rules
object
required
id
string
Example:
skipped_redeemables
Skipped Redeemable · object[]
inapplicable_redeemables
Inapplicable Redeemable · object[]
order
object
tracking_id
string
Example:
session
object