Skip to content

Latest commit

 

History

History
28 lines (22 loc) · 3.1 KB

ApplicableTo.md

File metadata and controls

28 lines (22 loc) · 3.1 KB

ApplicableTo

Properties

Name Type Description Notes
object str This object stores information about the resource to which the discount is applicable. [optional]
id str Unique product collection, product, or SKU identifier assigned by Voucherify. [optional]
source_id str The source identifier from your inventory system. [optional]
product_id str Parent product's unique ID assigned by Voucherify. [optional]
product_source_id str Parent product's source ID from your inventory system. [optional]
strict bool [optional]
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
quantity_limit int The maximum number of units allowed to be discounted per order line item. [optional]
aggregated_quantity_limit int The maximum number of units allowed to be discounted combined across all matched order line items. [optional]
amount_limit int 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 int 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 List[int] Determines the order in which the discount is applied to the products or SKUs sent in the `order` object in the request. The counting begins from `0`. [optional]
repeat int Determines the recurrence of the discount, e.g. `"repeat": 3` means that the discount is applied to every third item. [optional]
skip_initially int Determines how many items are skipped before the discount is applied. [optional]
target str Determines to which kinds of objects the discount is applicable. `"ITEM"` includes products and SKUs. [optional]

[Back to Model list] [Back to API list] [Back to README]