docs: fixes to discounts documentation percentage (#2711)

* docs: fixes to discounts documentation

* docs: added a note about regions for fixed discount
This commit is contained in:
Shahed Nasser
2022-12-01 17:37:56 +02:00
committed by GitHub
parent b54405e3de
commit c729921180
2 changed files with 7 additions and 7 deletions
@@ -12,8 +12,8 @@ Discounts can be limited by a set of configurations and conditions. For example,
There are three types of discounts:
1. Percentage discount: remove a percentage of the customers total checkout amount.
2. Fixed discount: remove a fixed amount either of the customers total checkout amount or of every product in the cart that the discount can be applied to.
1. Percentage discount: remove a percentage of the price every product in the cart that the discount can be applied to.
2. Fixed discount: remove a fixed amount either of the customers total checkout amount or of the price every product in the cart that the discount can be applied to.
3. Free shipping discount: remove any shipping amount from the customers order during checkout.
### Example Use Cases
@@ -58,8 +58,8 @@ Some of the `DiscountRule` entitys important attributes are:
- `type` is an enum string indicating the type of the discount. It must be either `fixed`, `percentage`, or `free_shipping`.
- `value` is the value to be discounted. The value of this depends on the value of `type`:
- If `type` is `fixed`, `value` will be the amount to be removed either from the total or from each product.
- If `type` is `percentage`, `value` will be the percentage to be removed from the total.
- If `type` is `fixed`, `value` will be the amount to be removed either from the total or from each product this discount is applied to.
- If `type` is `percentage`, `value` will be the percentage to be removed from each product this discount is applied to.
- If `type` is `free_shipping`, `value` will be 0.
- `conditions` is an array of all discount conditions, if there are any.