voucherifyio/voucherify-ruby-sdk

View on GitHub
docs/ApplicableTo.md

Summary

Maintainability
Test Coverage
# VoucherifySdk::ApplicableTo

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **object** | **String** | This object stores information about the product collection. |  |
| **id** | **String** | Unique product collection ID assigned by Voucherify. |  |
| **source_id** | **String** | The source ID from your inventory system. | [optional] |
| **product_id** | **String** | Parent product's unique ID assigned by Voucherify. | [optional] |
| **product_source_id** | **String** | Parent product's source ID from your inventory system. | [optional] |
| **strict** | **Boolean** |  |  |
| **price** | **Float** | 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. | [optional] |
| **price_formula** | **Float** | Formula used to calculate the discounted price of an item. | [optional] |
| **effect** | [**ApplicableToEffect**](ApplicableToEffect.md) |  |  |
| **quantity_limit** | **Integer** | The maximum number of units allowed to be discounted per order line item. | [optional] |
| **aggregated_quantity_limit** | **Integer** | The maximum number of units allowed to be discounted combined across all matched order line items. | [optional] |
| **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. | [optional] |
| **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) | [optional] |
| **order_item_indices** | **Array<Integer>** |  | [optional] |