asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: documentation changes for next release (#12773)

Browse Source 
* docs: documentation changes for next release

* add tax inclusive promotion field
This commit is contained in:
Shahed Nasser
2025-06-25 13:00:16 +03:00
committed by GitHub
parent e0b5bb0b22
commit d5259d6ebe
4 changed files with 22 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
www/apps/book/public/llms-full.txt
View File

@@ -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))
***

1
www/apps/resources/app/commerce-modules/payment/payment-provider/stripe/page.mdx
View File

@@ -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))
---

28
www/apps/user-guide/app/products/import/page.mdx
View File

@@ -91,14 +91,6 @@ The columns in the CSV file holds the details of the product variant and its ass
<Table.Cell>`Product Category *`</Table.Cell>
<Table.Cell>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`. </Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Created At`</Table.Cell>
<Table.Cell>The date and time when the product was created.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Deleted At`</Table.Cell>
<Table.Cell>The date and time when the product was deleted.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Discountable`</Table.Cell>
<Table.Cell>Whether the product can be discounted. Can be `true` or `false`.</Table.Cell>
@@ -139,10 +131,6 @@ The columns in the CSV file holds the details of the product variant and its ass
<Table.Cell>`Product Sales Channel *`</Table.Cell>
<Table.Cell>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`.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Updated At`</Table.Cell>
<Table.Cell>The date and time when the product was last updated.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Product Weight`</Table.Cell>
<Table.Cell>The weight of the product.</Table.Cell>
@@ -191,14 +179,6 @@ The columns in the CSV file holds the details of the product variant and its ass
<Table.Cell>`Variant Barcode`</Table.Cell>
<Table.Cell>The barcode of the variant.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Created At`</Table.Cell>
<Table.Cell>The date and time when the variant was created.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Deleted At`</Table.Cell>
<Table.Cell>The date and time when the variant was deleted.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Height`</Table.Cell>
<Table.Cell>The height of the variant.</Table.Cell>
@@ -235,14 +215,6 @@ The columns in the CSV file holds the details of the product variant and its ass
<Table.Cell>`Variant Price [X] Y`</Table.Cell>
<Table.Cell>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]`.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Product Id`</Table.Cell>
<Table.Cell>The ID of the product the variant belongs to.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Updated At`</Table.Cell>
<Table.Cell>The date and time when the variant was last updated.</Table.Cell>
</Table.Row>
<Table.Row>
<Table.Cell>`Variant Variant Rank`</Table.Cell>
<Table.Cell>The rank of the variant among its siblings. Can be `0` or higher.</Table.Cell>

36
www/apps/user-guide/app/promotions/create/page.mdx
View File

@@ -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