docs: docs for next release (#13621)

* docs: docs for next release * changes to opentelemetry dependencies * document plugin env variables * document admin changes * fix vale error * add version notes * document campaign budget updates * document campaign changes in user guide * document chages in cluster mode cli * documented once promotion allocation * document multiple API keys support
2025-10-21 10:32:08 +03:00
parent f38f0f9aca
commit ed715813a5
54 changed files with 1621 additions and 252 deletions
@@ -56,12 +56,22 @@ To create a campaign:
        - **Spend**: The total amount that can be discounted by the promotions in the campaign. Once the total amount discounted exceeds the limit, the campaign and its promotions expire. This is not applicable to "Buy X Get Y" or "Free Shipping" promotions.
    - If you chose the **Spend** type, select the currency of the limit in the "Currency" field.
        - When adding promotions to the campaign later, promotions that discount a fixed amount can only be added if the currency matches the campaign budget's currency.
-    - In the Limit field, you can set a campaign budget limit based on the type you chose.
+    - In the **Limit** field, you can set a campaign budget limit based on the type you chose.
        - If you chose **Usage**, enter the number of times the promotions in the campaign can be used.
        - If you chose **Spend**, enter the total amount that can be discounted by the promotions in the campaign.
+    - If you chose the **Usage** type, you can optionally set the **Limit usage per** field to apply the limitation for each customer or email.
+        - If you don't select any condition, the limit is applied globally. For example, if the limit is set to 5, the promotions in the campaign can be used a total of 5 times.
+        - If you select "Customer", the limit is applied for each customer based on their unique identifier. For example, if the limit is set to 5, each customer can use the promotions in the campaign 5 times.
+        - If you select "Customer Email", the limit is applied for each customer based on their email address. For example, if the limit is set to 5, each unique email address can use the promotions in the campaign 5 times.
 4. Once you're done, click the Create button.

-![Create Campaign Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1739953632/User%20Guide/Screenshot_2025-02-19_at_10.27.00_AM_u4w38d.png)
+<Note>
+
+The **Limit usage per** field is available from [Medusa Admin v2.11.0](https://github.com/medusajs/medusa/releases/tag/v2.11.0). If you don't see it, request your technical team to [upgrade your Medusa application](!docs!/learn/update).
+
+</Note>
+
+![Create Campaign Form](https://res.cloudinary.com/dza7lstvk/image/upload/v1760349967/User%20Guide/CleanShot_2025-10-13_at_13.05.33_2x_xq5ec5.png)

 ---

@@ -133,6 +143,23 @@ To edit a campaign's budget usage or spending limit:

 ---

+## Information that Can't be Edited in Campaign
+
+After creating a campaign, you can't edit the following information:
+
+1. The campaign's budget type (usage or spend).
+2. The campaign's budget currency (if the type is spend).
+3. The campaign's budget "limit usage per" condition (customer or customer email).
+
+If you need to change any of this information, you should either:
+
+1. [Delete the campaign](#delete-campaign).
+2. Expire the campaign by [setting an end date in the past](#edit-campaign-details).
+
+Then, create a new campaign with the correct information and [add promotions to it](#manage-promotions-of-campaign).
+
+---
+
 ## Manage Promotions of Campaign

 From the campaign's details page, you can manage which promotions belong to the campaign.