docs: rearrange user guide (#2127)

* added lists guide

* restructure existing guides

* added new pages after restructuring

* added blank pages + rearranged sidebar
This commit is contained in:
Shahed Nasser authored and GitHub committed 2022-08-30 16:22:06 +03:00
1 parent 5a68665f33
commit f3170ba529
57 files changed
+1331 -1309

No files matched your search

@@ -0,0 +1,6 @@
{
"position": 8,
"collapsed": false,
"link": null,
"label": "Price Lists"
}
@@ -0,0 +1,11 @@
---
sidebar_position: 2
---
# Create a Price List
:::note
This guide is coming soon.
:::
@@ -0,0 +1,11 @@
---
sidebar_position: 4
---
# Delete a Price List
:::note
This guide is coming soon.
:::
@@ -0,0 +1,11 @@
---
sidebar_position: 3
---
# Edit a Price List
:::note
This guide is coming soon.
:::
@@ -0,0 +1,31 @@
---
sidebar_position: 1
---
# 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 to which these prices will be applied. 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.
In the list, you can see price list details such as the name, description, and status of the price list.
---
## Learn More About Price Lists
- [Create a Price List](./create.md)
- [Edit a Price List](./edit.md)
- [Delete a Price List](./delete.md)
@@ -1,93 +0,0 @@
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 <UiIcon lightIcon="https://i.imgur.com/1hL8NiW.png" darkIcon="https://i.imgur.com/8LtkPqW.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 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 <UiIcon lightIcon="https://i.imgur.com/1hL8NiW.png" darkIcon="https://i.imgur.com/8LtkPqW.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/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 <UiIcon lightIcon="https://i.imgur.com/kvGRHQR.png" darkIcon="https://i.imgur.com/RJ4SLIu.png" alt="X" /> icon next to the quick filter’s name, and it will be deleted.
### Clear Filters
To clear all applied filters:
- Click on the <UiIcon lightIcon="https://i.imgur.com/1hL8NiW.png" darkIcon="https://i.imgur.com/8LtkPqW.png" alt="plus" /> 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 <UiIcon lightIcon="https://i.imgur.com/k0U0wpO.png" darkIcon="https://i.imgur.com/IdKjFak.png" alt="magnifier" /> 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.