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:
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"position": 6,
|
||||
"collapsed": false,
|
||||
"link": null,
|
||||
"label": "Discounts"
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Discount Conditions Overview
|
||||
|
||||
:::note
|
||||
|
||||
This guide is coming soon.
|
||||
|
||||
:::
|
||||
@@ -0,0 +1,11 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Create a Discount
|
||||
|
||||
:::note
|
||||
|
||||
This guide is coming soon.
|
||||
|
||||
:::
|
||||
@@ -0,0 +1,11 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# Edit a Discount
|
||||
|
||||
:::note
|
||||
|
||||
This guide is coming soon.
|
||||
|
||||
:::
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Discounts Overview
|
||||
|
||||
In this document, you’ll get an overview of the customer listing page and everything you can do with it.
|
||||
|
||||
## Overview
|
||||
|
||||
You can create discounts of different types in Medusa that customers use on checkout:
|
||||
|
||||
- **Percentage Discounts** to deduct a percentage of the total amount of an order.
|
||||
- **Fixed Discounts** to deduct a fixed amount from the total amount of an order.
|
||||
- **Free Shipping** to override the delivery amount of an order and make it free.
|
||||
|
||||
Discounts are in the form of a code that your customers can use. You can set options for a discount such as a start and an end date.
|
||||
|
||||
You can also specify conditions for discounts, such as applying them for specific products or shipping options.
|
||||
|
||||
---
|
||||
|
||||
## View List of Discounts
|
||||
|
||||
You can view the list of available discounts in your ecommerce store by clicking on Discounts from the sidebar menu.
|
||||
|
||||
In the list, you can see discount details such as the code, description, amount, and status.
|
||||
|
||||
---
|
||||
|
||||
## Learn More About Discounts
|
||||
|
||||
- [Discount Conditions Overview](./conditions.md)
|
||||
- [Create a Discount](./create.md)
|
||||
- [Edit a Discount](./edit.md)
|
||||
@@ -1,88 +0,0 @@
|
||||
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.
|
||||
|
||||

|
||||
|
||||
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/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 discount based on the filters you’ve selected.
|
||||
|
||||

|
||||
|
||||
### 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/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.
|
||||
|
||||

|
||||
|
||||
Once you click Save, you should see the new filter you added next to the Quick Filters at the top of the products list.
|
||||
|
||||

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

|
||||
|
||||
:::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/k0U0wpO.png" darkIcon="https://i.imgur.com/IdKjFak.png" alt="magnifier" /> icon at the top right of the discounts list. When you search for discounts, you search by discount codes.
|
||||
|
||||

|
||||
|
||||
## What More Can you Do with Discounts?
|
||||
|
||||
The Discounts pages in the Medusa Admin include many functionalities including:
|
||||
|
||||
- Create a Discount
|
||||
- Edit a Discount
|
||||
Reference in New Issue
Block a user