docs: docs for next release (#14110)

2025-12-01 20:20:01 +02:00
parent e4513fab88
commit 223ccb4add
24 changed files with 1196 additions and 27 deletions
@@ -57,6 +57,8 @@ To create an order exchange:
        - The shipping method's cost is added to the exchange total. To edit its cost:
            - Click the <InlineIcon Icon={PencilSquare} alt="edit" /> icon next to the Outbound Shipping total.
            - Enter the new cost in the input shown.
+    - If the order has promotions, you can enable the "Carry over promotions" toggle to apply the same promotions to the exchange's items.
+        - You can only carry over fixed promotions with `EACH` allocation type, or percentage promotions of `EACH` or `ACROSS` allocation types. Promotions are carried over to outbound items only.
    - If you want the customer to receive a notification that an exchange has been created, check the “Send notifications” toggle.
 5. Once done, click on the "Confirm Exchange" button, then confirm the action by clicking the "Continue" button in the pop-up.

@@ -95,6 +95,10 @@ If you chose the "Amount off Products" promotion type in the first section, fill
        - Set the Attribute to Product Category.
        - Set the Operator to In.
        - Set the Value to the Shirts product category.
+10. In the Usage Limit field, optionally set the maximum number of times this promotion can be used across all orders.
+    - For example, if you set this field to `10`, the promotion can be used a total of 10 times across all orders. After that, the promotion can't be used anymore.
+    - If left empty, the promotion can be used an unlimited number of times, or until the campaign's usage limit is reached if the promotion is part of a campaign.
+    - You can't update this field after creating the promotion.
 10. Once you're done, click Next and move on to the [next step](#step-3-campaign).

 ![What items will the promotion be applied to section](https://res.cloudinary.com/dza7lstvk/image/upload/v1739898160/User%20Guide/Screenshot_2025-02-18_at_7.02.26_PM_izi1sv.png)
@@ -129,7 +133,11 @@ If you chose the "Amount off Order" promotion type in the first section, fill ou
 ![Who can use this code form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739898239/User%20Guide/Screenshot_2025-02-18_at_7.03.46_PM_iawubi.png)

 6. In the Promotion Value field, set the amount to be discounted from the order when the promotion is applied. The amount is in the currency you chose in the previous section.
-7. Once you're done, click Next and move on to the [next step](#step-3-campaign).
+7. In the Usage Limit field, optionally set the maximum number of times this promotion can be used across all orders.
+    - For example, if you set this field to `10`, the promotion can be used a total of 10 times across all orders. After that, the promotion can't be used anymore.
+    - If left empty, the promotion can be used an unlimited number of times, or until the campaign's usage limit is reached if the promotion is part of a campaign.
+    - You can't update this field after creating the promotion.
+8. Once you're done, click Next and move on to the [next step](#step-3-campaign).

 ### c. Percentage off Product

@@ -185,7 +193,11 @@ If you chose the "Percentage off Product" promotion type in the first section, f
        - Set the Attribute to Product Category.
        - Set the Operator to In.
        - Set the Value to the Shirts product category.
-10. Once you're done, click Next and move on to the [next step](#step-3-campaign).
+10. In the Usage Limit field, optionally set the maximum number of times this promotion can be used across all orders.
+    - For example, if you set this field to `10`, the promotion can be used a total of 10 times across all orders. After that, the promotion can't be used anymore.
+    - If left empty, the promotion can be used an unlimited number of times, or until the campaign's usage limit is reached if the promotion is part of a campaign.
+    - You can't update this field after creating the promotion.
+11. Once you're done, click Next and move on to the [next step](#step-3-campaign).

 ![What items will the promotion be applied to section](https://res.cloudinary.com/dza7lstvk/image/upload/v1739898386/User%20Guide/Screenshot_2025-02-18_at_7.06.14_PM_bdi5jv.png)

@@ -218,7 +230,11 @@ If you chose the "Percentage off Order" promotion type in the first section, fil
 ![Who can use this code section](https://res.cloudinary.com/dza7lstvk/image/upload/v1739898478/User%20Guide/Screenshot_2025-02-18_at_7.07.46_PM_eriyxm.png)

 6. In the Promotion Value field, set the amount to be discounted from applicable products when the promotion is applied. The amount is in the currency you chose in the previous section.
-7. Once you're done, click Next and move on to the [next step](#step-3-campaign).
+7. In the Usage Limit field, optionally set the maximum number of times this promotion can be used across all orders.
+    - For example, if you set this field to `10`, the promotion can be used a total of 10 times across all orders. After that, the promotion can't be used anymore.
+    - If left empty, the promotion can be used an unlimited number of times, or until the campaign's usage limit is reached if the promotion is part of a campaign.
+    - You can't update this field after creating the promotion.
+8. Once you're done, click Next and move on to the [next step](#step-3-campaign).

 ### e. Buy X Get Y

@@ -281,7 +297,11 @@ If you chose the "Buy X Get Y" promotion type in the first section, fill out the
            - Set the Attribute to Product Category.
            - Set the Operator to "Not In".
            - Set the Value to the "Shirt" category.
-7. Once you're done, click Next and move on to the [next step](#step-3-campaign).
+7. In the Usage Limit field, optionally set the maximum number of times this promotion can be used across all orders.
+    - For example, if you set this field to `10`, the promotion can be used a total of 10 times across all orders. After that, the promotion can't be used anymore.
+    - If left empty, the promotion can be used an unlimited number of times, or until the campaign's usage limit is reached if the promotion is part of a campaign.
+    - You can't update this field after creating the promotion.
+8. Once you're done, click Next and move on to the [next step](#step-3-campaign).

 ### f. Free Shipping

@@ -324,7 +344,11 @@ If you chose the "Free Shipping" promotion type in the first section, fill out t
        - Set the Attribute to Shipping Option Type.
        - Set the Operator to In.
        - Set the Value to the "Express" shipping option type.
-6. Once you're done, click Next and move on to the [next step](#step-3-campaign).
+6. In the Usage Limit field, optionally set the maximum number of times this promotion can be used across all orders.
+    - For example, if you set this field to `10`, the promotion can be used a total of 10 times across all orders. After that, the promotion can't be used anymore.
+    - If left empty, the promotion can be used an unlimited number of times, or until the campaign's usage limit is reached if the promotion is part of a campaign.
+    - You can't update this field after creating the promotion.
+7. Once you're done, click Next and move on to the [next step](#step-3-campaign).

 ![What shipping methods will the promotion be applied to section](https://res.cloudinary.com/dza7lstvk/image/upload/v1756368838/User%20Guide/CleanShot_2025-08-28_at_11.13.29_2x_rdcivr.png)

@@ -28,7 +28,7 @@ To view a promotion's details:

 This opens the promotion's details page. The sections in the details page may differ based on the promotion's type.

-![Promotion Details](https://res.cloudinary.com/dza7lstvk/image/upload/v1739951000/User%20Guide/Screenshot_2025-02-19_at_9.42.23_AM_fjpgv7.png)
+![Promotion Details](https://res.cloudinary.com/dza7lstvk/image/upload/v1764580476/User%20Guide/CleanShot_2025-12-01_at_11.03.26_2x_xxxa8m.png)

 ### Promotion Statuses

@@ -65,6 +65,17 @@ A promotion's status is shown in the Promotions listing page, and in the promoti
  </Table.Body>
 </Table>

+### Promotion Limits
+
+In the summary section of the promotion's details page, you can see the usage limit of the promotion, if set during its creation. This is the maximum number of times the promotion can be used across all orders.
+
+A promotion's usage can also be limited by:
+
+1. The campaign's usage limit, if the promotion is part of a campaign. This is the maximum number of times all promotions in the campaign can be used across all orders. You can set this limit when [creating the campaign](../campaigns/page.mdx).
+2. The per-customer usage limit, if the promotion is part of a campaign. This is the maximum number of times a single customer can use promotions in a campaign across all their orders. You can set this limit when [creating the campaign](../campaigns/page.mdx).
+
+Once any of the promotion's limits are reached, the promotion can't be used anymore. For example, if a promotion has a usage limit of 10 and is part of a campaign with a usage limit of 50, the promotion can only be used 10 times even if the campaign's limit hasn't been reached yet.
+
 ---

 ## Edit Promotion's Details