docs: Added "Discounts Overview" to User Guide (#2084)

* small fixes to customers

* small fixes to products

* docs: added "Discounts Overview" page
This commit is contained in:
Shahed Nasser
2022-08-23 18:06:23 +03:00
committed by GitHub
parent 136a98ea07
commit 687a6badeb
4 changed files with 101 additions and 2 deletions

View File

@@ -6,7 +6,7 @@ In this document, youll 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)

View File

@@ -0,0 +1,88 @@
import UiIcon from '@site/src/components/UiIcon';
# Discounts Overview
In this document, youll 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 <UiIcon lightIcon="https://i.imgur.com/alMqdZW.png" darkIcon="https://i.imgur.com/He8m6qd.png" alt="plus" /> 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 youve 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 <UiIcon lightIcon="https://i.imgur.com/alMqdZW.png" darkIcon="https://i.imgur.com/He8m6qd.png" alt="plus" /> 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 youve created. To do that, simply click on the <UiIcon lightIcon="https://i.imgur.com/FFwnF0m.png" darkIcon="https://i.imgur.com/ZZN7BfE.png" alt="X" /> icon next to the quick filters name, and it will be deleted.
### Clear Filters
To clear all applied filters:
- Click on the <UiIcon lightIcon="https://i.imgur.com/alMqdZW.png" darkIcon="https://i.imgur.com/He8m6qd.png" alt="plus" /> 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 <UiIcon lightIcon="https://i.imgur.com/efyG8WQ.png" darkIcon="https://i.imgur.com/NgocLvX.png" alt="magnifier" /> 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

View File

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

View File

@@ -527,6 +527,17 @@ module.exports = {
}
]
},
{
type: "category",
collapsed: false,
label: "Discounts",
items: [
{
type: "doc",
id: "user-guide/discounts/index"
}
]
},
],
servicesSidebar: [
{