diff --git a/docs/content/user-guide/customers/index.mdx b/docs/content/user-guide/customers/index.mdx index ac7a7c220d..94ab3c40a4 100644 --- a/docs/content/user-guide/customers/index.mdx +++ b/docs/content/user-guide/customers/index.mdx @@ -6,7 +6,7 @@ In this document, you’ll get an overview of the customer listing page and all ## View List of Customers -You can view the list of available orders in your ecommerce store by clicking on Customers from the sidebar menu. +You can view the list of available customers in your ecommerce store by clicking on Customers from the sidebar menu. ![Customers List](https://i.imgur.com/VXclXqd.png) diff --git a/docs/content/user-guide/discounts/index.mdx b/docs/content/user-guide/discounts/index.mdx new file mode 100644 index 0000000000..56b3a37561 --- /dev/null +++ b/docs/content/user-guide/discounts/index.mdx @@ -0,0 +1,88 @@ +import UiIcon from '@site/src/components/UiIcon'; + +# Discounts Overview + +In this document, you’ll get an overview of the customer listing page and all the things you can do with it. + +## View List of Discounts + +You can view the list of available discounts in your ecommerce store by clicking on Discounts from the sidebar menu. + +![Discounts List](https://i.imgur.com/buJGt36.png) + +In the list, you can see discount details such as the code, description, amount, and status. + +:::tip + +If there are more than 15 discounts, the list will be split into multiple pages. You can navigate between pages by clicking the arrows at the bottom of the list. + +::: + +## Filter Discounts + +You can use filters to retrieve only discounts matching specific criteria. + +## 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. + +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 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 + +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”. + +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/HjVMQG4.png) + +Once you click Save, you should see the new filter you added next to the Quick Filters at the top of the products list. + +![Saved Filter shows as a quick filter](https://i.imgur.com/Kycxtny.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/98ms0U2.png) + +:::info + +Clearing filters does not delete saved quick filters. You can still apply them by clicking on them. + +::: + +## Search Discounts + +You can search for discounts by clicking the icon at the top right of the discounts list. When you search for discounts, you search by discount codes. + +![Search discounts by code](https://i.imgur.com/zab2oqp.png) + +## What More Can you Do with Discounts? + +The Discounts pages in the Medusa Admin include many functionalities including: + +- Create a Discount +- Edit a Discount diff --git a/docs/content/user-guide/products/index.mdx b/docs/content/user-guide/products/index.mdx index a7a896ef83..456e9bba1b 100644 --- a/docs/content/user-guide/products/index.mdx +++ b/docs/content/user-guide/products/index.mdx @@ -85,7 +85,7 @@ To save an advanced filter: ![Give the filters a name and click Save](https://i.imgur.com/OJ4G1ex.png) -Once you click Save, you should see the new filter you added next to the Quick Filters at the top of the orders list. +Once you click Save, you should see the new filter you added next to the Quick Filters at the top of the products list. ![Saved Filter shows as a quick filter](https://i.imgur.com/BE9RftP.png) diff --git a/www/docs/sidebars.js b/www/docs/sidebars.js index 51bef3722d..ce56e24396 100644 --- a/www/docs/sidebars.js +++ b/www/docs/sidebars.js @@ -527,6 +527,17 @@ module.exports = { } ] }, + { + type: "category", + collapsed: false, + label: "Discounts", + items: [ + { + type: "doc", + id: "user-guide/discounts/index" + } + ] + }, ], servicesSidebar: [ {