diff --git a/docs/content/user-guide/discounts/index.mdx b/docs/content/user-guide/discounts/index.mdx index 9a144eae9d..46c9b723c5 100644 --- a/docs/content/user-guide/discounts/index.mdx +++ b/docs/content/user-guide/discounts/index.mdx @@ -22,7 +22,7 @@ If there are more than 15 discounts, the list will be split into multiple pages. You can use filters to retrieve only discounts matching specific criteria. -## Advanced Filters +### Advanced Filters You can use advanced filters to limit the discounts shown based on specific criteria. For example, you can filter discounts to only show dynamic discounts. @@ -36,7 +36,7 @@ This will retrieve the discount based on the filters you’ve selected. ![Advanced filters dropdown with more than one filter selected](https://i.imgur.com/LWPMXG5.png) -## Save Advanced Filters as Quick Filters +### Save Advanced Filters as Quick Filters If there are filters that you need to use frequently, you can give the set of filters a name and save them to be used later. For example, you can save the filters used in the previous example as “Normal Discounts”. @@ -57,7 +57,7 @@ To apply a saved quick filter, just click on it. ### Delete Saved Quick Filters -You can delete any saved filter you’ve created. To do that, simply click on the icon next to the quick filter’s name, and it will be deleted. +You can delete any saved filter you’ve created. To do that, simply click on the icon next to the quick filter’s name, and it will be deleted. ### Clear Filters diff --git a/docs/content/user-guide/orders/index.mdx b/docs/content/user-guide/orders/index.mdx index 738c851078..8c93307e05 100644 --- a/docs/content/user-guide/orders/index.mdx +++ b/docs/content/user-guide/orders/index.mdx @@ -79,7 +79,7 @@ To apply a saved quick filter, just click on it. ### Delete Saved Quick Filters -You can delete any saved filter you’ve created. To do that, simply click on the icon next to the quick filter’s name, and it will be deleted. +You can delete any saved filter you’ve created. To do that, simply click on the icon next to the quick filter’s name, and it will be deleted. ### Clear Filters diff --git a/docs/content/user-guide/price-lists/index.mdx b/docs/content/user-guide/price-lists/index.mdx new file mode 100644 index 0000000000..16e01a26a8 --- /dev/null +++ b/docs/content/user-guide/price-lists/index.mdx @@ -0,0 +1,93 @@ +import UiIcon from '@site/src/components/UiIcon'; + +# Price Lists Overview + +In this document, you learn about what price lists are and get an overview of the Pricing page. + +## Overview + +Price lists are used to add a sale or override the pricing of one or more products based on specific conditions. + +Adding a price list on a set of products would change the prices of these products to an amount you set. You can set the start and end dates of these prices. + +You can also specify customer groups that these prices will be applied to. For example, you may apply reduced pricing for VIP customers. + +## View List of Price Lists + +You can view the list of available price lists in your ecommerce store by clicking on Pricing from the sidebar menu. + +![List of Price Lists](https://i.imgur.com/go5QtbK.png) + +In the list, you can see price list details such as the name, description, and status of the price list. + +:::tip + +If there are more than 15 price lists, the list of price lists will be split into multiple pages. You can navigate between pages by clicking the arrows at the bottom of the list. + +::: + +## Filter Price Lists + +You can use filters to retrieve only price lists matching specific criteria. + +### Advanced Filters + +You can use advanced filters to limit the price lists shown based on specific criteria. For example, you can filter price lists to only show active price lists. + +To use advanced filters: + +- Click on the icon next to Filters. This will toggle a dropdown with categories for different fields. +- You can click on a field name to expand it and choose a filter for that field. +- Click on the Apply button at the top of the dropdown. + +This will retrieve the price lists based on the filters you’ve selected. + +![Advanced filters dropdown with more than one filter selected](https://i.imgur.com/z30iwiK.png) + +### Save Advanced Filters as Quick Filters + +If there are filters that you need to use frequently, you can give the set of filters a name and save them to be used later. For example, you can save the filters used in the previous example as “Active”. + +To save an advanced filter: + +- Click on the icon next to Filters. +- Choose your filters from the dropdown. +- Choose a name for the filters in the input at the end of the dropdown. +- Click the Save button. + +![Give the filters a name and click Save](https://i.imgur.com/eQIbZgS.png) + +Once you click Save, you should see the new filter you added next to the Quick Filters at the top of the list. + +![Saved Filter shows as a quick filter](https://i.imgur.com/54r2lf5.png) + +To apply a saved quick filter, just click on it. + +### Delete Saved Quick Filters + +You can delete any saved filter you’ve created. To do that, simply click on the icon next to the quick filter’s name, and it will be deleted. + +### Clear Filters + +To clear all applied filters: + +- Click on the icon next to Filters. +- Click on the Clear button. + +![Click clear button in the advanced filters dropdown](https://i.imgur.com/25yX8mq.png) + +:::info + +Clearing filters does not delete saved quick filters. You can still apply them by clicking on them. + +::: + +## Search Price Lists + +You can search for price lists by clicking the icon at the top right of the list. When you search for price lists, you search by price list name and description, and customer group names. + +![Search discounts by code](https://i.imgur.com/IqEWTkc.png) + +## What More Can you Do with Price Lists? + +The Pricing pages in the Medusa Admin include many functionalities including creating and managing price lists. \ No newline at end of file diff --git a/docs/content/user-guide/products/index.mdx b/docs/content/user-guide/products/index.mdx index 082def0b94..52a6694c5f 100644 --- a/docs/content/user-guide/products/index.mdx +++ b/docs/content/user-guide/products/index.mdx @@ -93,7 +93,7 @@ To apply a saved quick filter, just click on it. ### Delete Saved Quick Filters -You can delete any saved filter you’ve created. To do that, simply click on the icon next to the quick filter’s name, and it will be deleted. +You can delete any saved filter you’ve created. To do that, simply click on the icon next to the quick filter’s name, and it will be deleted. ### Clear Filters diff --git a/www/docs/sidebars.js b/www/docs/sidebars.js index da3ac0976a..a9bfef963f 100644 --- a/www/docs/sidebars.js +++ b/www/docs/sidebars.js @@ -549,6 +549,17 @@ module.exports = { } ] }, + { + type: "category", + collapsed: false, + label: "Price Lists", + items: [ + { + type: "doc", + id: "user-guide/price-lists/index" + } + ] + }, ], servicesSidebar: [ {