From d5259d6ebe80270578a123b37a6fcdace319abe0 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Wed, 25 Jun 2025 13:00:16 +0300 Subject: [PATCH] docs: documentation changes for next release (#12773) * docs: documentation changes for next release * add tax inclusive promotion field --- www/apps/book/public/llms-full.txt | 1 + .../payment/payment-provider/stripe/page.mdx | 1 + .../user-guide/app/products/import/page.mdx | 28 --------------- .../user-guide/app/promotions/create/page.mdx | 36 ++++++++++--------- 4 files changed, 22 insertions(+), 44 deletions(-) diff --git a/www/apps/book/public/llms-full.txt b/www/apps/book/public/llms-full.txt index 7c5542bb15..2eea46ba8a 100644 --- a/www/apps/book/public/llms-full.txt +++ b/www/apps/book/public/llms-full.txt @@ -26612,6 +26612,7 @@ When you set up the webhook in Stripe, choose the following events to listen to: - `payment_intent.amount_capturable_updated` - `payment_intent.succeeded` - `payment_intent.payment_failed` +- `payment_intent.partially_funded` (Since [v2.8.5](https://github.com/medusajs/medusa/releases/tag/v2.8.5)) *** diff --git a/www/apps/resources/app/commerce-modules/payment/payment-provider/stripe/page.mdx b/www/apps/resources/app/commerce-modules/payment/payment-provider/stripe/page.mdx index 82150fbfe6..3439963b97 100644 --- a/www/apps/resources/app/commerce-modules/payment/payment-provider/stripe/page.mdx +++ b/www/apps/resources/app/commerce-modules/payment/payment-provider/stripe/page.mdx @@ -425,6 +425,7 @@ When you set up the webhook in Stripe, choose the following events to listen to: - `payment_intent.amount_capturable_updated` - `payment_intent.succeeded` - `payment_intent.payment_failed` +- `payment_intent.partially_funded` (Since [v2.8.5](https://github.com/medusajs/medusa/releases/tag/v2.8.5)) --- diff --git a/www/apps/user-guide/app/products/import/page.mdx b/www/apps/user-guide/app/products/import/page.mdx index 4286d8c89d..ba1178285c 100644 --- a/www/apps/user-guide/app/products/import/page.mdx +++ b/www/apps/user-guide/app/products/import/page.mdx @@ -91,14 +91,6 @@ The columns in the CSV file holds the details of the product variant and its ass `Product Category *` The ID of a product category, where `*` is the number of the category, allowing you to add more than one category. For example, `Product Category 1`. - - `Product Created At` - The date and time when the product was created. - - - `Product Deleted At` - The date and time when the product was deleted. - `Product Discountable` Whether the product can be discounted. Can be `true` or `false`. @@ -139,10 +131,6 @@ The columns in the CSV file holds the details of the product variant and its ass `Product Sales Channel *` The ID of a sales channel the product is available in, where `*` is the sales channel's number, allowing you to add more than one sales channel. For example, `Product Sales Channel 1`. - - `Product Updated At` - The date and time when the product was last updated. - `Product Weight` The weight of the product. @@ -191,14 +179,6 @@ The columns in the CSV file holds the details of the product variant and its ass `Variant Barcode` The barcode of the variant. - - `Variant Created At` - The date and time when the variant was created. - - - `Variant Deleted At` - The date and time when the variant was deleted. - `Variant Height` The height of the variant. @@ -235,14 +215,6 @@ The columns in the CSV file holds the details of the product variant and its ass `Variant Price [X] Y` The price of the variant in a region, where `X` is the region's name, and `Y` is the ISO currency code of the region. For example, `Variant Price Europe [EUR]`. - - `Variant Product Id` - The ID of the product the variant belongs to. - - - `Variant Updated At` - The date and time when the variant was last updated. - `Variant Variant Rank` The rank of the variant among its siblings. Can be `0` or higher. diff --git a/www/apps/user-guide/app/promotions/create/page.mdx b/www/apps/user-guide/app/promotions/create/page.mdx index b2a67a5934..268b89c515 100644 --- a/www/apps/user-guide/app/promotions/create/page.mdx +++ b/www/apps/user-guide/app/promotions/create/page.mdx @@ -52,7 +52,8 @@ If you chose the "Amount off Products" promotion type in the first section, fill - **Automatic**: The promotion is applied automatically if the customer's cart matches the promotion's conditions. 2. For the Status, choose **Draft** if you don't want to allow customers to use the promotion yet, or **Active** otherwise. 3. In the Code field, enter the promotion's code. It must be a code that doesn't have spaces. For example, `50OFF`. -4. In the "Who can use this code?" section, you'll specify the conditions that must be met for the promotion to be applicable for a customer's cart. +4. The "Does promotion include taxes" field allows you to customize when the promotion is applied on the cart. By default, this field is disabled, meaning the promotion is applied on the cart total before taxes. Enable this field to apply the promotion on the cart total after taxes. +5. In the "Who can use this code?" section, you'll specify the conditions that must be met for the promotion to be applicable for a customer's cart. - You must set the currency code that this promotion applies to, which is shown as a required field. - To add a custom condition, click on the "Add condition" button. For each condition: - Select the attribute in the first field. This is the attribute that the condition applies to. It can be: @@ -72,9 +73,9 @@ If you chose the "Amount off Products" promotion type in the first section, fill ![Who can use this section](https://res.cloudinary.com/dza7lstvk/image/upload/v1739898104/User%20Guide/Screenshot_2025-02-18_at_7.01.14_PM_wvskll.png) -5. 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. -6. In the Maximum Quantity field, set the maximum quantity of the applicable that the promotion is applied to in the cart. For example, if set to `1` and the customer has two applicable items in the cart, the promotion is only applied to one of them. -7. In the "What items will the promotion be applied to?" section, you'll specify the items in the cart that the promotion can be applied to. To add a condition, click on the "Add condition" button. For each condition: +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. In the Maximum Quantity field, set the maximum quantity of the applicable that the promotion is applied to in the cart. For example, if set to `1` and the customer has two applicable items in the cart, the promotion is only applied to one of them. +8. In the "What items will the promotion be applied to?" section, you'll specify the items in the cart that the promotion can be applied to. To add a condition, click on the "Add condition" button. For each condition: - Select the attribute in the first field. This is the attribute that the condition applies to. It can be: - **Product**: The promotion applies / doesn't apply to the specified product(s). - **Product Category**: The promotion applies / doesn't apply to the products belonging to the specified categories. @@ -90,7 +91,7 @@ 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 or Equals. - Set the Value to the Shirts product category. -8. Once you're done, click Next and move on to the [next step](#step-3-campaign). +9. 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) @@ -103,7 +104,8 @@ If you chose the "Amount off Order" promotion type in the first section, fill ou - **Automatic**: The promotion is applied automatically if the customer's cart matches the promotion's conditions. 2. For the Status, choose Draft if you don't want to allow customers to use the promotion yet, or Active otherwise. 3. In the Code field, enter the promotion's code. It must be a code that doesn't have spaces. For example, `50OFF`. -4. In the "Who can use this code?" section, you'll specify the conditions that must be met for the promotion to be applicable for a customer's cart. +4. The "Does promotion include taxes" field allows you to customize when the promotion is applied on the cart. By default, this field is disabled, meaning the promotion is applied on the cart total before taxes. Enable this field to apply the promotion on the cart total after taxes. +5. In the "Who can use this code?" section, you'll specify the conditions that must be met for the promotion to be applicable for a customer's cart. - You must set the currency code that this promotion applies to, which is shown as a required field. - To add a custom condition, click on the "Add condition" button. For each condition: - Select the attribute in the first field. This is the attribute that the condition applies to. It can be: @@ -123,8 +125,8 @@ 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) -5. 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. -6. Once you're done, click Next and move on to the [next step](#step-3-campaign). +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). ### c. Percentage off Product @@ -135,7 +137,8 @@ If you chose the "Percentage off Product" promotion type in the first section, f - **Automatic**: The promotion is applied automatically if the customer's cart matches the promotion's conditions. 2. For the Status, choose Draft if you don't want to allow customers to use the promotion yet, or Active otherwise. 3. In the Code field, enter the promotion's code. It must be a code that doesn't have spaces. For example, `50OFF`. -4. In the "Who can use this code?" section, you'll specify the conditions that must be met for the promotion to be applicable for a customer's cart. To add a condition, click on the "Add condition" button. For each condition: +4. The "Does promotion include taxes" field allows you to customize when the promotion is applied on the cart. By default, this field is disabled, meaning the promotion is applied on the cart total before taxes. Enable this field to apply the promotion on the cart total after taxes. +5. In the "Who can use this code?" section, you'll specify the conditions that must be met for the promotion to be applicable for a customer's cart. To add a condition, click on the "Add condition" button. For each condition: - Select the attribute in the first field. This is the attribute that the condition applies to. It can be: - **Customer Group**: The customer must belong / not belong to the specified customer group(s). - **Region**: The customer's region must belong / not belong to the specified region(s). @@ -154,9 +157,9 @@ If you chose the "Percentage off Product" promotion type in the first section, f ![Who can use this code section](https://res.cloudinary.com/dza7lstvk/image/upload/v1739898340/User%20Guide/Screenshot_2025-02-18_at_7.05.27_PM_yircnf.png) -5. 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. -6. In the Maximum Quantity field, set the maximum quantity of the applicable that the promotion is applied to in the cart. For example, if set to `1` and the customer has two applicable items in the cart, the promotion is only applied to one of them. -7. In the "What items will the promotion be applied to?" section, you'll specify the items in the cart that the promotion can be applied to. To add a condition, click on the "Add condition" button. For each condition: +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. In the Maximum Quantity field, set the maximum quantity of the applicable that the promotion is applied to in the cart. For example, if set to `1` and the customer has two applicable items in the cart, the promotion is only applied to one of them. +8. In the "What items will the promotion be applied to?" section, you'll specify the items in the cart that the promotion can be applied to. To add a condition, click on the "Add condition" button. For each condition: - Select the attribute in the first field. This is the attribute that the condition applies to. It can be: - **Product**: The promotion applies / doesn't apply to the specified product(s). - **Product Category**: The promotion applies / doesn't apply to the products belonging to the specified categories. @@ -172,7 +175,7 @@ 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 or Equals. - Set the Value to the Shirts product category. -8. Once you're done, click Next and move on to the [next step](#step-3-campaign). +9. 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) @@ -185,7 +188,8 @@ If you chose the "Percentage off Order" promotion type in the first section, fil - **Automatic**: The promotion is applied automatically if the customer's cart matches the promotion's conditions. 2. For the Status, choose Draft if you don't want to allow customers to use the promotion yet, or Active otherwise. 3. In the Code field, enter the promotion's code. It must be a code that doesn't have spaces. For example, `50OFF`. -4. In the "Who can use this code?" section, you'll specify the conditions that must be met for the promotion to be applicable for a customer's cart. To add a condition, click on the "Add condition" button. For each condition: +4. The "Does promotion include taxes" field allows you to customize when the promotion is applied on the cart. By default, this field is disabled, meaning the promotion is applied on the cart total before taxes. Enable this field to apply the promotion on the cart total after taxes. +5. In the "Who can use this code?" section, you'll specify the conditions that must be met for the promotion to be applicable for a customer's cart. To add a condition, click on the "Add condition" button. For each condition: - Select the attribute in the first field. This is the attribute that the condition applies to. It can be: - **Customer Group**: The customer must belong / not belong to the specified customer group(s). - **Region**: The customer's region must belong / not belong to the specified region(s). @@ -204,8 +208,8 @@ 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) -5. 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. -6. Once you're done, click Next and move on to the [next step](#step-3-campaign). +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). ### e. Buy X Get Y