---
title: "Check Eligibility (client-side)"
method: POST
path: "/client/v1/qualifications"
tags: ["Client-side"]
---

# Check Eligibility (client-side)

`POST /client/v1/qualifications`

Generate a list of redeemables that are applicable in the context of the customer and order.

The new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements:

- Qualification results are returned faster
- No limit on the number of returned redeemables
- Introduces new qualification scenarios, not available in the previous version

> 👍 Scenario Guide
>
> Read our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility).

## Paging 

The Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the `starting_after` cursor.

To process of paging the redeemables works in the following manner:

- You send the first API request for Qualifications without the `starting_after` parameter.
- The response will contain a parameter named `has_more`. If the parameter's value is set to `true`, then more redeemables are available.
- Get the value of the `created_at` parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables.
- Send another API request for Qualification with the `starting_after` parameter set to the value taken from the `created_at` parameter from the last returned redeemable.
- Voucherify will return the next page of redeemables.
- If the `has_more` parameter is set to `true`, apply steps 3-5 to get the next page of redeemables.

## Caching

Qualification has a 5-minute cache for the returned results. If you change your campaign settings or validation rules, the changes will apply to qualification results after the cache refreshes.

## Request body

- ClientQualificationsCheckEligibilityRequestBody — Request body schema for **POST** `v1/qualifications`.
  - `customer` Customer
    - `id` string — The ID of an existing customer.
    - `source_id` string — A unique identifier of the customer who validates a voucher. It can be a customer ID or email from a CRM system, database, or a third-party service. If you also pass a customer ID (unique ID assigned by Voucherify), the source ID will be ignored.
    - `name` string — Customer's first and last name.
    - `description` string — An arbitrary string that you can attach to a customer object.
    - `email` string — Customer's email address.
    - `phone` string — Customer's phone number. This parameter is mandatory when you try to send out codes to customers via an SMS channel.
    - `birthday` string, date — `Deprecated`. ~~Customer's birthdate; format YYYY-MM-DD~~.
    - `birthdate` string, date — Customer's birthdate; format YYYY-MM-DD.
    - `address` object, nullable — Customer's address.
      - `city` string — City
      - `state` string — State
      - `line_1` string — First line of address.
      - `line_2` string — Second line of address.
      - `country` string — Country.
      - `postal_code` string — Postal code.
    - `metadata` object — A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments.
  - `order` Order — Order information.
    - `id` string — Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request.
    - `source_id` string, nullable — Unique source ID of an existing order that will be linked to the redemption of this request. For validation and redemption, if `source_id` is used with an existing order, the original order data will be used, like `items`, `amount`, and so on, not the one sent in the new request.
    - `status` 'CREATED' | 'PAID' | 'CANCELED' | 'FULFILLED' — The order status.
    - `amount` integer — A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts.
    - `initial_amount` integer — A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts.
    - `discount_amount` integer — Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
    - `items` OrderItem[] — Array of items applied to the order. It can include up to 500 items.
      - `sku_id` string — Unique identifier of the SKU. It is assigned by Voucherify.
      - `product_id` string — Unique identifier of the product. It is assigned by Voucherify.
      - `related_object` 'product' | 'sku' — Used along with the source_id property, can be set to either sku or product.
      - `source_id` string — The merchant's product/SKU ID (if it is different from the Voucherify product/SKU ID). It is useful in the integration between multiple systems. It can be an ID from an eCommerce site, a database, or a third-party service.
      - `quantity` integer — The quantity of the particular item in the cart.
      - `discount_quantity` integer — Number of dicounted items.
      - `initial_quantity` integer — A positive integer in the smallest unit quantity representing the total amount of the order; this is the sum of the order items' quantity.
      - `amount` integer — The total amount of the order item (price * quantity).
      - `discount_amount` integer — Sum of all order-item-level discounts applied to the order.
      - `initial_amount` integer — A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts.
      - `price` integer — Unit price of an item. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.
      - `product` object — An object containing details of the related product.
        - `id` string — A unique identifier that represents the product and is assigned by Voucherify.
        - `source_id` string — The merchant's product ID (if it is different than Voucherify's product ID). It is really useful in case of integration between multiple systems. It can be an ID from an eCommerce site, a database or a 3rd party service.
        - `override` boolean — The override set to `true` is used to store the product information in the system. If the product does not exist, it will be created with a source_id; if it does exist, the provided values for the name, price, and metadata will replace those already stored in the system. Override works only for endpoints that create an order in the database.
        - `name` string — Product name.
        - `metadata` object — A set of custom key/value pairs that you can attach to a product. It can be useful for storing additional information about the product in a structured format. It can be used to create product collections.
        - `price` number — Product price. A positive integer in the smallest currency unit (e.g. 100 cents for $1.00).
      - `sku` object — An object containing details of the related SKU.
        - `id` string — A unique identifier that represents the SKU and is assigned by Voucherify.
        - `source_id` string — The merchant's SKU ID (if it is different than Voucherify's SKU ID). It is really useful in case of integration between multiple systems. It can be an ID from an eCommerce site, a database or a 3rd party service.
        - `override` boolean — The override set to `true` is used to store the product information in the system. If the product does not exist, it will be created with a source_id; if it does exist, the provided values for the name, price, and metadata will replace those already stored in the system.
        - `sku` string — The SKU name.
        - `price` number — SKU price. A positive integer in the smallest currency unit (e.g. 100 cents for $1.00).
        - `metadata` object — A set of custom key/value pairs that you can attach to an order item. It can be useful for storing additional information about the order item in a structured format. It can be used to create product collections.
      - `metadata` object — A set of custom key/value pairs that you can attach to an order item. It can be useful for storing additional information about the order item in a structured format. It can be used to define business validation rules.
    - `metadata` object — A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.
  - `tracking_id` string — Is correspondent to Customer's source_id
  - `scenario` 'ALL' | 'CUSTOMER_WALLET' | 'AUDIENCE_ONLY' | 'PRODUCTS' | 'PRODUCTS_DISCOUNT' | 'PROMOTION_STACKS' | 'PRODUCTS_BY_CUSTOMER' | 'PRODUCTS_DISCOUNT_BY_CUSTOMER' — 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 — Configure parameters returned in the response.
    - `limit` integer — The maximum number of redeemables to be returned in the API request. The actual number of returned redeemables will be determined by the API. The default value is set to 5
    - `starting_after` string, date-time, nullable — Cursor used for paging.
    - `filters` object — A set of filters to return only a specific category or type of redeemable.
      - `junction` 'and' | 'or' — Logical Operator Between Filters. Filter by conditions set on the `junction` parameter indicating how the `conditions` should be accounted for in the query. An `AND` is an all-inclusive logical operator, meaning the `AND` operator displays a record if **ALL** the conditions separated by AND are TRUE, while an `OR` operator displays a record if **ANY** of the conditions separated by OR is TRUE.
      - `category_id` QualificationsFieldConditions
        - `conditions` QualificationsFiltersCondition
          - `$is` string[]
          - `$is_not` string[]
          - `$has_value` union[]
            - union
              - …
          - `$is_unknown` union[]
            - union
              - …
          - `$in` string[]
          - `$not_in` string[]
      - `campaign_id` QualificationsFieldConditions
        - `conditions` QualificationsFiltersCondition
          - `$is` string[]
          - `$is_not` string[]
          - `$has_value` union[]
            - union
              - …
          - `$is_unknown` union[]
            - union
              - …
          - `$in` string[]
          - `$not_in` string[]
      - `campaign_type` object — Returns both campaigns and their vouchers or promotion tiers. Use other filters, e.g. `resource_type`, to narrow down the results.
        - `conditions` object — Data filters used to narrow down the data records to be returned in the result.
          - `$is` ParameterCampaignType[]
          - `$is_not` ParameterCampaignType[]
          - `$in` ParameterCampaignType[]
          - `$not_in` ParameterCampaignType[]
      - `resource_id` QualificationsFieldConditions
        - `conditions` QualificationsFiltersCondition
          - `$is` string[]
          - `$is_not` string[]
          - `$has_value` union[]
            - union
              - …
          - `$is_unknown` union[]
            - union
              - …
          - `$in` string[]
          - `$not_in` string[]
      - `resource_type` object
        - `conditions` object — Data filters used to narrow down the data records to be returned in the result. - `campaign` refers to campaigns; - `voucher` refers to generic (standalone) vouchers or published vouchers; - `promotion_tier` refers to promotion tiers.
          - `$is` ResourceTypes[]
          - `$is_not` ResourceTypes[]
          - `$in` ResourceTypes[]
          - `$not_in` ResourceTypes[]
      - `voucher_type` QualificationsFieldConditions
        - `conditions` QualificationsFiltersCondition
          - `$is` string[]
          - `$is_not` string[]
          - `$has_value` union[]
            - union
              - …
          - `$is_unknown` union[]
            - union
              - …
          - `$in` string[]
          - `$not_in` string[]
      - `code` QualificationsFieldConditions
        - `conditions` QualificationsFiltersCondition
          - `$is` string[]
          - `$is_not` string[]
          - `$has_value` union[]
            - union
              - …
          - `$is_unknown` union[]
            - union
              - …
          - `$in` string[]
          - `$not_in` string[]
      - `holder_role` object
        - `conditions` object — Data filters used to narrow down the data records to be returned in the result.
          - `$is` string[] — Will return records only for the first value in the array.
          - `$is_not` string[] — Will return records only for the first value in the array.
          - `$in` string[] — Will return records for the values in the array.
          - `$not_in` string[] — Will return records for the values in the array.
    - `expand` string[] — The expand array lets you configure the parameters included in the response. Depending on the strings included in the array, the response will contain different details. | **Expand Option** | **Response Body** | |:---|:---| | [`"redeemable"`] | Returns the redeemables':<br />- metadata<br />- redeemable name,<br />- campaign name,<br />- campaign ID| | [`"category"`] | - Returns an expanded `categories` object, showing details about the category. | | [`"validation_rules"`] | - Returns an expanded `validation_rules` object, showing details about the validation rules. |
    - `sorting_rule` 'BEST_DEAL' | 'LEAST_DEAL' | 'DEFAULT' — Is used to determine the order in which data is displayed in the result array. - `DEFAULT` - Sorting descending by `created_at` - `BEST_DEAL` - Sorting descending by `total_applied_discount_amount` - `LEAST_DEAL` - Sorting ascending by `total_applied_discount_amount`
  - `session` object — Parameter to return details about `locked_credits` on a gift card which has locked credits under a validation session.
    - `type` 'LOCK' — Parameter required to return the details about the `locked_credits`.
  - `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](/api-reference/validation-rules/create-validation-rules) endpoint or with the [Validation Rule Builder](/personalize/create-validation-rules) in the the Dashboard.

## Response `200`

Returns a qualifications object.

- ClientQualificationsCheckEligibilityResponseBody — Response body schema for **POST** `v1/qualifications`.
  - `redeemables` QualificationsRedeemables — List of redeemables for examine qualification.
    - `object` 'list', required — The type of the object represented by JSON. Default is `list`.
    - `data_ref` 'data', required — Identifies the name of the attribute that contains the array of qualified redeemables.
    - `data` QualificationsRedeemable[], required — Array of qualified redeemables.
      - `id` string — ID of the redeemable. For a voucher, it's its `code` value.
      - `object` 'campaign' | 'promotion_tier' | 'promotion_stack' | 'voucher' — Object type of the redeemable.
      - `created_at` string, date-time — Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format.
      - `result` RedeemableResult — Information about redeemable result.
        - `discount` union — Contains information about discount.
          - object
            - `type` 'AMOUNT', required — Defines the type of the voucher.
            - `amount_off` number, required — Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000.
            - `amount_off_formula` string — Formula used to dynamically calculate the discount.
            - `aggregated_amount_limit` integer — Maximum discount amount per order.
            - `effect` 'APPLY_TO_ORDER' | 'APPLY_TO_ITEMS' | 'APPLY_TO_ITEMS_PROPORTIONALLY' | 'APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY' | 'APPLY_TO_ITEMS_BY_QUANTITY'
            - `is_dynamic` boolean — Flag indicating whether the discount was calculated using a formula.
          - object
            - `type` 'UNIT', required — Discount type.
            - `unit_off` integer — Number of units to be granted a full value discount.
            - `unit_off_formula` string — Formula used to dynamically calculate the number of units.
            - `effect` 'ADD_MISSING_ITEMS' | 'ADD_NEW_ITEMS' | 'ADD_MANY_ITEMS' | 'ADD_SAME_ITEMS'
            - `unit_type` string, required — The product deemed as free, chosen from product inventory (e.g. time, items).
            - `product` SimpleProductDiscountUnit
              - …
            - `sku` SimpleSkuDiscountUnit
              - …
            - `is_dynamic` boolean — Flag indicating whether the discount was calculated using a formula.
          - object
            - `type` 'UNIT', required — Discount type.
            - `effect` 'ADD_MANY_ITEMS' — Defines how the discount is applied to the customer's order.
            - `units` DiscountUnitMultipleOneUnit[], required
              - …
          - object
            - `type` 'PERCENT', required — Defines the type of the voucher.
            - `percent_off` number, required — The percent discount that the customer will receive.
            - `percent_off_formula` string — Formula used to dynamically calculate the discount.
            - `amount_limit` number — Upper limit allowed to be applied as a discount. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600.
            - `aggregated_amount_limit` integer — Maximum discount amount per order.
            - `effect` 'APPLY_TO_ORDER' | 'APPLY_TO_ITEMS'
            - `is_dynamic` boolean — Flag indicating whether the discount was calculated using a formula.
          - object
            - `type` 'FIXED', required — Defines the type of the voucher.
            - `fixed_amount` number, required — Sets a fixed value for an order total or the item price. The value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000. If the fixed amount is calculated by the formula, i.e. the `fixed_amount_formula` parameter is present in the fixed amount definition, this value becomes the **fallback value**. As a result, if the formula cannot be calculated due to missing metadata, for example, this value will be used as the fixed value.
            - `fixed_amount_formula` string — Formula used to dynamically calculate the discount.
            - `effect` 'APPLY_TO_ORDER' | 'APPLY_TO_ITEMS'
            - `is_dynamic` boolean — Flag indicating whether the discount was calculated using a formula.
        - `bundle` Bundle — Determines how the bundle conditions are met by the customer's order items. The items in the order meet the bundle condition in the following way: SKU, then product, then collection.
          - `quantity` integer, required — Determines how many bundles are qualified. If there are missing bundle products, the value is `0`. If the bundle is qualified, the value is `1`. The maximum number of identified bundles can equal the number set in `limit`. Also defines the multiplier of the discount for `AMOUNT`, `PERCENT`, and `UNIT` discount types. To inform end-customers that more products can be added to meet additional bundles, compare this parameter with `limit`.
          - `limit` integer, required — Determines the maximum number of identified bundles. This also defines the maximum multiplier of the bundle discount.
          - `identified` object[] — Determines products from the customer's order items that meet bundle conditions. SKUs meet the conditions for their product that is used in the bundle. Returns only the products and their quantity that meet the bundle.
            - `id` string, required — Unique identifier of the product or SKU that meets the bundle condition. This is an ID assigned by Voucherify.
            - `object` 'product' | 'sku', required — Determines the type of the object that meets the bundle condition.
            - `item_index` integer, required — Number assigned to the order line item in accordance with the order sent in the request. It starts with `0` for the first order line item in the request.
            - `item_quantity` integer, required — Quantity of items that meet the bundle conditions. If the quantity in the order is higher than the quantity required by the bundle, this returns only the number that meets the bundle. For example, if the bundle requires `5` coffees, but the order includes `10` coffees, `item_quantity` returns `5`.
          - `missing` object[] — Determines products, SKUs, or collections from the bundle that are missing in the customer's order items. Determines also the missing quantity. For collections, this means that order items do not include a sufficient number of items that belong to the collection. Not returned when all required bundle items are in the order.
            - `id` string, required — Unique identifier of the collection, product, or SKU that is missing in the customer's order items. This is an ID assigned by Voucherify.
            - `object` 'product' | 'products_collection' | 'sku', required — Determines the type of the object that is missing in the customer's order items.
            - `item_quantity` integer, required — Quantity of items that are missing in the order items to meet the bundle conditions.
        - `gift` RedeemableGift — Contains current gift card balance information.
          - `balance` number — Available funds. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.
          - `credits` number — The number of credits that the user wants to use from the gift card to fulfil the order. The value of credits cannot be higher than the current balance on the gift card. If the user gives more points than he has on the gift card, the application will return an error code in response. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.
          - `locked_credits` number — The number of credits that are locked under a validation session. This is returned if the qualification request includes `session.type: LOCK` parameter in the body. The value is multiplied by 100 to represent 2 decimal places. For example `10000` for `$100.00`. Returns `0` if there aren't any active validation sessions for the gift card.
        - `loyalty_card` RedeemableLoyaltyCard — Redeemable loyalty card object response
          - `points` integer — Total number of points added to the loyalty card over its lifespan.
          - `balance` integer — Points available for reward redemption. This is calculated as follows: `balance` = `points` - `expired_points` - `subtracted_points` - `redemption.redeemed_points`.
          - `exchange_ratio` number — The cash equivalent of the points defined in the points_ratio property.
          - `points_ratio` integer — The number of loyalty points that will map to the predefined cash amount defined by the exchange_ratio property.
          - `transfers` LoyaltiesTransferPoints[]
            - `code` string, required — Unique loyalty card code from which the user wants to transfer loyalty points (source).
            - `points` integer, required — The number of loyalty points that the user wants to transfer to another loyalty card. The number of points cannot be higher than the current balance on the loyalty card (source).
            - `reason` string — Reason for the transfer.
            - `source_id` string, required — The merchant's transaction ID if it is different from the Voucherify transaction ID. It is really useful in case of an integration between multiple systems. It can be a transaction ID from a CRM system, database or 3rd-party service.
        - `error` Error — Error details
          - `code` integer, required — Error's HTTP status code.
          - `key` string — Short string describing the kind of error which occurred.
          - `message` string, required — A human-readable message providing a short description of the error.
          - `details` string — A human-readable message providing more details about the error.
          - `request_id` string — This ID is useful when troubleshooting and/or finding the root cause of an error response by our support team.
          - `resource_id` string — Unique resource ID that can be used in another endpoint to get more details.
          - `resource_type` string — The resource type.
          - `error` object — Includes additional information about the error.
            - `message` string — The message configured by the user in a validation rule.
      - `order` object — Order information.
        - `id` string — Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request.
        - `source_id` string, nullable — Unique source ID of an existing order that will be linked to the redemption of this request.
        - `status` 'CREATED' | 'PAID' | 'CANCELED' | 'FULFILLED' — The order status.
        - `amount` integer — This is the sum of the order items' amounts. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
        - `initial_amount` integer — This is the sum of the order items' amounts before any discount or other effect (e.g. add missing units) is applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
        - `discount_amount` integer — Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
        - `items_discount_amount` integer — Sum of all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
        - `total_discount_amount` integer — Sum of all order-level AND all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
        - `total_amount` integer — Order amount after undoing all the discounts through the rollback redemption. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
        - `applied_discount_amount` integer — This field shows the order-level discount applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
        - `items_applied_discount_amount` integer — Sum of all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). `sum(items, i => i.applied_discount_amount)`
        - `total_applied_discount_amount` integer — Sum of all order-level AND all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount`
        - `metadata` object — A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.
        - `object` 'order' — The type of the object represented by JSON.
        - `created_at` string, date-time — Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.
        - `updated_at` string, date-time, nullable — Timestamp representing the date and time when the order was last updated in ISO 8601 format.
        - `customer_id` string, nullable — Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify.
        - `referrer_id` string, nullable — Unique referrer ID.
        - `customer` CustomerId
          - `id` string, required — A unique identifier of an existing customer.
          - `object` 'customer', required — The type of the object represented by JSON.
        - `referrer` ReferrerId
          - `id` string, required — A unique identifier of an existing customer.
          - `object` 'customer', required — The type of the object represented by JSON.
        - `redemptions` object
        - `items` object[] — Array of items applied to the order. It can include up to 500 items.
          - `id` string — Unique identifier of the order line item.
          - `sku_id` string — Unique identifier of the SKU. It is assigned by Voucherify.
          - `product_id` string — Unique identifier of the product. It is assigned by Voucherify.
          - `related_object` 'product' | 'sku' — Used along with the source_id property, can be set to either sku or product.
          - `source_id` string — The merchant's product/SKU ID (if it is different from the Voucherify product/SKU ID). It is useful in the integration between multiple systems. It can be an ID from an eCommerce site, a database, or a third-party service.
          - `quantity` integer — The quantity of the particular item in the cart.
          - `discount_quantity` integer — Number of dicounted items.
          - `initial_quantity` integer — A positive integer in the smallest unit quantity representing the total amount of the order; this is the sum of the order items' quantity.
          - `amount` integer — The total amount of the order item (price * quantity).
          - `discount_amount` integer — Sum of all order-item-level discounts applied to the order.
          - `applied_discount_amount` integer — This field shows the order-level discount applied.
          - `applied_discount_quantity` integer — Number of the discounted items applied in the transaction.
          - `applied_quantity` integer — Quantity of items changed by the application of a new quantity items. It can be positive when an item is added or negative if an item is replaced.
          - `applied_quantity_amount` integer — Amount for the items changed by the application of a new quantity items. It can be positive when an item is added or negative if an item is replaced.
          - `initial_amount` integer — A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts.
          - `price` integer — Unit price of an item. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.
          - `subtotal_amount` integer — Final order item amount after the applied item-level discount. If there are no item-level discounts applied, this item is equal to the `amount`. `subtotal_amount`=`amount`-`applied_discount_amount`
          - `product` object — An object containing details of the related product.
            - `id` string — A unique identifier that represents the product and is assigned by Voucherify.
            - `source_id` string — The merchant's product ID (if it is different than Voucherify's product ID). It is really useful in case of integration between multiple systems. It can be an ID from an eCommerce site, a database or a 3rd party service.
            - `override` boolean — The override set to `true` is used to store the product information in the system. If the product does not exist, it will be created with a source_id; if it does exist, the provided values for the name, price, and metadata will replace those already stored in the system.
            - `name` string — Product name.
            - `metadata` object — A set of custom key/value pairs that you can attach to a product. It can be useful for storing additional information about the product in a structured format. It can be used to create product collections.
            - `price` number — Product price. A positive integer in the smallest currency unit (e.g. 100 cents for $1.00).
          - `sku` object — An object containing details of the related SKU.
            - `id` string — A unique identifier that represents the SKU and is assigned by Voucherify.
            - `source_id` string — The merchant's SKU ID (if it is different than Voucherify's SKU ID). It is really useful in case of integration between multiple systems. It can be an ID from an eCommerce site, a database or a 3rd party service.
            - `override` boolean — The override set to `true` is used to store the product information in the system. If the product does not exist, it will be created with a source_id; if it does exist, the provided values for the name, price, and metadata will replace those already stored in the system.
            - `sku` string — The SKU name.
            - `price` number — SKU price. A positive integer in the smallest currency unit (e.g. 100 cents for $1.00).
            - `metadata` object — A set of custom key/value pairs that you can attach to an SKU. It can be useful for storing additional information about the SKU in a structured format. It can be used to create product collections.
          - `object` 'order_item', required — The type of the object represented by JSON.
          - `metadata` object — A set of custom key/value pairs that you can attach to an item object. It can be useful for storing additional information about the item in a structured format. It can be used to define business validation rules or discount formulas.
          - `application_details` object[] — Array containing details about the items that are replaced and the items that are replacements for discounts with the `REPLACE_ITEMS` effect.
            - `source_index` integer — Index number of the source item that is replaced. The enumeration starts from `0`, which represents the first item in the request, e.g., if the replaced item is passed as the second in the request, `source_index` equals `3`.
            - `source_applied_quantity` integer — Number of source units that are replaced.
            - `source_applied_quantity_amount` integer — Amount equal to the price of the units that are replaced. Determines the change of the amount of the source item quantity.
            - `target_index` integer — Index number of the target item that is a replacement of the source item. The enumeration continues the values for the order items, e.g. if there are three items in the request, `target_index` equals `3`, as enumeration starts from `0`.
            - `target_applied_quantity` integer — Number of added target units that are replacements.
            - `target_applied_quantity_amount` integer — Amount equal to the price of the units that are replacements. Determines the change in the amount of the target item quantity.
            - `target_applied_discount_amount` integer — Discount amount applied to the target item with regard to the replacement. Equals the `target_applied_quantity_amount` minus `source_applied_quantity_amount`.
      - `validation_rule_id` string — A unique validation rule identifier assigned by the Voucherify API. The validation rule is verified before points are added to the balance.
      - `applicable_to` ApplicableToResultList
        - `data` ApplicableTo[], required — Contains array of items to which the discount can apply.
          - `object` 'product' | 'sku' | 'products_collection', required — This object stores information about the resource to which the discount is applicable.
          - `id` string, required — Unique product collection, product, or SKU identifier assigned by Voucherify.
          - `source_id` string — The source identifier from your inventory system.
          - `product_id` string — Parent product's unique ID assigned by Voucherify.
          - `product_source_id` string — Parent product's source ID from your inventory system.
          - `price` number — New fixed price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 price is written as 1000. In case of the fixed price being calculated by the formula, i.e. the price_formula parameter is present in the fixed price definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the fixed price.
          - `price_formula` number — Formula used to dynamically calculate the discounted price of an item.
          - `effect` 'APPLY_TO_EVERY' | 'APPLY_TO_CHEAPEST' | 'APPLY_FROM_CHEAPEST' | 'APPLY_TO_MOST_EXPENSIVE' | 'APPLY_FROM_MOST_EXPENSIVE', required
          - `quantity_limit` integer — The maximum number of units allowed to be discounted per order line item.
          - `aggregated_quantity_limit` integer — The maximum number of units allowed to be discounted combined across all matched order line items.
          - `amount_limit` integer — Upper limit allowed to be applied as a discount per order line item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600.
          - `aggregated_amount_limit` integer — Maximum discount amount per order. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount on the entire order is written as 600. This value is definable for the following discount effects: - `APPLY_TO_ITEMS` (each item subtotal is discounted equally) - `APPLY_TO_ITEMS_BY_QUANTITY` (each unit of matched products has the same discount value)
          - `product_campaign_quantity_limit` integer — Limits the number of discounted item units (product, SKU, collection) that all customers can receive in a given campaign. If a product is selected, the limit covers all discounts across all SKUs belonging to that product. If a product collection is selected, the limit covers all products/SKUs within the collection. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_campaign_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per campaign. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_customer_campaign_quantity_limit` integer — Limits the number of discounted item units (product, SKU, collection) that one customer can receive in a given campaign. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_customer_campaign_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per customer in a campaign. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_in_collection_campaign_quantity_limit` integer — Limits the number of discounted item units of a given product in a collection that all customers can receive in a given campaign. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_in_collection_campaign_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per campaign for a product in a collection. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_in_collection_customer_campaign_quantity_limit` integer — Limits the number of discounted item units of a given product in a collection that one customer can receive in a campaign. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_in_collection_customer_campaign_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per customer for a product in a collection. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_promotion_tier_quantity_limit` integer — Limits the number of discounted item units that all customers can receive in a promotion tier. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_promotion_tier_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per promotion tier. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_customer_promotion_tier_quantity_limit` integer — Limits the number of discounted item units that one customer can receive in a given promotion tier. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_customer_promotion_tier_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per customer in a promotion tier. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_in_collection_promotion_tier_quantity_limit` integer — Limits the number of discounted item units of a given product in a collection that all customers can receive in a given promotion tier. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_in_collection_promotion_tier_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per promotion tier for a product in a collection. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_in_collection_customer_promotion_tier_quantity_limit` integer — Limits the number of discounted item units of a given product in a collection that one customer can receive in a promotion tier. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_in_collection_customer_promotion_tier_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per customer in a promotion tier for a product in a collection. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `order_item_indices` integer[] — Lists which order lines are (not) covered by the discount. The order in the array is determined by the sequence of applied discounts, while the numbers correspond to the order lines sent in the `order` object in the request. The first order line is assigned `0`, the second order line is assigned `1`, and so on.
          - `order_item_units` object[] — Lists which units within order lines are covered by the discount. The order line items are listed according to sequence of applied discounts while the `index` corresponds to the order line sent in the `order` object in the request.
            - `index` integer — Number assigned to the order line item in accordance with the order sent in the request.
            - `units` integer[] — Numbers of units in the order line covered by the discount; e.g. `2, 5, 8` for 10 units with the setting `"skip_initially": 1`, `"repeat": 3`. The counting of units starts from `1`. The maximum quantity of all handled units is 1000. If the quantity of all order items exceeds 1000, this array is not returned, but `units_limit_exceeded: true`. However, the discount is calculated properly for all relevant units.
            - `units_limit_exceeded` boolean — Returned as `true` only when the sum total of `quantity` of all order items exceeds 1000.
          - `repeat` integer — Determines the recurrence of the discount, e.g. `"repeat": 3` means that the discount is applied to every third item.
          - `skip_initially` integer — Determines how many items are skipped before the discount is applied.
          - `target` 'ITEM' | 'UNIT' — Determines to which kinds of objects the discount is applicable. `ITEM` includes products and SKUs. `UNIT` means particular units within an order line.
        - `total` integer, required — Total number of objects defining included products, SKUs, or product collections.
        - `object` 'list', required — The type of the object represented by JSON.
        - `data_ref` 'data', required — The type of the object represented by JSON.
      - `inapplicable_to` InapplicableToResultList
        - `data` InapplicableTo[], required — Contains array of items to which the discount cannot apply.
          - `object` 'product' | 'sku' | 'products_collection', required — This object stores information about the resource to which the discount is applicable.
          - `id` string, required — Unique product collection, product, or SKU identifier assigned by Voucherify.
          - `source_id` string — The source identifier from your inventory system.
          - `product_id` string — Parent product's unique ID assigned by Voucherify.
          - `product_source_id` string — Parent product's source ID from your inventory system.
          - `price` number — New fixed price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 price is written as 1000. In case of the fixed price being calculated by the formula, i.e. the price_formula parameter is present in the fixed price definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the fixed price.
          - `price_formula` number — Formula used to dynamically calculate the discounted price of an item.
          - `effect` 'APPLY_TO_EVERY' | 'APPLY_TO_CHEAPEST' | 'APPLY_FROM_CHEAPEST' | 'APPLY_TO_MOST_EXPENSIVE' | 'APPLY_FROM_MOST_EXPENSIVE', required
          - `quantity_limit` integer — The maximum number of units allowed to be discounted per order line item.
          - `aggregated_quantity_limit` integer — The maximum number of units allowed to be discounted combined across all matched order line items.
          - `amount_limit` integer — Upper limit allowed to be applied as a discount per order line item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600.
          - `aggregated_amount_limit` integer — Maximum discount amount per order. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount on the entire order is written as 600. This value is definable for the following discount effects: - `APPLY_TO_ITEMS` (each item subtotal is discounted equally) - `APPLY_TO_ITEMS_BY_QUANTITY` (each unit of matched products has the same discount value)
          - `product_campaign_quantity_limit` integer — Limits the number of discounted item units (product, SKU, collection) that all customers can receive in a given campaign. If a product is selected, the limit covers all discounts across all SKUs belonging to that product. If a product collection is selected, the limit covers all products/SKUs within the collection. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_campaign_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per campaign. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_customer_campaign_quantity_limit` integer — Limits the number of discounted item units (product, SKU, collection) that one customer can receive in a given campaign. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_customer_campaign_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per customer in a campaign. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_in_collection_campaign_quantity_limit` integer — Limits the number of discounted item units of a given product in a collection that all customers can receive in a given campaign. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_in_collection_campaign_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per campaign for a product in a collection. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_in_collection_customer_campaign_quantity_limit` integer — Limits the number of discounted item units of a given product in a collection that one customer can receive in a campaign. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_in_collection_customer_campaign_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per customer for a product in a collection. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_promotion_tier_quantity_limit` integer — Limits the number of discounted item units that all customers can receive in a promotion tier. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_promotion_tier_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per promotion tier. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_customer_promotion_tier_quantity_limit` integer — Limits the number of discounted item units that one customer can receive in a given promotion tier. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_customer_promotion_tier_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per customer in a promotion tier. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_in_collection_promotion_tier_quantity_limit` integer — Limits the number of discounted item units of a given product in a collection that all customers can receive in a given promotion tier. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_in_collection_promotion_tier_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per promotion tier for a product in a collection. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_in_collection_customer_promotion_tier_quantity_limit` integer — Limits the number of discounted item units of a given product in a collection that one customer can receive in a promotion tier. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `product_in_collection_customer_promotion_tier_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per customer in a promotion tier for a product in a collection. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
          - `order_item_indices` integer[] — Lists which order lines are (not) covered by the discount. The order in the array is determined by the sequence of applied discounts, while the numbers correspond to the order lines sent in the `order` object in the request. The first order line is assigned `0`, the second order line is assigned `1`, and so on.
          - `order_item_units` object[] — Lists which units within order lines are covered by the discount. The order line items are listed according to sequence of applied discounts while the `index` corresponds to the order line sent in the `order` object in the request.
            - `index` integer — Number assigned to the order line item in accordance with the order sent in the request.
            - `units` integer[] — Numbers of units in the order line covered by the discount; e.g. `2, 5, 8` for 10 units with the setting `"skip_initially": 1`, `"repeat": 3`. The counting of units starts from `1`. The maximum quantity of all handled units is 1000. If the quantity of all order items exceeds 1000, this array is not returned, but `units_limit_exceeded: true`. However, the discount is calculated properly for all relevant units.
            - `units_limit_exceeded` boolean — Returned as `true` only when the sum total of `quantity` of all order items exceeds 1000.
          - `repeat` integer — Determines the recurrence of the discount, e.g. `"repeat": 3` means that the discount is applied to every third item.
          - `skip_initially` integer — Determines how many items are skipped before the discount is applied.
          - `target` 'ITEM' | 'UNIT' — Determines to which kinds of objects the discount is applicable. `ITEM` includes products and SKUs. `UNIT` means particular units within an order line.
        - `total` integer, required — Total number of objects defining included products, SKUs, or product collections.
        - `object` 'list', required — The type of the object represented by JSON.
        - `data_ref` 'data', required — The type of the object represented by JSON.
      - `metadata` object — The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format.
      - `categories` CategoryWithStackingRulesType[] — List of category information.
        - `id` string, required — Unique category ID assigned by Voucherify.
        - `name` string, required — Category name.
        - `hierarchy` integer, required — Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value.
        - `object` 'category', required — The type of the object represented by the JSON. This object stores information about the category.
        - `created_at` string, date-time, required — Timestamp representing the date and time when the category was created. The value is shown in the ISO 8601 format.
        - `updated_at` string, date-time — Timestamp representing the date and time when the category was updated. The value is shown in the ISO 8601 format.
        - `stacking_rules_type` 'JOINT' | 'EXCLUSIVE' — The type of the stacking rule eligibility.
      - `banner` string — Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard.
      - `name` string — Name of the redeemable.
      - `campaign_name` string — Name of the campaign associated to the redeemable. This field is available only if object is not `campaign`
      - `campaign_id` string — Id of the campaign associated to the redeemable. This field is available only if object is not `campaign`
      - `validation_rules_assignments` ValidationRulesAssignmentsList — List of Validation Rules Assignments
        - `object` 'list', required — The type of the object represented by JSON. This object stores information about validation rules assignments.
        - `data_ref` 'data', required — Identifies the name of the attribute that contains the array of validation rules assignments.
        - `data` BusValRuleAssignment[], required — Contains array of validation rules assignments.
          - `id` string, required — The unique identifier for a assignment
          - `rule_id` string, required — The unique identifier for a rule
          - `related_object_id` string, required — The unique identifier for a related object
          - `related_object_type` string, required — The type of related object
          - `created_at` string, date-time — Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format.
          - `updated_at` string, date-time — Timestamp representing the date and time when the object was last updated in ISO 8601 format.
          - `object` 'validation_rules_assignment', required — The type of the object represented by JSON.
          - `validation_status` 'VALID' | 'PARTIALLY_VALID' | 'INVALID' — The validation status of the assignment
          - `validation_omitted_rules` string[] — The list of omitted rules
        - `total` integer, required — Total number of validation rules assignments.
      - `redeemables` QualificationsRedeemableBase[]
        - `id` string — ID of the redeemable. For a voucher, it's its `code` value.
        - `object` 'campaign' | 'promotion_tier' | 'promotion_stack' | 'voucher' — Object type of the redeemable.
        - `created_at` string, date-time — Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format.
        - `result` RedeemableResult — Information about redeemable result.
          - `discount` union — Contains information about discount.
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
          - `bundle` Bundle — Determines how the bundle conditions are met by the customer's order items. The items in the order meet the bundle condition in the following way: SKU, then product, then collection.
            - `quantity` integer, required — Determines how many bundles are qualified. If there are missing bundle products, the value is `0`. If the bundle is qualified, the value is `1`. The maximum number of identified bundles can equal the number set in `limit`. Also defines the multiplier of the discount for `AMOUNT`, `PERCENT`, and `UNIT` discount types. To inform end-customers that more products can be added to meet additional bundles, compare this parameter with `limit`.
            - `limit` integer, required — Determines the maximum number of identified bundles. This also defines the maximum multiplier of the bundle discount.
            - `identified` object[] — Determines products from the customer's order items that meet bundle conditions. SKUs meet the conditions for their product that is used in the bundle. Returns only the products and their quantity that meet the bundle.
              - …
            - `missing` object[] — Determines products, SKUs, or collections from the bundle that are missing in the customer's order items. Determines also the missing quantity. For collections, this means that order items do not include a sufficient number of items that belong to the collection. Not returned when all required bundle items are in the order.
              - …
          - `gift` RedeemableGift — Contains current gift card balance information.
            - `balance` number — Available funds. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.
            - `credits` number — The number of credits that the user wants to use from the gift card to fulfil the order. The value of credits cannot be higher than the current balance on the gift card. If the user gives more points than he has on the gift card, the application will return an error code in response. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.
            - `locked_credits` number — The number of credits that are locked under a validation session. This is returned if the qualification request includes `session.type: LOCK` parameter in the body. The value is multiplied by 100 to represent 2 decimal places. For example `10000` for `$100.00`. Returns `0` if there aren't any active validation sessions for the gift card.
          - `loyalty_card` RedeemableLoyaltyCard — Redeemable loyalty card object response
            - `points` integer — Total number of points added to the loyalty card over its lifespan.
            - `balance` integer — Points available for reward redemption. This is calculated as follows: `balance` = `points` - `expired_points` - `subtracted_points` - `redemption.redeemed_points`.
            - `exchange_ratio` number — The cash equivalent of the points defined in the points_ratio property.
            - `points_ratio` integer — The number of loyalty points that will map to the predefined cash amount defined by the exchange_ratio property.
            - `transfers` LoyaltiesTransferPoints[]
              - …
          - `error` Error — Error details
            - `code` integer, required — Error's HTTP status code.
            - `key` string — Short string describing the kind of error which occurred.
            - `message` string, required — A human-readable message providing a short description of the error.
            - `details` string — A human-readable message providing more details about the error.
            - `request_id` string — This ID is useful when troubleshooting and/or finding the root cause of an error response by our support team.
            - `resource_id` string — Unique resource ID that can be used in another endpoint to get more details.
            - `resource_type` string — The resource type.
            - `error` object — Includes additional information about the error.
              - …
        - `order` object — Order information.
          - `id` string — Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request.
          - `source_id` string, nullable — Unique source ID of an existing order that will be linked to the redemption of this request.
          - `status` 'CREATED' | 'PAID' | 'CANCELED' | 'FULFILLED' — The order status.
          - `amount` integer — This is the sum of the order items' amounts. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
          - `initial_amount` integer — This is the sum of the order items' amounts before any discount or other effect (e.g. add missing units) is applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
          - `discount_amount` integer — Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
          - `items_discount_amount` integer — Sum of all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
          - `total_discount_amount` integer — Sum of all order-level AND all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
          - `total_amount` integer — Order amount after undoing all the discounts through the rollback redemption. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
          - `applied_discount_amount` integer — This field shows the order-level discount applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
          - `items_applied_discount_amount` integer — Sum of all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). `sum(items, i => i.applied_discount_amount)`
          - `total_applied_discount_amount` integer — Sum of all order-level AND all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount`
          - `metadata` object — A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.
          - `object` 'order' — The type of the object represented by JSON.
          - `created_at` string, date-time — Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.
          - `updated_at` string, date-time, nullable — Timestamp representing the date and time when the order was last updated in ISO 8601 format.
          - `customer_id` string, nullable — Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify.
          - `referrer_id` string, nullable — Unique referrer ID.
          - `customer` CustomerId
            - `id` string, required — A unique identifier of an existing customer.
            - `object` 'customer', required — The type of the object represented by JSON.
          - `referrer` ReferrerId
            - `id` string, required — A unique identifier of an existing customer.
            - `object` 'customer', required — The type of the object represented by JSON.
          - `redemptions` object
          - `items` object[] — Array of items applied to the order. It can include up to 500 items.
            - `id` string — Unique identifier of the order line item.
            - `sku_id` string — Unique identifier of the SKU. It is assigned by Voucherify.
            - `product_id` string — Unique identifier of the product. It is assigned by Voucherify.
            - `related_object` 'product' | 'sku' — Used along with the source_id property, can be set to either sku or product.
            - `source_id` string — The merchant's product/SKU ID (if it is different from the Voucherify product/SKU ID). It is useful in the integration between multiple systems. It can be an ID from an eCommerce site, a database, or a third-party service.
            - `quantity` integer — The quantity of the particular item in the cart.
            - `discount_quantity` integer — Number of dicounted items.
            - `initial_quantity` integer — A positive integer in the smallest unit quantity representing the total amount of the order; this is the sum of the order items' quantity.
            - `amount` integer — The total amount of the order item (price * quantity).
            - `discount_amount` integer — Sum of all order-item-level discounts applied to the order.
            - `applied_discount_amount` integer — This field shows the order-level discount applied.
            - `applied_discount_quantity` integer — Number of the discounted items applied in the transaction.
            - `applied_quantity` integer — Quantity of items changed by the application of a new quantity items. It can be positive when an item is added or negative if an item is replaced.
            - `applied_quantity_amount` integer — Amount for the items changed by the application of a new quantity items. It can be positive when an item is added or negative if an item is replaced.
            - `initial_amount` integer — A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts.
            - `price` integer — Unit price of an item. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.
            - `subtotal_amount` integer — Final order item amount after the applied item-level discount. If there are no item-level discounts applied, this item is equal to the `amount`. `subtotal_amount`=`amount`-`applied_discount_amount`
            - `product` object — An object containing details of the related product.
              - …
            - `sku` object — An object containing details of the related SKU.
              - …
            - `object` 'order_item', required — The type of the object represented by JSON.
            - `metadata` object — A set of custom key/value pairs that you can attach to an item object. It can be useful for storing additional information about the item in a structured format. It can be used to define business validation rules or discount formulas.
            - `application_details` object[] — Array containing details about the items that are replaced and the items that are replacements for discounts with the `REPLACE_ITEMS` effect.
              - …
        - `validation_rule_id` string — A unique validation rule identifier assigned by the Voucherify API. The validation rule is verified before points are added to the balance.
        - `applicable_to` ApplicableToResultList
          - `data` ApplicableTo[], required — Contains array of items to which the discount can apply.
            - `object` 'product' | 'sku' | 'products_collection', required — This object stores information about the resource to which the discount is applicable.
            - `id` string, required — Unique product collection, product, or SKU identifier assigned by Voucherify.
            - `source_id` string — The source identifier from your inventory system.
            - `product_id` string — Parent product's unique ID assigned by Voucherify.
            - `product_source_id` string — Parent product's source ID from your inventory system.
            - `price` number — New fixed price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 price is written as 1000. In case of the fixed price being calculated by the formula, i.e. the price_formula parameter is present in the fixed price definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the fixed price.
            - `price_formula` number — Formula used to dynamically calculate the discounted price of an item.
            - `effect` 'APPLY_TO_EVERY' | 'APPLY_TO_CHEAPEST' | 'APPLY_FROM_CHEAPEST' | 'APPLY_TO_MOST_EXPENSIVE' | 'APPLY_FROM_MOST_EXPENSIVE', required
            - `quantity_limit` integer — The maximum number of units allowed to be discounted per order line item.
            - `aggregated_quantity_limit` integer — The maximum number of units allowed to be discounted combined across all matched order line items.
            - `amount_limit` integer — Upper limit allowed to be applied as a discount per order line item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600.
            - `aggregated_amount_limit` integer — Maximum discount amount per order. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount on the entire order is written as 600. This value is definable for the following discount effects: - `APPLY_TO_ITEMS` (each item subtotal is discounted equally) - `APPLY_TO_ITEMS_BY_QUANTITY` (each unit of matched products has the same discount value)
            - `product_campaign_quantity_limit` integer — Limits the number of discounted item units (product, SKU, collection) that all customers can receive in a given campaign. If a product is selected, the limit covers all discounts across all SKUs belonging to that product. If a product collection is selected, the limit covers all products/SKUs within the collection. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_campaign_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per campaign. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_customer_campaign_quantity_limit` integer — Limits the number of discounted item units (product, SKU, collection) that one customer can receive in a given campaign. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_customer_campaign_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per customer in a campaign. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_in_collection_campaign_quantity_limit` integer — Limits the number of discounted item units of a given product in a collection that all customers can receive in a given campaign. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_in_collection_campaign_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per campaign for a product in a collection. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_in_collection_customer_campaign_quantity_limit` integer — Limits the number of discounted item units of a given product in a collection that one customer can receive in a campaign. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_in_collection_customer_campaign_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per customer for a product in a collection. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_promotion_tier_quantity_limit` integer — Limits the number of discounted item units that all customers can receive in a promotion tier. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_promotion_tier_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per promotion tier. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_customer_promotion_tier_quantity_limit` integer — Limits the number of discounted item units that one customer can receive in a given promotion tier. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_customer_promotion_tier_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per customer in a promotion tier. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_in_collection_promotion_tier_quantity_limit` integer — Limits the number of discounted item units of a given product in a collection that all customers can receive in a given promotion tier. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_in_collection_promotion_tier_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per promotion tier for a product in a collection. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_in_collection_customer_promotion_tier_quantity_limit` integer — Limits the number of discounted item units of a given product in a collection that one customer can receive in a promotion tier. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_in_collection_customer_promotion_tier_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per customer in a promotion tier for a product in a collection. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `order_item_indices` integer[] — Lists which order lines are (not) covered by the discount. The order in the array is determined by the sequence of applied discounts, while the numbers correspond to the order lines sent in the `order` object in the request. The first order line is assigned `0`, the second order line is assigned `1`, and so on.
            - `order_item_units` object[] — Lists which units within order lines are covered by the discount. The order line items are listed according to sequence of applied discounts while the `index` corresponds to the order line sent in the `order` object in the request.
              - …
            - `repeat` integer — Determines the recurrence of the discount, e.g. `"repeat": 3` means that the discount is applied to every third item.
            - `skip_initially` integer — Determines how many items are skipped before the discount is applied.
            - `target` 'ITEM' | 'UNIT' — Determines to which kinds of objects the discount is applicable. `ITEM` includes products and SKUs. `UNIT` means particular units within an order line.
          - `total` integer, required — Total number of objects defining included products, SKUs, or product collections.
          - `object` 'list', required — The type of the object represented by JSON.
          - `data_ref` 'data', required — The type of the object represented by JSON.
        - `inapplicable_to` InapplicableToResultList
          - `data` InapplicableTo[], required — Contains array of items to which the discount cannot apply.
            - `object` 'product' | 'sku' | 'products_collection', required — This object stores information about the resource to which the discount is applicable.
            - `id` string, required — Unique product collection, product, or SKU identifier assigned by Voucherify.
            - `source_id` string — The source identifier from your inventory system.
            - `product_id` string — Parent product's unique ID assigned by Voucherify.
            - `product_source_id` string — Parent product's source ID from your inventory system.
            - `price` number — New fixed price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 price is written as 1000. In case of the fixed price being calculated by the formula, i.e. the price_formula parameter is present in the fixed price definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the fixed price.
            - `price_formula` number — Formula used to dynamically calculate the discounted price of an item.
            - `effect` 'APPLY_TO_EVERY' | 'APPLY_TO_CHEAPEST' | 'APPLY_FROM_CHEAPEST' | 'APPLY_TO_MOST_EXPENSIVE' | 'APPLY_FROM_MOST_EXPENSIVE', required
            - `quantity_limit` integer — The maximum number of units allowed to be discounted per order line item.
            - `aggregated_quantity_limit` integer — The maximum number of units allowed to be discounted combined across all matched order line items.
            - `amount_limit` integer — Upper limit allowed to be applied as a discount per order line item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600.
            - `aggregated_amount_limit` integer — Maximum discount amount per order. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount on the entire order is written as 600. This value is definable for the following discount effects: - `APPLY_TO_ITEMS` (each item subtotal is discounted equally) - `APPLY_TO_ITEMS_BY_QUANTITY` (each unit of matched products has the same discount value)
            - `product_campaign_quantity_limit` integer — Limits the number of discounted item units (product, SKU, collection) that all customers can receive in a given campaign. If a product is selected, the limit covers all discounts across all SKUs belonging to that product. If a product collection is selected, the limit covers all products/SKUs within the collection. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_campaign_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per campaign. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_customer_campaign_quantity_limit` integer — Limits the number of discounted item units (product, SKU, collection) that one customer can receive in a given campaign. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_customer_campaign_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per customer in a campaign. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_in_collection_campaign_quantity_limit` integer — Limits the number of discounted item units of a given product in a collection that all customers can receive in a given campaign. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_in_collection_campaign_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per campaign for a product in a collection. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_in_collection_customer_campaign_quantity_limit` integer — Limits the number of discounted item units of a given product in a collection that one customer can receive in a campaign. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_in_collection_customer_campaign_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per customer for a product in a collection. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_promotion_tier_quantity_limit` integer — Limits the number of discounted item units that all customers can receive in a promotion tier. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_promotion_tier_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per promotion tier. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_customer_promotion_tier_quantity_limit` integer — Limits the number of discounted item units that one customer can receive in a given promotion tier. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_customer_promotion_tier_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per customer in a promotion tier. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_in_collection_promotion_tier_quantity_limit` integer — Limits the number of discounted item units of a given product in a collection that all customers can receive in a given promotion tier. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_in_collection_promotion_tier_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per promotion tier for a product in a collection. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_in_collection_customer_promotion_tier_quantity_limit` integer — Limits the number of discounted item units of a given product in a collection that one customer can receive in a promotion tier. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `product_in_collection_customer_promotion_tier_quantity_limit_formula` string — Formula used to dynamically calculate the maximum units per customer in a promotion tier for a product in a collection. This limit is available on demand as part of campaign budget limits. Contact [Voucherify support](https://www.voucherify.io/contact-support) or your account manager to learn more.
            - `order_item_indices` integer[] — Lists which order lines are (not) covered by the discount. The order in the array is determined by the sequence of applied discounts, while the numbers correspond to the order lines sent in the `order` object in the request. The first order line is assigned `0`, the second order line is assigned `1`, and so on.
            - `order_item_units` object[] — Lists which units within order lines are covered by the discount. The order line items are listed according to sequence of applied discounts while the `index` corresponds to the order line sent in the `order` object in the request.
              - …
            - `repeat` integer — Determines the recurrence of the discount, e.g. `"repeat": 3` means that the discount is applied to every third item.
            - `skip_initially` integer — Determines how many items are skipped before the discount is applied.
            - `target` 'ITEM' | 'UNIT' — Determines to which kinds of objects the discount is applicable. `ITEM` includes products and SKUs. `UNIT` means particular units within an order line.
          - `total` integer, required — Total number of objects defining included products, SKUs, or product collections.
          - `object` 'list', required — The type of the object represented by JSON.
          - `data_ref` 'data', required — The type of the object represented by JSON.
        - `metadata` object — The metadata object stores all custom attributes assigned to the product. A set of key/value pairs that you can attach to a product object. It can be useful for storing additional information about the product in a structured format.
        - `categories` CategoryWithStackingRulesType[] — List of category information.
          - `id` string, required — Unique category ID assigned by Voucherify.
          - `name` string, required — Category name.
          - `hierarchy` integer, required — Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value.
          - `object` 'category', required — The type of the object represented by the JSON. This object stores information about the category.
          - `created_at` string, date-time, required — Timestamp representing the date and time when the category was created. The value is shown in the ISO 8601 format.
          - `updated_at` string, date-time — Timestamp representing the date and time when the category was updated. The value is shown in the ISO 8601 format.
          - `stacking_rules_type` 'JOINT' | 'EXCLUSIVE' — The type of the stacking rule eligibility.
        - `banner` string — Name of the earning rule. This is displayed as a header for the earning rule in the Dashboard.
        - `name` string — Name of the redeemable.
        - `campaign_name` string — Name of the campaign associated to the redeemable. This field is available only if object is not `campaign`
        - `campaign_id` string — Id of the campaign associated to the redeemable. This field is available only if object is not `campaign`
        - `validation_rules_assignments` ValidationRulesAssignmentsList — List of Validation Rules Assignments
          - `object` 'list', required — The type of the object represented by JSON. This object stores information about validation rules assignments.
          - `data_ref` 'data', required — Identifies the name of the attribute that contains the array of validation rules assignments.
          - `data` BusValRuleAssignment[], required — Contains array of validation rules assignments.
            - `id` string, required — The unique identifier for a assignment
            - `rule_id` string, required — The unique identifier for a rule
            - `related_object_id` string, required — The unique identifier for a related object
            - `related_object_type` string, required — The type of related object
            - `created_at` string, date-time — Timestamp representing the date and time when the object was created. The value is shown in the ISO 8601 format.
            - `updated_at` string, date-time — Timestamp representing the date and time when the object was last updated in ISO 8601 format.
            - `object` 'validation_rules_assignment', required — The type of the object represented by JSON.
            - `validation_status` 'VALID' | 'PARTIALLY_VALID' | 'INVALID' — The validation status of the assignment
            - `validation_omitted_rules` string[] — The list of omitted rules
          - `total` integer, required — Total number of validation rules assignments.
    - `total` integer, required — The number of redeemables returned in the API request.
    - `has_more` boolean, required — As results are always limited, the `has_more` flag indicates if there are more records for given parameters. This lets you know if you can run another request (with different options) to get more records returned in the results.
    - `more_starting_after` string, date-time — Timestamp representing the date and time to use in `starting_after` cursor to get more redeemables.
  - `tracking_id` string — This identifier is generated during voucher qualification based on your internal id (e.g., email, database ID). This is a hashed customer source ID.
  - `order` object — Order information.
    - `id` string — Unique ID assigned by Voucherify of an existing order that will be linked to the redemption of this request.
    - `source_id` string, nullable — Unique source ID of an existing order that will be linked to the redemption of this request.
    - `status` 'CREATED' | 'PAID' | 'CANCELED' | 'FULFILLED' — The order status.
    - `amount` integer — This is the sum of the order items' amounts. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
    - `initial_amount` integer — This is the sum of the order items' amounts before any discount or other effect (e.g. add missing units) is applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
    - `discount_amount` integer — Sum of all order-level discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
    - `items_discount_amount` integer — Sum of all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
    - `total_discount_amount` integer — Sum of all order-level AND all product-specific discounts applied to the order. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
    - `total_amount` integer — Order amount after undoing all the discounts through the rollback redemption. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
    - `applied_discount_amount` integer — This field shows the order-level discount applied. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00).
    - `items_applied_discount_amount` integer — Sum of all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). `sum(items, i => i.applied_discount_amount)`
    - `total_applied_discount_amount` integer — Sum of all order-level AND all product-specific discounts applied in a particular request. It is expressed as an integer in the smallest currency unit (e.g. 100 cents for $1.00). `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount`
    - `metadata` object — A set of custom key/value pairs that you can attach to an order. It can be useful for storing additional information about the order in a structured format. It can be used to define business validation rules or discount formulas.
    - `object` 'order' — The type of the object represented by JSON.
    - `created_at` string, date-time — Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.
    - `updated_at` string, date-time, nullable — Timestamp representing the date and time when the order was last updated in ISO 8601 format.
    - `customer_id` string, nullable — Unique customer identifier of the customer making the purchase. The ID is assigned by Voucherify.
    - `referrer_id` string, nullable — Unique referrer ID.
    - `customer` CustomerId
      - `id` string, required — A unique identifier of an existing customer.
      - `object` 'customer', required — The type of the object represented by JSON.
    - `referrer` ReferrerId
      - `id` string, required — A unique identifier of an existing customer.
      - `object` 'customer', required — The type of the object represented by JSON.
    - `redemptions` object
    - `items` object[] — Array of items applied to the order. It can include up to 500 items.
      - `id` string — Unique identifier of the order line item.
      - `sku_id` string — Unique identifier of the SKU. It is assigned by Voucherify.
      - `product_id` string — Unique identifier of the product. It is assigned by Voucherify.
      - `related_object` 'product' | 'sku' — Used along with the source_id property, can be set to either sku or product.
      - `source_id` string — The merchant's product/SKU ID (if it is different from the Voucherify product/SKU ID). It is useful in the integration between multiple systems. It can be an ID from an eCommerce site, a database, or a third-party service.
      - `quantity` integer — The quantity of the particular item in the cart.
      - `discount_quantity` integer — Number of dicounted items.
      - `initial_quantity` integer — A positive integer in the smallest unit quantity representing the total amount of the order; this is the sum of the order items' quantity.
      - `amount` integer — The total amount of the order item (price * quantity).
      - `discount_amount` integer — Sum of all order-item-level discounts applied to the order.
      - `applied_discount_amount` integer — This field shows the order-level discount applied.
      - `applied_discount_quantity` integer — Number of the discounted items applied in the transaction.
      - `applied_quantity` integer — Quantity of items changed by the application of a new quantity items. It can be positive when an item is added or negative if an item is replaced.
      - `applied_quantity_amount` integer — Amount for the items changed by the application of a new quantity items. It can be positive when an item is added or negative if an item is replaced.
      - `initial_amount` integer — A positive integer in the smallest currency unit (e.g. 100 cents for $1.00) representing the total amount of the order. This is the sum of the order items' amounts.
      - `price` integer — Unit price of an item. The value is multiplied by 100 to represent 2 decimal places. For example `10000 cents` for `$100.00`.
      - `subtotal_amount` integer — Final order item amount after the applied item-level discount. If there are no item-level discounts applied, this item is equal to the `amount`. `subtotal_amount`=`amount`-`applied_discount_amount`
      - `product` object — An object containing details of the related product.
        - `id` string — A unique identifier that represents the product and is assigned by Voucherify.
        - `source_id` string — The merchant's product ID (if it is different than Voucherify's product ID). It is really useful in case of integration between multiple systems. It can be an ID from an eCommerce site, a database or a 3rd party service.
        - `override` boolean — The override set to `true` is used to store the product information in the system. If the product does not exist, it will be created with a source_id; if it does exist, the provided values for the name, price, and metadata will replace those already stored in the system.
        - `name` string — Product name.
        - `metadata` object — A set of custom key/value pairs that you can attach to a product. It can be useful for storing additional information about the product in a structured format. It can be used to create product collections.
        - `price` number — Product price. A positive integer in the smallest currency unit (e.g. 100 cents for $1.00).
      - `sku` object — An object containing details of the related SKU.
        - `id` string — A unique identifier that represents the SKU and is assigned by Voucherify.
        - `source_id` string — The merchant's SKU ID (if it is different than Voucherify's SKU ID). It is really useful in case of integration between multiple systems. It can be an ID from an eCommerce site, a database or a 3rd party service.
        - `override` boolean — The override set to `true` is used to store the product information in the system. If the product does not exist, it will be created with a source_id; if it does exist, the provided values for the name, price, and metadata will replace those already stored in the system.
        - `sku` string — The SKU name.
        - `price` number — SKU price. A positive integer in the smallest currency unit (e.g. 100 cents for $1.00).
        - `metadata` object — A set of custom key/value pairs that you can attach to an SKU. It can be useful for storing additional information about the SKU in a structured format. It can be used to create product collections.
      - `object` 'order_item', required — The type of the object represented by JSON.
      - `metadata` object — A set of custom key/value pairs that you can attach to an item object. It can be useful for storing additional information about the item in a structured format. It can be used to define business validation rules or discount formulas.
      - `application_details` object[] — Array containing details about the items that are replaced and the items that are replacements for discounts with the `REPLACE_ITEMS` effect.
        - `source_index` integer — Index number of the source item that is replaced. The enumeration starts from `0`, which represents the first item in the request, e.g., if the replaced item is passed as the second in the request, `source_index` equals `3`.
        - `source_applied_quantity` integer — Number of source units that are replaced.
        - `source_applied_quantity_amount` integer — Amount equal to the price of the units that are replaced. Determines the change of the amount of the source item quantity.
        - `target_index` integer — Index number of the target item that is a replacement of the source item. The enumeration continues the values for the order items, e.g. if there are three items in the request, `target_index` equals `3`, as enumeration starts from `0`.
        - `target_applied_quantity` integer — Number of added target units that are replacements.
        - `target_applied_quantity_amount` integer — Amount equal to the price of the units that are replacements. Determines the change in the amount of the target item quantity.
        - `target_applied_discount_amount` integer — Discount amount applied to the target item with regard to the replacement. Equals the `target_applied_quantity_amount` minus `source_applied_quantity_amount`.
  - `stacking_rules` StackingRules — Defines stacking rules for redeemables. Read more in the [Stacking Rule Documentation](/orchestrate/stacking-rules).
    - `redeemables_limit` integer, required — Defines how many redeemables can be sent in one request. Note: more redeemables means more processing time.
    - `applicable_redeemables_limit` integer, required — Defines how many redeemables can be applied in one request. The number must be less than or equal to `redeemables_limit`. For example, a user can select 30 discounts but only 5 will be applied to the order and the remaining will be `SKIPPED` according to the `redeemables_sorting_rule`.
    - `applicable_redeemables_per_category_limit` integer, required — Defines how many redeemables with the same category can be applied in one request. The number must be less than or equal to `applicable_redeemables_limit`. The ones above the limit will be `SKIPPED` according to the `redeemables_sorting_rule`.
    - `applicable_redeemables_category_limits` object, required — Lists categories by category IDs (keys) and defines their limits (values) of applicable redeemables that belong to campaigns with that category.
    - `applicable_exclusive_redeemables_limit` integer, required — Defines how many redeemables with an assigned exclusive category can be applied in one request. The ones above the limit will be `SKIPPED` according to the `redeemables_sorting_rule`.
    - `applicable_exclusive_redeemables_per_category_limit` integer — Defines how many redeemables with an exclusive category per category in stacking rules can be applied in one request. The ones above the limit will be `SKIPPED` according to the `redeemables_sorting_rule`.
    - `exclusive_categories` string[], required — Lists the IDs of exclusive categories. A redeemable from a campaign with an exclusive category is the only redeemable to be redeemed when applied with redeemables from other campaigns unless these campaigns are exclusive or joint.
    - `joint_categories` string[], required — Lists the IDs of the joint categories. A campaign with a joint category is always applied regardless of the exclusivity of other campaigns.
    - `redeemables_application_mode` 'ALL' | 'PARTIAL', required — Defines the application mode for redeemables. `"ALL"` means that all redeemables must be validated for the redemption to be successful. `"PARTIAL"` means that only those redeemables that can be validated will be redeemed. The redeemables that fail validaton will be skipped.
    - `redeemables_sorting_rule` 'CATEGORY_HIERARCHY' | 'REQUESTED_ORDER', required — Defines redeemables sorting rule. `CATEGORY_HIERARCHY` means that redeemables are applied oaccording to the category priority. `REQUESTED_ORDER` means that redeemables are applied in the sequence provided in the request.
    - `redeemables_products_application_mode` 'STACK' | 'ONCE', required — Defines redeemables products application mode. `STACK` means that multiple discounts can be applied to a product. `ONCE` means that only one discount can be applied to the same product.
    - `redeemables_no_effect_rule` 'REDEEM_ANYWAY' | 'SKIP', required — Defines redeemables no effect rule. `REDEEM_ANYWAY` means that the redeemable will be redeemed regardless of any restrictions or conditions in place. `SKIP` means that the redeemable will be processed only when an applicable effect is calculated.
    - `no_effect_skip_categories` string[], required — Lists category IDs. Redeemables with a given category are skipped even if the `redeemables_no_effect_rule` is set to `REDEEM_ANYWAY`. Category IDs can't overlap with the IDs in `no_effect_redeem_anyway_categories`.
    - `no_effect_redeem_anyway_categories` string[], required — Lists category IDs. Redeemables with a given category are redeemed anyway even if the `redeemables_no_effect_rule` is set to `SKIP`. Category IDs can't overlap with the IDs in `no_effect_skip_categories`.
    - `redeemables_rollback_order_mode` 'WITH_ORDER' | 'WITHOUT_ORDER', required — Defines the rollback mode for the order. `WITH_ORDER` is a default setting. The redemption is rolled back together with the data about the order, including related discount values. `WITHOUT_ORDER` allows rolling the redemption back without affecting order data, including the applied discount values.

---

[API](https://skmtc.net/voucherifyio/apis/voucherify-api-async-actions.md) · [All operations](https://skmtc.net/voucherifyio/apis/voucherify-api-async-actions/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/voucherifyio/voucherify-api-async-actions/versions/4982266e0494/schema)