Validate Stackable Discounts
Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys.
API keys with a Merchant role can’t use this endpoint.
Authorizations
Body
Request body schema for POST v1/validations.
An array of redeemables. You can combine voucher(s) and promotion_tier(s). Alternatively, send one uniquepromotion_stack in the array. Each unique redeemable can be sent in one request only once.
1 - 30 elementsValidate or redeem a discount code.
- Voucher Redeemable
- Promotion Tier Redeemable
- Promotion Stack Redeemable
- Gift Card Redeemable
- Loyalty Card Redeemable
Show child attributes
Show child attributes
Configure parameters returned in the response.
Show child attributes
Show child attributes
Order information.
Show child attributes
Show child attributes
Customer's information.
Show child attributes
Show child attributes
Schema model for session lock object. The session object is required to establish a session between multiple parallel validation and redemption requests. If you only send the type parameter in the request, then by default the session lock will be established for 7 days. Read more on establishing a validation session.
Show child attributes
Show child attributes
Is correspondent to Customer's source_id
A set of key/value pairs that you can attach to a redemption object. It can be useful for storing additional information about the redemption in a structured format.
Response
Depending on your project settings: all redeemables must be valid or just one must be valid to result as valid validation. Read more in the Stacking Rule Documentation.
Response body schema for POST v1/validations.
The result of the validation. It takes all of the redeemables into account and returns a false if at least one redeemable is inapplicable. Returns true if all redeemables are applicable.
Lists validation results of each redeemable. If redeemables_application_mode is PARTIAL in the stacking_rules object, all redeemables here will be APPLICABLE. Read more in [the Stacking rules article]/orchestrate/stacking-rules.
- Applicable Redeemable
- Inapplicable Redeemable
- Skipped Redeemable
Show child attributes
Show child attributes
Defines stacking rules for redeemables. Read more in the Stacking Rule Documentation.
Show child attributes
Show child attributes
Unique identifier of the validation, assigned by Voucherify.
"valid_101740aa2869354c6d"
Lists validation results of each skipped redeemable.
Show child attributes
Show child attributes
Lists validation results of each inapplicable redeemable.
Show child attributes
Show child attributes
Order information.
Show child attributes
Show child attributes
Hashed customer source ID.
"track_VAVo1/z+G2GI2LPw=="
Show child attributes
Show child attributes
Was this page helpful?