Request body schema for POST v1/qualifications.
| Name | Type | Description |
|---|---|---|
| customer | Customer | |
| order | Order | |
| trackingId | String | Is correspondent to Customer's source_id |
| scenario | ScenarioEnum | 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). |
| options | QualificationsOption | |
| metadata | Object | 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 -->Create Validation Rules endpoint or via the Dashboard; in the Advanced Rule Builder → Advanced → Redemption metadata satisfy or Basic Builder → Attributes match → REDEMPTION METADATA. Read more. |
| Name | Value |
|---|---|
| ALL | "ALL" |
| CUSTOMER_WALLET | "CUSTOMER_WALLET" |
| AUDIENCE_ONLY | "AUDIENCE_ONLY" |
| PRODUCTS | "PRODUCTS" |
| PRODUCTS_DISCOUNT | "PRODUCTS_DISCOUNT" |
| PROMOTION_STACKS | "PROMOTION_STACKS" |
| PRODUCTS_BY_CUSTOMER | "PRODUCTS_BY_CUSTOMER" |
| PRODUCTS_DISCOUNT_BY_CUSTOMER | "PRODUCTS_DISCOUNT_BY_CUSTOMER" |