asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: rearrange user guide (#2127)

Browse Source 
* added lists guide

* restructure existing guides

* added new pages after restructuring

* added blank pages + rearranged sidebar
This commit is contained in:
Shahed Nasser
2022-08-30 16:22:06 +03:00
committed by GitHub
parent 5a68665f33
commit f3170ba529
57 changed files with 1331 additions and 1309 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/content/user-guide/customers/_category_.json Normal file
View File

@@ -0,0 +1,6 @@
{
"position": 5,
"collapsed": false,
"link": null,
"label": "Customers"
}

11
docs/content/user-guide/customers/groups.md Normal file
View File

@@ -0,0 +1,11 @@
---
sidebar_position: 3
---
# Manage Customer Groups
:::note
This guide is coming soon.
:::

36
docs/content/user-guide/customers/index.md Normal file
View File

@@ -0,0 +1,36 @@
---
sidebar_position: 1
---
# Customers Overview
In this document, you’ll get an overview of the customer listing page and all the things you can do with it.
## Overview
You can find the list of signed up customers on your store in the Customers page. For each of those customers, you can view details such as their orders, or personal information.
Part of the Customers domain is also Customer Groups. Customer groups allow you to put together a set of customers for business purposes. For example, you can create a VIP customer group for customers that you want to give special discounts.
---
## View List of Customers
You can view the list of available customers in your ecommerce store by clicking on Customers from the sidebar menu.
In the list, you can see customer details such as the customer’s name, email address, and the number of orders.
---
## View List of Customer Groups
You can view the list of customer groups on the Customer Groups page by clicking on the grey Groups headline next to the Customers headline.
In the list, you can see group details such as the group’s title and the number of customers in the group.
---
## Learn More About Customers
- [Manage and View a Customer’s Details](./manage.md)
- [Manage and View a Customer Group](./groups.md)

54
docs/content/user-guide/customers/index.mdx
View File

@@ -1,54 +0,0 @@
import UiIcon from '@site/src/components/UiIcon';
# Customers 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 Customers
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)
In the list, you can see customer details such as the customer’s name, email address, and the number of orders.
:::tip
If there are more than 15 customers, the list will be split into multiple pages. You can navigate between pages by clicking the arrows at the bottom of the list.
:::
## View List of Customer Groups
Customer groups allow you to put together a set of customers for business purposes. For example, you can create a VIP customer group for customers that you want to give special discounts.
You can view the list of customer groups on the Customer Groups page by clicking on the grey Groups headline next to the Customers headline.
![Customer Groups List](https://i.imgur.com/z1nEvhX.png)
In the list, you can see group details such as the group’s title and the number of customers in the group.
:::tip
If there are more than 15 customer groups, the list will be split into multiple pages. You can navigate between pages by clicking the arrows at the bottom of the list.
:::
## Search Customers
You can search for customers 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 customer list. When you search for customers, you search by their first name, last name, and email.
![Search customers by name](https://i.imgur.com/c0IFMej.png)
## Search Customer Groups
You can search for customer groups 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 group list. When you search groups, you search by the customer group’s title.
![Search customer groups by title](https://i.imgur.com/aksN5eW.png)
## What More Can you Do with Customers?
The Customers pages in the Medusa Admin include many functionalities including:
- Manage and View a Customer’s Details
- Manage and View a Customer Group

11
docs/content/user-guide/customers/manage.md Normal file
View File

@@ -0,0 +1,11 @@
---
sidebar_position: 2
---
# Manage Customers
:::note
This guide is coming soon.
:::

6
docs/content/user-guide/discounts/_category_.json Normal file
View File

@@ -0,0 +1,6 @@
{
"position": 6,
"collapsed": false,
"link": null,
"label": "Discounts"
}

11
docs/content/user-guide/discounts/conditions.md Normal file
View File

@@ -0,0 +1,11 @@
---
sidebar_position: 2
---
# Discount Conditions Overview
:::note
This guide is coming soon.
:::

11
docs/content/user-guide/discounts/create.md Normal file
View File

@@ -0,0 +1,11 @@
---
sidebar_position: 3
---
# Create a Discount
:::note
This guide is coming soon.
:::

11
docs/content/user-guide/discounts/edit.md Normal file
View File

@@ -0,0 +1,11 @@
---
sidebar_position: 4
---
# Edit a Discount
:::note
This guide is coming soon.
:::

35
docs/content/user-guide/discounts/index.md Normal file
View File

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

88
docs/content/user-guide/discounts/index.mdx
View File

@@ -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.
![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/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.
![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/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/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 <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/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/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.
![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

6
docs/content/user-guide/gift-cards/_category_.json Normal file
View File

@@ -0,0 +1,6 @@
{
"position": 7,
"collapsed": false,
"link": null,
"label": "Gift Cards"
}

11
docs/content/user-guide/gift-cards/custom.md Normal file
View File

@@ -0,0 +1,11 @@
---
sidebar_position: 3
---
# Manage Custom Gift Cards
:::note
This guide is coming soon.
:::

18
docs/content/user-guide/gift-cards/index.md Normal file
View File

@@ -0,0 +1,18 @@
---
sidebar_position: 1
---
# Gift Cards Overview
In this document, you’ll learn about how Gift Cards in Medusa work.
## Overview
In Medusa, there’s one main gift card. A gift card can have multiple denominations. For example, a Gift Card can have the amounts of $20 and $50, and customers can buy one of these denominations.
You can also create custom gift cards in Medusa. These cards can be created and sent directly to a customer’s email.
## Learn More About Gift Cards
- [Manage Gift Cards](./manage.mdx)
- [Manage Custom Gift Cards](./custom.md)

240
docs/content/user-guide/gift-cards/index.mdx
View File

@@ -1,240 +0,0 @@
import UiIcon from '@site/src/components/UiIcon';
# Manage a Gift Card
In this document, you’ll learn about how Gift Cards in Medusa work. This includes how to create, edit, and delete them.
## Overview
In Medusa, there’s one main gift card. A gift card can have multiple denominations. For example, a Gift Card can have the amounts of $20 and $50, and customers can buy one of these denominations.
:::info
Medusa also supports custom gift cards, which can be sent to a specific customer.
:::
## Create Gift Card
:::info
You can only create one gift card per store.
:::
Click on Gift Cards in the sidebar menu. If you don’t have any gift cards you should see a prompt to create your first gift card. Click on Create Gift Card.
![Click on Create Gift Card in Gift Cards page](https://i.imgur.com/KjfMARd.png)
In the new window that opens:
- Enter a name for the gift card
- You can optionally enter a description and a thumbnail.
- Click on Add Denomination. You must at least add one denomination
- For each denomination, choose the currency and amount.
- If you want to delete a denomination, you can click the <UiIcon lightIcon="https://i.imgur.com/7hztVhj.png" darkIcon="https://i.imgur.com/1yp4PNt.png" alt="trash" /> icon.
- Once you’re done, click Create & Publish.
:::tip
If you want to add more than one currency value for a denomination, you can do that when you [edit a denomination](#edit-a-denomination).
:::
![Example of fields in Create Gift Card window](https://i.imgur.com/xftW9bj.png)
## Edit Gift Card
To edit a Gift Card:
- Go to the Gift Cards page from the sidebar menu.
- Next to the main gift card, click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon.
- Choose Edit from the dropdown.
![Edit link is the first one in the dropdown](https://i.imgur.com/2PM0tBO.png)
This opens a form to edit the gift card details and denominations.
### Edit Gift Card Information
You can edit the name, subtitle, and description of a Gift card.
You can also click on “Show additional details”. Here, you can change the handle of the gift card, tags, and product type.
After making the edits, click Save at the bottom right of the page.
:::info
The handle is the URL used on the storefront to view the Gift Card.
:::
![Example of Gift Card Information form](https://i.imgur.com/x2PMJum.png)
### Add a Denomination
On the Denominations section, click on Add Denomination at the top right of the section.
![Click on Add Denomination at the top right of the section](https://i.imgur.com/bDlqOCS.png)
In the window that opens:
- Choose the currency of the denomination
- Enter the amount of the denomination
- Optionally, you can enter other values for the denominations. This is useful if you want to enter an amount in another currency. To do that:
- Click on “Add a price” under Other Values.
- Choose the currency and amount.
- To delete a price under Other Values, click on the <UiIcon lightIcon="https://i.imgur.com/7hztVhj.png" darkIcon="https://i.imgur.com/1yp4PNt.png" alt="trash" /> icon.
- Once you’re done, click Save.
![Example of Add Denomination form](https://i.imgur.com/5fAosFQ.png)
### Edit a Denomination
To edit a denomination:
- In the Denominations section, find the denomination you want to edit.
- Click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon in the same row as the denomination you want to edit.
- Click on Edit Denomination from the dropdown.
![Edit denomination is the first link in the dropdown](https://i.imgur.com/F4lBLkW.png)
This opens a new window to edit the denomination. You can then:
- Edit the currency or amount of existing prices of the denomination.
- Add prices for other currencies by clicking “Add a price”
- Delete prices by clicking the <UiIcon lightIcon="https://i.imgur.com/7hztVhj.png" darkIcon="https://i.imgur.com/1yp4PNt.png" alt="trash" /> icon.
Once you’re done, click Save.
![Example of Edit Denomination form](https://i.imgur.com/qPNXCI6.png)
### Delete a Denomination
:::warning
If you delete a denomination, customers won’t be able to find it in the storefront, purchase it, or use it.
:::
To delete a denomination:
- In the Denominations section, find the denomination you want to edit.
- Click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon in the same row as the denomination you want to delete.
- Click on Delete Denomination from the dropdown.
- Confirm deleting the denomination by clicking the “Yes, delete” button in the pop-up.
![Delete denomination link is the second link in the dropdown](https://i.imgur.com/OrgV3wb.png)
### Add Images
:::info
You can add up to 10 images for a Gift Card.
:::
To add images to the Gift Card:
- Go to the Images section.
- Either drag and drop your image to the dashed box or click on the box and choose the image you want to add.
- Click Save at the bottom right of the page.
:::note
If you face any errors or difficulties while uploading an image, please contact your technical support team as this could be an issue in the storage integration used.
:::
![The save button is at the bottom right of the page](https://i.imgur.com/lwyxPnz.png)
### Change Thumbnail Image
:::note
You must have more than one image for a gift card to change the thumbnail image.
:::
To change the thumbnail image:
- Go to the Images section.
- Check the radio button under the Thumbnail column for the image you want to make the thumbnail.
- Click Save at the bottom right of the page.
![Check the radio button and click save at the bottom right](https://i.imgur.com/2Cz6s21.png)
### Delete Gift Card Image
:::warning
If you delete an image, you won’t be able to restore it.
:::
To delete a gift card image:
- Go to the Images section.
- Click on the <UiIcon lightIcon="https://i.imgur.com/7hztVhj.png" darkIcon="https://i.imgur.com/1yp4PNt.png" alt="trash" /> icon at the right of the image you want to delete.
- Click Save at the bottom right of the page.
## Unpublish Gift Card
:::caution
Unpublishing a gift card prevents customers from seeing the gift card in the storefront, purchasing it, or using it.
:::
### On Gift Cards Page
- Click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon at the top right of the main gift card.
- Choose Unpublish.
![Unpublish link is the second link in the dropdown](https://i.imgur.com/jF1vwyO.png)
### On Edit Gift Card Page
- Click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon at the top right of the Product Information section.
- Choose Unpublish Gift Card from the dropdown.
![Unpublish Gift Card link is the first link in the dropdown](https://i.imgur.com/L09A4Pr.png)
## Publish Gift Card
:::note
Publishing a gift card allows customers to see the gift card on the storefront, purchase it, and use it.
:::
### On Gift Cards Page
- Click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon at the top right of the main gift card.
- Choose Publish.
![Publish link is the second link in the dropdown](https://i.imgur.com/PfaDRqr.png)
### On Edit Gift Card Page
- Click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon at the top right of the Product Information section.
- Choose Publish Gift Card from the dropdown.
![Publish Gift Card link is the first link in the dropdown](https://i.imgur.com/9AwA8wH.png)
## Delete Gift Card
:::warning
If you delete a gift card, you can’t restore it or its settings. Customers also can’t use the gift card if they had previously purchased it.
:::
To delete a gift card:
- Go to the Gift Cards page from the sidebar menu.
- Next to the main gift card, click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon.
- Choose Delete from the dropdown.
- Confirm deleting the gift card by clicking the “Yes, delete” button in the pop-up.
![Delete link is the third link in the dropdown](https://i.imgur.com/Ue1zeUm.png)

209
docs/content/user-guide/gift-cards/manage.mdx Normal file
View File

@@ -0,0 +1,209 @@
---
sidebar_position: 2
---
import UiIcon from '@site/src/components/UiIcon';
# Manage a Gift Card
In this document, you’ll learn about managing gift cards, including how to create, edit, and delete them.
## Create Gift Card
:::info
You can only create one gift card per store.
:::
Click on Gift Cards in the sidebar menu. If you don’t have any gift cards you should see a prompt to create your first gift card.
To create a Gift Card:
1. Click on Create Gift Card.
2. In the new window that opens:
- Enter a name for the gift card
- You can optionally enter a description and a thumbnail.
- Click on Add Denomination. You must at least add one denomination
- For each denomination, choose the currency and amount.
- If you want to delete a denomination, you can click the <UiIcon lightIcon="https://i.imgur.com/7hztVhj.png" darkIcon="https://i.imgur.com/1yp4PNt.png" alt="trash" /> icon.
3. Once you’re done, click Create & Publish.
:::tip
If you want to add more than one currency value for a denomination, you can do that when you [edit a denomination](#edit-a-denomination).
:::
---
## Edit Gift Card
To edit a Gift Card:
1. Go to the Gift Cards page from the sidebar menu.
2. Next to the main gift card, click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon.
3. Choose Edit from the dropdown.
This opens a form to edit the gift card details and denominations.
### Edit Gift Card Information
You can edit the name, subtitle, and description of a Gift card.
You can also click on “Show additional details”. Here, you can change the handle of the gift card, tags, and product type.
After making the edits, click Save at the bottom right of the page.
:::info
The handle is the URL used on the storefront to view the Gift Card.
:::
### Add a Denomination
On the Denominations section, click on Add Denomination at the top right of the section.
In the window that opens:
1. Choose the currency of the denomination
2. Enter the amount of the denomination
3. Optionally, you can enter other values for the denominations. This is useful if you want to enter an amount in another currency. To do that:
- Click on “Add a price” under Other Values.
- Choose the currency and amount.
- To delete a price under Other Values, click on the <UiIcon lightIcon="https://i.imgur.com/7hztVhj.png" darkIcon="https://i.imgur.com/1yp4PNt.png" alt="trash" /> icon.
4. Once you’re done, click Save.
### Edit a Denomination
To edit a denomination:
1. In the Denominations section, find the denomination you want to edit.
2. Click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon in the same row as the denomination you want to edit.
3. Click on Edit Denomination from the dropdown.
4. This opens a new window to edit the denomination. You can then:
- Edit the currency or amount of existing prices of the denomination.
- Add prices for other currencies by clicking “Add a price”
- Delete prices by clicking the <UiIcon lightIcon="https://i.imgur.com/7hztVhj.png" darkIcon="https://i.imgur.com/1yp4PNt.png" alt="trash" /> icon.
5. Once you’re done, click Save.
### Delete a Denomination
:::warning
If you delete a denomination, customers won’t be able to find it in the storefront, purchase it, or use it.
:::
To delete a denomination:
1. In the Denominations section, find the denomination you want to edit.
2. Click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon in the same row as the denomination you want to delete.
3. Click on Delete Denomination from the dropdown.
4. Confirm deleting the denomination by clicking the “Yes, delete” button in the pop-up.
### Add Images
:::info
You can add up to 10 images for a Gift Card.
:::
To add images to the Gift Card:
1. Go to the Images section.
2. Either drag and drop your image to the dashed box or click on the box and choose the image you want to add.
3. Click Save at the bottom right of the page.
:::note
If you face any errors or difficulties while uploading an image, please contact your technical support team as this could be an issue in the storage integration used.
:::
### Change Thumbnail Image
:::info
You must have more than one image for a gift card to change the thumbnail image.
:::
To change the thumbnail image:
1. Go to the Images section.
2. Check the radio button under the Thumbnail column for the image you want to make the thumbnail.
3. Click Save at the bottom right of the page.
### Delete Gift Card Image
:::caution
If you delete an image, you won’t be able to restore it.
:::
To delete a gift card image:
1. Go to the Images section.
2. Click on the <UiIcon lightIcon="https://i.imgur.com/7hztVhj.png" darkIcon="https://i.imgur.com/1yp4PNt.png" alt="trash" /> icon at the right of the image you want to delete.
3. Click Save at the bottom right of the page.
---
## Unpublish Gift Card
:::caution
Unpublishing a gift card prevents customers from seeing the gift card in the storefront, purchasing it, or using it.
:::
### On Gift Cards Page
1. Click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon at the top right of the main gift card.
2. Choose Unpublish.
### On Edit Gift Card Page
1. Click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon at the top right of the Product Information section.
2. Choose Unpublish Gift Card from the dropdown.
---
## Publish Gift Card
:::note
Publishing a gift card allows customers to see the gift card on the storefront, purchase it, and use it.
:::
### On Gift Cards Page
1. Click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon at the top right of the main gift card.
2. Choose Publish.
### On Edit Gift Card Page
1. Click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon at the top right of the Product Information section.
2. Choose Publish Gift Card from the dropdown.
---
## Delete Gift Card
:::warning
If you delete a gift card, you can’t restore it or its settings. Customers also can’t use the gift card if they had previously purchased it.
:::
To delete a gift card:
1. Go to the Gift Cards page from the sidebar menu.
2. Click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon next to the main gift card.
3. Choose Delete from the dropdown.
4. Confirm deleting the gift card by clicking the “Yes, delete” button in the pop-up.

5
docs/content/user-guide/index.mdx
View File

@@ -1,3 +1,8 @@
---
sidebar_position: 1
sidebar_label: Introduction
---
import UiIcon from '@site/src/components/UiIcon';
# Welcome to Medusa’s User Guide

89
docs/content/user-guide/lists.mdx Normal file
View File

@@ -0,0 +1,89 @@
---
sidebar_position: 2
---
import UiIcon from '@site/src/components/UiIcon';
# Lists Overview
In this document, you’ll get an overview of lists in Medusa including filters, searching, and more!
## Filter Items
You can use filters to retrieve only items in a list matching specific criteria.
### Quick Filters
On a table with a list of items, you’ll find quick filters at the top of the list.
You can click on one of these filters to quickly apply it to the list of items.
![https://i.imgur.com/eVwD0JP.png](https://i.imgur.com/eVwD0JP.png)
### Advanced Filters
You can use advanced filters to furthermore limit the items shown based on specific criteria. For example, on the Orders list, you can filter orders to only show pending orders created in a specific region.
To use advanced filters:
1. 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.
2. You can click on a field name to expand it and choose a filter for that field.
3. Click on the Apply button at the top of the dropdown.
This will retrieve the items based on the filters you’ve selected.
![https://i.imgur.com/rg9nKcS.png](https://i.imgur.com/rg9nKcS.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 “European Orders”.
To save an advanced filter:
1. Click on the <UiIcon lightIcon="https://i.imgur.com/1hL8NiW.png" darkIcon="https://i.imgur.com/8LtkPqW.png" alt="plus" /> icon next to Filters.
2. Choose your filters from the dropdown.
3. Choose a name for the filters in the input at the end of the dropdown.
4. Click the Save button.
![https://i.imgur.com/0nKZ5BX.png](https://i.imgur.com/0nKZ5BX.png)
Once you click Save, you should see the new filter you added next to the Quick Filters at the top of the list.
![https://i.imgur.com/ymuSHkv.png](https://i.imgur.com/ymuSHkv.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:
1. Click on the <UiIcon lightIcon="https://i.imgur.com/1hL8NiW.png" darkIcon="https://i.imgur.com/8LtkPqW.png" alt="plus" /> icon next to Filters.
2. Click on the Clear button.
![https://i.imgur.com/ArawLDT.png](https://i.imgur.com/ArawLDT.png)
:::info
Clearing filters does not delete saved quick filters. You can still apply them by clicking on them.
:::
---
## Search Items
You can search for items in a list 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.
![https://i.imgur.com/Z09rbmQ.png](https://i.imgur.com/Z09rbmQ.png)
---
## Multiple Pages
Lists in the Medusa admin can span across multiple pages if the number of items in that list are more than 15.
In that case, you can navigate between pages by clicking the arrows at the bottom of the list.

6
docs/content/user-guide/orders/_category_.json Normal file
View File

@@ -0,0 +1,6 @@
{
"position": 3,
"collapsed": false,
"link": null,
"label": "Orders"
}

11
docs/content/user-guide/orders/claims.md Normal file
View File

@@ -0,0 +1,11 @@
---
sidebar_position: 8
---
# Manage Claims
:::note
This guide is coming soon.
:::

11
docs/content/user-guide/orders/drafts.md Normal file
View File

@@ -0,0 +1,11 @@
---
sidebar_position: 5
---
# Manage Draft Orders
:::note
This guide is coming soon.
:::

11
docs/content/user-guide/orders/fulfillments.md Normal file
View File

@@ -0,0 +1,11 @@
---
sidebar_position: 4
---
# Manage Fulfillments
:::note
This guide is coming soon.
:::

35
docs/content/user-guide/orders/index.md Normal file
View File

@@ -0,0 +1,35 @@
---
sidebar_position: 1
---
# Orders Overview
In this document, you’ll get an overview of the orders listing page and everything you can do with it.
## Overview
When customers buy one or more products, their order appears on the Orders page. You can view an order’s information, capture payment, create shipments and fulfillments, register returns or exchanges of the order, and more.
The Orders domain also contains draft orders. Draft orders are orders that you create from the Medusa admin. After you fill out the order and mark it paid, it’s transformed into an order that appears as part of the Orders list.
## View List of Orders
You can view the list of available orders in your ecommerce store by clicking on Orders from the sidebar menu.
In the list, you can see order details such as the ID, date, customer, fulfillment and payment status, total, and the country of the shipping address.
## View List of Draft Orders
You can view the list of draft orders on the Orders page by clicking on the grey Drafts headline next to the Orders headline.
In the list, you can see order details such as ID, the ID of the order the draft order belongs to, the date, the customer, and the status of the draft order.
## Learn More About Orders
- [Manage Order Details](./manage.md)
- [Manage Order’s Payment](./payments.md)
- [Manage Order’s Fulfillment](./fulfillments.md)
- [Manage Draft Orders](./drafts.md)
- [Manage Order Returns](./returns.md)
- [Manage Order Claims](./claims.md)
- [Manage Order Exchanges and Swaps](./swaps.md)

121
docs/content/user-guide/orders/index.mdx
View File

@@ -1,121 +0,0 @@
import UiIcon from '@site/src/components/UiIcon';
# Orders Overview
In this document, you’ll get an overview of the orders listing page and all the things you can do with it.
## View List of Orders
You can view the list of available orders in your ecommerce store by clicking on Orders from the sidebar menu.
![Orders List](https://i.imgur.com/dRBQpZW.png)
In the list, you can see order details such as the ID, date, customer, fulfillment and payment status, total, and the country of the shipping address.
:::tip
If there are more than 15 orders, the list will be split into multiple pages. You can navigate between pages by clicking the arrows at the bottom of the list.
:::
## View List of Draft Orders
You can view the list of draft orders on the Orders page by clicking on the grey Drafts headline next to the Orders headline.
![Draft Orders List](https://i.imgur.com/jvNVbbI.png)
In the list, you can see order details such as ID, the ID of the order the draft order belongs to, the date, the customer, and the status of the draft order.
:::tip
If there are more than 15 orders, the list will be split into multiple pages. You can navigate between pages by clicking the arrows at the bottom of the list.
:::
## Filter Orders
You can use filters to retrieve only orders matching specific criteria.
### Quick Filters
On the Orders list page, you’ll find quick filters such as “Complete” and “Incomplete” at the top of the list. These filters show the complete and incomplete orders respectively.
You can click on one of these filters to quickly filter the orders.
![Activated quick filter](https://i.imgur.com/eVwD0JP.png)
### Advanced Filters
You can use advanced filters to furthermore limit the orders shown based on specific criteria. For example, you can filter orders to only show pending orders created in a specific region.
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 orders based on the filters you’ve selected.
![Advanced filters dropdown with more than one filter selected](https://i.imgur.com/rg9nKcS.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 “European Orders”.
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/0nKZ5BX.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.
![Saved Filter shows as a quick filter](https://i.imgur.com/ymuSHkv.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 + icon next to Filters.
- Click on the Clear button.
![Click clear button in the advanced filters dropdown](https://i.imgur.com/ArawLDT.png)
:::info
Clearing filters does not delete saved quick filters. You can still apply them by clicking on them.
:::
## Search Orders
You can search for orders 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 order list. When you search orders, you are searching by the first name supplied in the shipping address, the email associated with the order, and the order ID.
![Search orders by customer name](https://i.imgur.com/Z09rbmQ.png)
## Search Draft Orders
You can search for draft orders 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 draft order list. When you search draft orders, you are searching by the email associated with the draft order and the draft order’s ID.
![Search draft orders by email](https://i.imgur.com/el0Y9WS.png)
## What More Can you Do with Orders?
The Orders pages in the Medusa Admin include many functionalities including:
- Manage and View Order’s Details
- Manage Order’s Payment
- Manage Order’s Fulfillment
- Create a Draft Order
- Manage Order Returns
- Manage Order Claims
- Manage Order Exchanges and Swaps

11
docs/content/user-guide/orders/manage.md Normal file
View File

@@ -0,0 +1,11 @@
---
sidebar_position: 2
---
# Manage Orders
:::note
This guide is coming soon.
:::

11
docs/content/user-guide/orders/payments.md Normal file
View File

@@ -0,0 +1,11 @@
---
sidebar_position: 3
---
# Manage Payments
:::note
This guide is coming soon.
:::

11
docs/content/user-guide/orders/returns.md Normal file
View File

@@ -0,0 +1,11 @@
---
sidebar_position: 6
---
# Manage Returns
:::note
This guide is coming soon.
:::

11
docs/content/user-guide/orders/swaps.md Normal file
View File

@@ -0,0 +1,11 @@
---
sidebar_position: 7
---
# Manage Exchanges (Swaps)
:::note
This guide is coming soon.
:::

6
docs/content/user-guide/price-lists/_category_.json Normal file
View File

@@ -0,0 +1,6 @@
{
"position": 8,
"collapsed": false,
"link": null,
"label": "Price Lists"
}

11
docs/content/user-guide/price-lists/create.md Normal file
View File

@@ -0,0 +1,11 @@
---
sidebar_position: 2
---
# Create a Price List
:::note
This guide is coming soon.
:::

11
docs/content/user-guide/price-lists/delete.md Normal file
View File

@@ -0,0 +1,11 @@
---
sidebar_position: 4
---
# Delete a Price List
:::note
This guide is coming soon.
:::

11
docs/content/user-guide/price-lists/edit.md Normal file
View File

@@ -0,0 +1,11 @@
---
sidebar_position: 3
---
# Edit a Price List
:::note
This guide is coming soon.
:::

31
docs/content/user-guide/price-lists/index.md Normal file
View File

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

93
docs/content/user-guide/price-lists/index.mdx
View File

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

6
docs/content/user-guide/products/_category_.json Normal file
View File

@@ -0,0 +1,6 @@
{
"position": 4,
"collapsed": false,
"link": null,
"label": "Products"
}

11
docs/content/user-guide/products/collections.md Normal file
View File

@@ -0,0 +1,11 @@
---
sidebar_position: 5
---
# Manage Collections
:::note
This guide is coming soon.
:::

56
docs/content/user-guide/products/export.mdx Normal file
View File

@@ -0,0 +1,56 @@
---
sidebar_position: 4
---
import UiIcon from '@site/src/components/UiIcon';
# Export Products
In this document, you’ll learn how to export all products in your Medusa store.
## Overview
When you export your products, you can obtain a list of your products and their details in a CSV file. This can be useful if you want to migrate from one Medusa server to another, or if you need the CSV file for other purposes.
---
## Export List of Products
To export products:
1. Go to the Products page.
2. Click on Export Products at the top right.
3. Click Export in the window that opens.
4. Click on the <UiIcon lightIcon="https://i.imgur.com/mWhpxNX.png" darkIcon="https://i.imgur.com/tE8LOXk.png" alt="bell" /> icon at the top right of the page.
5. You should see your new export loading.
6. Once the export is ready, click on the Download button.
:::note
If you face any errors or difficulties, please contact your technical support team as this could be an issue in the storage integration used.
:::
---
## Cancel a Product Export
You can only cancel an unfinished product export.
To cancel a product export:
1. Click on the <UiIcon lightIcon="https://i.imgur.com/mWhpxNX.png" darkIcon="https://i.imgur.com/tE8LOXk.png" alt="bell" /> icon at the top right of the page.
2. Find the export you want to cancel.
3. Click on the cancel button.
---
## Delete a Product Export
You can only delete a finished product export.
To delete a product export:
1. Click on the <UiIcon lightIcon="https://i.imgur.com/mWhpxNX.png" darkIcon="https://i.imgur.com/tE8LOXk.png" alt="bell" /> icon at the top right of the page.
2. Find the export you want to delete.
3. Click on the Delete button.

163
docs/content/user-guide/products/index.mdx
View File

@@ -1,22 +1,30 @@
---
sidebar_position: 1
---
import UiIcon from '@site/src/components/UiIcon';
# Products Overview
In this document, you’ll get an overview of the product listing page and all the things you can do with it.
## Overview
Products are the goods you sell in your store. They can be physical or digital products. They can also be simple products or products with variants.
You can create products and edit their details. That includes basic info, sales channels, inventory management, prices management, and much more.
Part of the products domain is Collections. Collections are used to split products based on their type or function. For example, if you sell furniture and clothing, you can have two collections: Furniture and Clothing.
---
## View List of Products
You can view the list of available products in your ecommerce store by clicking on Products from the sidebar menu.
![Products List](https://i.imgur.com/xvRZQwK.png)
In the list, you can see product details such as the name, collection, inventory, and status of the product.
:::tip
If there are more than 15 products, the list will be split into multiple pages. You can navigate between pages by clicking the arrows at the bottom of the list.
:::
---
## Change Product View
@@ -28,146 +36,19 @@ To view products in a list view, which is the default view, click on the <UiIcon
To view products in a grid view, click on the <UiIcon lightIcon="https://i.imgur.com/HXMOOzK.png" darkIcon="https://i.imgur.com/fAHh3vz.png" alt="grid" /> icon at the top right of the product list.
![Grid View of Products List](https://i.imgur.com/GkTcjsO.png)
---
## View List of Collections
Collections are used to split products based on their type or function. For example, if you sell furniture and clothing, you can have two collections: Furniture and Clothing.
You can view the list of collections on the Products page by clicking on the grey Collections headline next to the Products headline.
![Collections List](https://i.imgur.com/RMRIGAW.png)
In the list, you can see collection details such as the title, handle, and the number of products in the collection.
:::tip
---
If there are more than 15 collections, the list will be split into multiple pages. You can navigate between pages by clicking the arrows at the bottom of the list.
## Learn More About Products
:::
## Filter Products
You can use filters to retrieve only products matching specific criteria.
### Quick Filters
On the Products list page, you can find quick filters such as “Unpublished” at the top of the list. The “Unpublished” filter shows only draft products in the list.
You can click on these filters to quickly filter the products.
![Activated quick filter](https://i.imgur.com/KfZjvJg.png)
### Advanced Filters
You can use advanced filters to furthermore limit the products shown based on specific criteria. For example, you can filter products to only show draft products created in a specific collection.
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 products based on the filters you’ve selected.
![Advanced filters dropdown with more than one filter selected](https://i.imgur.com/NMM2zBK.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 “Draft Clothing”.
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/pV8TJM0.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/s5WysMv.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/DiMdyrM.png)
:::info
Clearing filters does not delete saved quick filters. You can still apply them by clicking on them.
:::
## Search Products
You can search for products 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 products list. When you search products, you search by product title, description, variant title, variant SKU, and collection title.
![Search products by name](https://i.imgur.com/ch6dLZA.png)
## Search Collections
You can search for collections 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 collections list. When you search collections, you search by collection title and handle.
![Search collections by title](https://i.imgur.com/KMJDIDJ.png)
## Export Products
To export products:
- Go to the Products page.
- Click on Export Products at the top right.
- Click Export in the window that opens.
- Click on the <UiIcon lightIcon="https://i.imgur.com/mWhpxNX.png" darkIcon="https://i.imgur.com/tE8LOXk.png" alt="bell" /> icon at the top right of the page.
- You should see your new export loading.
- Once the export is ready, click on the Download button.
:::note
If you face any errors or difficulties, please contact your technical support team as this could be an issue in the storage integration used.
:::
![Click on the download button in the activity panel](https://i.imgur.com/VE7PBtW.png)
### Cancel a Product Export
You can only cancel an unfinished product export.
To cancel a product export:
- Click on the <UiIcon lightIcon="https://i.imgur.com/mWhpxNX.png" darkIcon="https://i.imgur.com/tE8LOXk.png" alt="bell" /> icon at the top right of the page.
- Find the export you want to cancel.
- Click on the cancel button.
![Click on the cancel button in the activity panel](https://i.imgur.com/yEU4lUD.png)
### Delete a Product Export
You can only delete a finished product export.
To delete a product export:
- Click on the <UiIcon lightIcon="https://i.imgur.com/mWhpxNX.png" darkIcon="https://i.imgur.com/tE8LOXk.png" alt="bell" /> icon at the top right of the page.
- Find the export you want to delete.
- Click on the Delete button.
![Click on the delete button in the activity panel](https://i.imgur.com/04Dat1k.png)
## What More Can you Do with Products?
The Products pages in the Medusa Admin include many functionalities including:
- Manage and View Product Details.
- Manage and View Collection Details.
- [Manage Products](./manage.md)
- [Manage Digital Products](./manage-digital.md)
- [Manage Collections](./collections.md)
- [Export Products](./export.mdx)

11
docs/content/user-guide/products/manage-digital.md Normal file
View File

@@ -0,0 +1,11 @@
---
sidebar_position: 3
---
# Manage Digital Products
:::note
This guide is coming soon.
:::

11
docs/content/user-guide/products/manage.md Normal file
View File

@@ -0,0 +1,11 @@
---
sidebar_position: 2
---
# Manage Products
:::note
This guide is coming soon.
:::

6
docs/content/user-guide/regions/_category_.json Normal file
View File

@@ -0,0 +1,6 @@
{
"position": 9,
"collapsed": false,
"link": null,
"label": "Regions"
}

22
docs/content/user-guide/regions/index.md
View File

@@ -1,6 +1,10 @@
---
sidebar_position: 1
---
# Regions Overview
In this document, you’ll get an overview of regions and learn about their importance in your ecommerce store
In this document, you’ll get an overview of regions and learn about their importance in your ecommerce store.
## Overview
@@ -8,18 +12,24 @@ Regions are essential to your ecommerce store. They allow you to specify availab
Regions represent different countries that your ecommerce store serves customers in. You can combine more than one country in the same region and give them the same settings, or you can create a different region for each country and add settings specific to each of them.
### Currencies in Regions
---
## Currencies in Regions
Each region uses one currency. Having more than one region with each having different currencies allows you to set prices and amounts throughout your ecommerce store for each currency. For example, you can specify prices for a product for each currency you support.
![An example of prices for different currencies](https://i.imgur.com/XkLZajl.png)
---
### How Customers Use Regions
## How Customers Use Regions
When a customer browses your storefront, they can choose the region based on their location. Then, different pricing, shipping providers, payment providers, and taxes will be available and applied based on the chosen region.
For example, if you have Stripe enabled as a payment provider in a region created for the United States, but have it disabled in a region created for European countries, only customers in the United States region can use Stripe for payment on checkout.
## What More Can you Do with Regions?
---
In the Medusa admin, you can create and manage regions and their settings, such as available shipping options. You can learn more in [this guide](./manage.mdx).
## Learn More About Regions
- [Manage Regions](./manage.mdx)
- [Manage Payment and Fulfillment Providers](./providers.md)
- [Manage Shipping Options in a Region](./shipping-options.md)

183
docs/content/user-guide/regions/manage.mdx
View File

@@ -1,3 +1,7 @@
---
sidebar_position: 2
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Regions
@@ -8,23 +12,23 @@ In this document, you’ll learn how to view and manage regions in your Medusa A
To view your regions:
- Click on Settings in the sidebar.
- Choose Regions from the list of settings.
1. Click on Settings in the sidebar.
2. Choose Regions from the list of settings.
This opens the Regions page where you can find a list of regions.
![List of Regions](https://i.imgur.com/qZgU1SC.png)
---
## Create a Region
To create a region:
- Go to Settings → Regions.
- Click on Add Region at the top right of the Regions section.
- In the window that opens you must enter the Regions details:
1. Go to Settings → Regions.
2. Click on Add Region at the top right of the Regions section.
3. In the window that opens you must enter the Regions details:
- It is required to enter a name and choose a currency and at least one country, payment provider, and fulfillment provider.
- You can optionally enter a tax rate and code for the region. Alternatively, you can [edit a region’s tax settings and rates](../taxes/manage.mdx#edit-a-regions-taxes) after creation.
- Once you’re done, click Save.
- You can optionally enter a tax rate and code for the region. Alternatively, you can [edit a region’s tax settings and rates](../taxes/manage.md#edit-a-regions-taxes) after creation.
4. Once you’re done, click Save.
:::tip
@@ -32,148 +36,9 @@ If you can’t find the currency you want to use in the Currency field, make sur
:::
![Example form to add a region](https://i.imgur.com/Q3SBQW3.png)
After you click save, the region will be created and you can see it in the list on the left.
### Edit a Region
To edit a region:
- Go to Settings → Regions.
- Click on the region you want to edit from the Regions section.
This opens a Details form to the right. You can edit basic information such as the name or currency.
![Details form to edit a region](https://i.imgur.com/rJv9nUa.png)
### Manage Payment Providers in a Region
To add or remove a payment provider in a region:
- Select a region to edit.
- Scroll down to the Payment Providers section in the Details form.
- Select the payment providers you want to add to the region.
- Unselect the payment providers you want to remove from the region.
- Click Save.
![Example of choosing a payment provider](https://i.imgur.com/piD7oQi.png)
### Manage Fulfillment Providers in a Region
To add or remove a fulfillment provider in a region:
- Select a region to edit.
- Scroll down to the Fulfillment Providers section in the Details form.
- Select the fulfillment providers you want to add to the region.
- Unselect the fulfillment providers you want to remove from the region.
- Click Save.
![Examples of choosing a fulfillment provider](https://i.imgur.com/QzPAYU7.png)
## Manage Shipping Options in a Region
A shipping option is used by customers during checkout when they pick a shipping method for their order. They’re also used by admins when they create a draft order.
### Add Shipping Option to a Region
To add a shipping option:
- Select a region to edit.
- Scroll down to the Shipping Options section in the Details form.
- Click on Add Option.
- A new window will open with a form with the following fields:
- **Name (Required):** The name of the shipping option. The customer will see this name on the storefront if the “Show on Website” field is checked.
- **Currency:** This is a read-only field and its value depends on the currency of the region.
- **Price (Required):** The price of the shipping option.
- **Show on Website:** Whether or not this option should be available on the website. This is useful if you want to create a shipping option only for use on the Medusa Admin (for example, to create draft orders).
- **Shipping Profile (Required):** The shipping profile this option belongs to.
- **Fulfillment Method (Required):** the fulfillment provider that will handle fulfilling this shipping option.
- **Requirements:** You can use this to specify a condition for when this shipping option should be available. The first field indicates the minimum cart subtotal, and the second field indicates the maximum cart subtotal. For example, you can fill in the first field “100” to only allow using this shipping option if the cart’s subtotal is at least $100.
- Once you’re done, click Save.
![Form example of adding a shipping option](https://i.imgur.com/maiCo8D.png)
### Edit a Shipping Option
To edit a shipping option:
- Select a region to edit.
- Scroll down to the Shipping Options section in the Details form.
- Find the shipping option you want to edit and click on Edit at the right of its name.
- A new window will open with the fields that you can edit. You can edit all of the fields you chose while adding the shipping option except for the Shipping Profile and Fulfillment Method.
- Once done, click Save.
![Form example of editing a shipping option](https://i.imgur.com/mnsVOJF.png)
### Delete a Shipping Option
:::caution
If you delete a shipping option, you can’t restore it or its data, customers can’t use it during checkout, and admins can’t use it for draft orders.
:::
To delete a shipping option:
- Select a region to edit.
- Scroll down to the Shipping Options section in the Details form.
- Find the shipping option you want to edit and click on Edit at the right of its name.
- A new window will open. Click on Delete under the Danger Zone section.
- Confirm deleting the shipping option by clicking the “Yes, remove” button in the pop-up.
![Delete shipping option link is under the Danger Zone section of the edit form](https://i.imgur.com/zGl3qt3.png)
## Manage Return Shipping Options in a Region
A return shipping option is a shipping option that is only used to return items in an order. It can be used by the customer when they request a return or an exchange, and by the admin when they request a return, register an exchange, or register a claim.
### Add Return Shipping Option to a Region
To add a return shipping option:
- Select a region to edit.
- Scroll down to the Return Shipping Options section in the Details form.
- Click on Add Return.
- A new window will open with a form with the following fields:
- **Name (Required):** The name of the return shipping option. The customer will see this name on the storefront if the “Show on Website” field is checked.
- **Currency:** This is a read-only field and its value depends on the currency of the region.
- **Price (Required):** The price of the return shipping option.
- **Show on Website:** Whether or not this option should be available on the website. This is useful if you want to create a return shipping option only for use on the Medusa Admin (for example, to create claims or return requests from the Medusa Admin).
- **Fulfillment Method (Required):** the fulfillment provider that will handle fulfilling this return shipping option.
- Once you’re done, click Save.
![Example form of adding a return shipping option](https://i.imgur.com/VXC67zT.png)
### Edit a Return Shipping Option
To edit a return shipping option:
- Select a region to edit.
- Scroll down to the Return Shipping Options section in the Details form.
- Find the return shipping option you want to edit and click on Edit at the right of its name.
- A new window will open with the fields that you can edit. You can edit all of the fields you chose while adding the shipping profile except for the Fulfillment Method.
- Once done, click Save.
![Example for of editing a return shipping option](https://i.imgur.com/go8UX6k.png)
### Delete a Return Shipping Option
:::caution
If you delete a return shipping option, you can’t restore it or its data, customers can’t use it when they request a return or an exchange, and admins can’t use it when requesting a return for an order or registering an exchange or claim for an order.
:::
To delete a return shipping option:
- Select a region to edit.
- Scroll down to the Return Shipping Options section in the Details form.
- Find the return shipping option you want to edit and click on Edit at the right of its name.
- A new window will open. Click on Delete under the Danger Zone section.
- Confirm deleting the return shipping option by clicking the “Yes, remove” button in the pop-up.
![Delete return shipping option link is under the Danger Zone section](https://i.imgur.com/wjjoFrT.png)
---
## Duplicate a Region
@@ -181,12 +46,10 @@ Duplicating a region allows you to create a new region with some of its details
To duplicate a region:
- Go to Settings → Regions.
- Click on the region you want to duplicate from the Regions section.
- In the Details section, click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon.
- Choose Duplicate Region from the dropdown list.
![Duplicate Region is the first link in the dropdown](https://i.imgur.com/qyzmMLF.png)
1. Go to Settings → Regions.
2. Click on the region you want to duplicate from the Regions section.
3. In the Details section, click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon.
4. Choose Duplicate Region from the dropdown list.
## Delete a Region
@@ -198,10 +61,8 @@ If you delete a region, you will not be able to restore it or its data. Data rel
To delete a region:
- Go to Settings → Regions.
- Click on the region you want to duplicate from the Regions section.
- In the Details section, click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon.
- Choose Delete Region from the dropdown list.
- Confirm deleting the region by clicking the “Yes, delete” button in the pop-up.
![Delete Region is the second link in the dropdown](https://i.imgur.com/haVXAYO.png)
1. Go to Settings → Regions.
2. Click on the region you want to duplicate from the Regions section.
3. In the Details section, click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon.
4. Choose Delete Region from the dropdown list.
5. Confirm deleting the region by clicking the “Yes, delete” button in the pop-up.

39
docs/content/user-guide/regions/providers.md Normal file
View File

@@ -0,0 +1,39 @@
---
sidebar_position: 3
---
# Manage Payment and Fulfillment Providers
In this document, you’ll learn how to manage a region’s payment and fulfillment providers in your Medusa Admin.
## Overview
You can choose the payment and fulfillment providers available in each region. This allows you to provide customers in specific regions the providers that are available in their country or region.
When a payment or fulfillment provider is added to a region, it means a customer is able to select that payment or fulfillment provider during checkout to complete their purchase.
---
## Manage Payment Providers
To add or remove a payment provider in a region:
1. Go to Settings → Regions.
2. Select a region to edit.
3. Scroll down to the Payment Providers section in the Details form.
4. Select the payment providers you want to add to the region.
5. Unselect the payment providers you want to remove from the region.
6. Click Save.
---
## Manage Fulfillment Providers
To add or remove a fulfillment provider in a region:
1. Go to Settings → Regions.
2. Select a region to edit.
3. Scroll down to the Fulfillment Providers section in the Details form.
4. Select the fulfillment providers you want to add to the region.
5. Unselect the fulfillment providers you want to remove from the region.
6. Click Save.

112
docs/content/user-guide/regions/shipping-options.md Normal file
View File

@@ -0,0 +1,112 @@
---
sidebar_position: 4
---
# Manage Shipping Options
In this document, you’ll learn how to manage a region’s shipping options in your Medusa Admin.
## Types of Shipping Options
There are two types of shipping options in a region:
1. Shipping Options are used when a customer places an order or when an admin creates a draft order.
2. Return Shipping Options are used when a customer requests a return or swap for their order, or when an admin registers an exchange, a claim, or a return for an order.
A shipping option can’t be used for both cases. In a region, you can create an unlimited amount of shipping options and return shipping options.
## Manage Shipping Options in a Region
### Add Shipping Option to a Region
To add a shipping option:
1. Go to Settings → Regions.
2. Select a region to edit.
3. Scroll down to the Shipping Options section in the Details form.
4. Click on Add Option.
5. A new window will open with a form with the following fields:
- **Name (Required):** The name of the shipping option. The customer will see this name on the storefront if the “Show on Website” field is checked.
- **Currency:** This is a read-only field and its value depends on the currency of the region.
- **Price (Required):** The price of the shipping option.
- **Show on Website:** Whether or not this option should be available on the website. This is useful if you want to create a shipping option only for use on the Medusa Admin (for example, to create draft orders).
- **Shipping Profile (Required):** The shipping profile this option belongs to.
- **Fulfillment Method (Required):** the fulfillment provider that will handle fulfilling this shipping option.
- **Requirements:** You can use this to specify a condition for when this shipping option should be available. The first field indicates the minimum cart subtotal, and the second field indicates the maximum cart subtotal. For example, you can fill in the first field “100” to only allow using this shipping option if the cart’s subtotal is at least $100.
6. Once you’re done, click Save.
### Edit a Shipping Option
To edit a shipping option:
1. Go to Settings → Regions.
2. Select a region to edit.
3. Scroll down to the Shipping Options section in the Details form.
4. Find the shipping option you want to edit and click on Edit at the right of its name.
5. A new window will open with the fields that you can edit. You can edit all of the fields you chose while adding the shipping option except for the Shipping Profile and Fulfillment Method.
6. Once done, click Save.
### Delete a Shipping Option
:::warning
If you delete a shipping option, you can’t restore it or its data, customers can’t use it during checkout, and admins can’t use it for draft orders.
:::
To delete a shipping option:
1. Go to Settings → Regions.
2. Select a region to edit.
3. Scroll down to the Shipping Options section in the Details form.
4. Find the shipping option you want to edit and click on Edit at the right of its name.
5. A new window will open. Click on Delete under the Danger Zone section.
6. Confirm deleting the shipping option by clicking the “Yes, remove” button in the pop-up.
---
## Manage Return Shipping Options in a Region
### Add Return Shipping Option to a Region
To add a return shipping option:
1. Go to Settings → Regions.
2. Select a region to edit.
3. Scroll down to the Return Shipping Options section in the Details form.
4. Click on Add Return.
5. A new window will open with a form with the following fields:
- **Name (Required):** The name of the return shipping option. The customer will see this name on the storefront if the “Show on Website” field is checked.
- **Currency:** This is a read-only field and its value depends on the currency of the region.
- **Price (Required):** The price of the return shipping option.
- **Show on Website:** Whether or not this option should be available on the website. This is useful if you want to create a return shipping option only for use on the Medusa Admin (for example, to create claims or return requests from the Medusa Admin).
- **Fulfillment Method (Required):** the fulfillment provider that will handle fulfilling this return shipping option.
6. Once you’re done, click Save.
### Edit a Return Shipping Option
To edit a return shipping option:
1. Go to Settings → Regions.
2. Select a region to edit.
3. Scroll down to the Return Shipping Options section in the Details form.
4. Find the return shipping option you want to edit and click on Edit at the right of its name.
5. A new window will open with the fields that you can edit. You can edit all of the fields you chose while adding the shipping profile except for the Fulfillment Method.
6. Once done, click Save.
### Delete a Return Shipping Option
:::warning
If you delete a return shipping option, you can’t restore it or its data, customers can’t use it when they request a return or an exchange, and admins can’t use it when requesting a return for an order or registering an exchange or claim for an order.
:::
To delete a return shipping option:
1. Go to Settings → Regions.
2. Select a region to edit.
3. Scroll down to the Return Shipping Options section in the Details form.
4. Find the return shipping option you want to edit and click on Edit at the right of its name.
5. A new window will open. Click on Delete under the Danger Zone section.
6. Confirm deleting the return shipping option by clicking the “Yes, remove” button in the pop-up.

6
docs/content/user-guide/sales-channels/_category_.json Normal file
View File

@@ -0,0 +1,6 @@
{
"position": 11,
"collapsed": false,
"link": null,
"label": "Sales Channels"
}

23
docs/content/user-guide/sales-channels/index.md
View File

@@ -1,3 +1,7 @@
---
sidebar_position: 1
---
# Sales Channels Overview
In this document, you’ll get an overview of sales channels in Medusa and learn about their importance in your ecommerce store.
@@ -14,6 +18,8 @@ Sales Channels are multiple channels that you can sell your products through. Fo
By default, there’s a default sales channel in a Medusa store. You can add multiple sales channels.
---
## How Sales Channels Work
Sales channels are associated with data and settings in your ecommerce store.
@@ -22,13 +28,15 @@ For each sales channel, you can choose which products belong to that sales chann
Then, when customers place an order from a sales channel, the order is associated with that sales channel. You’ll be able to see the sales channel an order was placed from in the Medusa admin.
---
## Sales Channels Settings Overview
To view the available sales channels and settings, go to Settings → Sales channels.
In the sales channels settings page, You can view available sales channels, add more sales channels, edit sales channels, and manage products available in the sales channel.
![Overview of Sales Channels Page](https://i.imgur.com/9433HAR.png)
---
## View Sales Channels of Orders
@@ -36,13 +44,11 @@ In the sales channels settings page, You can view available sales channels, add
In the Orders page, you can see the sales channel an order belongs to. If the order doesn’t belong to any sales channel, you can see “N/A” instead.
![Sales Channel column in Orders page](https://i.imgur.com/0tmYOn0.png)
### Orders Details Page
In the details page of an order, you can find the sales channel the order belongs to, if there are any.
![Sales Channel name in the Orders Details page](https://i.imgur.com/hqyYy0E.png)
---
## View Sales Channels of Products
@@ -50,14 +56,13 @@ In the details page of an order, you can find the sales channel the order belong
In the Products page, you can see the sales channels a product belongs to under the Availability column if there are any.
![Sales Channel of a product can be shown under the Availability column on the Products page](https://i.imgur.com/SjaM1aq.png)
### Products Edit Page
In the edit page of a product, you can find the sales channels the product belongs to and edit them under the Sales Channels section.
![Sales Channels a product belongs to can be seen on the Edit Product page](https://i.imgur.com/m9n9viV.png)
---
## What More Can you Do with Sales Channels?
## Learn More About Sales Channels
In the Medusa admin, you can manage the details of sales channels, their products, and more. You can learn more in [this guide](./manage.mdx).
- [Manage Sales Channels](./manage.mdx)
- [Manage Products in Sales Channels](./products.mdx)

124
docs/content/user-guide/sales-channels/manage.mdx
View File

@@ -1,3 +1,7 @@
---
sidebar_position: 2
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Sales Channels
@@ -8,38 +12,37 @@ In this document, you’ll learn how to view and manage sales channels in your M
To view sales channels:
- Click on Settings in the sidebar.
- Choose Sales Channels from the list of settings.
1. Click on Settings in the sidebar.
2. Choose Sales Channels from the list of settings.
This opens the Sales Channels page where you can see the list of Sales channels on the left and the products in the selected sales channel on the right.
For the products list, you can use the [same filters that are available in the Products page](../products/index.mdx#filter-products).
![List of Sales Channels](https://i.imgur.com/0KnsuOc.png)
---
## Search Sales Channels
To search sales channels:
- Go to Settings → Sales Channels
- In the Sales Channels section on the left, click on the <UiIcon lightIcon="https://i.imgur.com/k0U0wpO.png" darkIcon="https://i.imgur.com/IdKjFak.png" alt="magnifier" /> icon next to the title of the section.
- This shows an input to search sales channels by title and description.
- To clear the search, click on the <UiIcon lightIcon="https://i.imgur.com/kvGRHQR.png" darkIcon="https://i.imgur.com/RJ4SLIu.png" alt="X" /> icon in the search input.
1. Go to Settings → Sales Channels
2. In the Sales Channels section on the left, click on the <UiIcon lightIcon="https://i.imgur.com/k0U0wpO.png" darkIcon="https://i.imgur.com/IdKjFak.png" alt="magnifier" /> icon next to the title of the section.
3. This shows an input to search sales channels by title and description.
![Search sales channels by name](https://i.imgur.com/sgSQ1Jy.png)
To clear the search, click on the <UiIcon lightIcon="https://i.imgur.com/kvGRHQR.png" darkIcon="https://i.imgur.com/RJ4SLIu.png" alt="X" /> icon in the search input.
---
## Create a Sales Channel
To add a new sales channel:
- Go to Settings → Sales Channels
- In the Sales Channels section on the left, click on the <UiIcon lightIcon="https://i.imgur.com/1hL8NiW.png" darkIcon="https://i.imgur.com/8LtkPqW.png" alt="plus" /> icon next to the title of the section.
- The form to create a new sales channel will open. The name of the sales channel is required, but the description is optional.
- Once you’re done, you can either:
1. Go to Settings → Sales Channels
2. In the Sales Channels section on the left, click on the <UiIcon lightIcon="https://i.imgur.com/1hL8NiW.png" darkIcon="https://i.imgur.com/8LtkPqW.png" alt="plus" /> icon next to the title of the section.
3. The form to create a new sales channel will open. The name of the sales channel is required, but the description is optional.
4. Once you’re done, you can either:
- Click Save as draft to save the sales channel as disabled.
- Click Publish channel to save the sales channel as enabled.
![Form to create a sales channel](https://i.imgur.com/abOn4Sp.png)
---
## Change the Status of a Sales Channel
@@ -47,26 +50,26 @@ A sales channel can be enabled or disabled. If a sales channel is disabled, that
To enable or disable a sales channel:
- Go to Settings → Sales Channels
- In the sales channels list on the left, choose the sales channel you want to enable/disable.
- At the top right of the right section, you can find the status of the sales channel, with a <UiIcon lightIcon="https://i.imgur.com/yrTcDO4.png" darkIcon="https://i.imgur.com/yrTcDO4.png" alt="green" /> icon if it’s enabled or a <UiIcon lightIcon="https://i.imgur.com/0lUln3B.png" darkIcon="https://i.imgur.com/0lUln3B.png" alt="grey" /> icon if it’s disabled.
- Click on the status, and a dropdown will show to toggle the status. For example, if the status of the sales channel is Enabled, the dropdown will show a Disabled status.
- Choose the status in the dropdown, and the status of the sales channel will change.
1. Go to Settings → Sales Channels
2. In the sales channels list on the left, choose the sales channel you want to enable/disable.
3. At the top right of the right section, you can find the status of the sales channel, with a <UiIcon lightIcon="https://i.imgur.com/yrTcDO4.png" darkIcon="https://i.imgur.com/yrTcDO4.png" alt="green" /> icon if it’s enabled or a <UiIcon lightIcon="https://i.imgur.com/0lUln3B.png" darkIcon="https://i.imgur.com/0lUln3B.png" alt="grey" /> icon if it’s disabled.
4. Click on the status, and a dropdown will show to toggle the status. For example, if the status of the sales channel is Enabled, the dropdown will show a Disabled status.
5. Choose the status in the dropdown, and the status of the sales channel will change.
![Toggle the status by choosing the opposite status in the dropdown](https://i.imgur.com/gtUs9sr.png)
---
## Edit Sales Channel’s Information
To edit a sales channel’s information:
- Go to Settings → Sales Channels
- In the sales channels list on the left, choose the sales channel you want to edit.
- At the top right of the right section, click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon.
- Choose from the dropdown list “Edit general info”.
- This opens a form in a window where you can edit the name and description of the sales channel.
- Once done, click Save.
1. Go to Settings → Sales Channels
2. In the sales channels list on the left, choose the sales channel you want to edit.
3. At the top right of the right section, click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon.
4. Choose from the dropdown list “Edit general info”.
5. This opens a form in a window where you can edit the name and description of the sales channel.
6. Once done, click Save.
![Form to edit a sales channel](https://i.imgur.com/1qicPDo.png)
---
## Delete a Sales Channel
@@ -78,63 +81,8 @@ If you delete a sales channel, you won’t be able to restore it. Orders and Pro
To delete a sales channel:
- Go to Settings → Sales Channels
- In the sales channels list on the left, choose the sales channel you want to delete.
- At the top right of the right section, click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon.
- Choose from the dropdown list “Delete channel”.
- Confirm deleting the tax rate by clicking the “Yes, delete” button in the pop-up.
![Delete channel is the third link in the dropdown](https://i.imgur.com/OmMygcf.png)
## Manage Products in Sales Channels
### Add Products to Sales Channels
:::info
You can also add a product to a Sales Channel from the product’s edit page.
:::
To add products to a sales channel:
- Go to Settings → Sales Channels
- In the sales channels list on the left, choose the sales channel you want to add products to.
- At the top right of the right section, click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon.
- Choose from the dropdown list “Add products”.
- This opens a window to add products with [filters](../products/index.mdx#filter-products) and [search](../products/index.mdx#search-products) functionalities similar to those of a product page.
- Select the products you want to add to the sales channel.
- Click Save.
:::info
Products in the list that are grayed out are products that are already added to the sales channel.
:::
![Choose products to add to the sales channel](https://i.imgur.com/ubqdIsn.png)
### Remove Product from Sales Channel
:::note
If you remove a product from a sales channel, it will still be available in your ecommerce store, just not in that sales channel. You can also add the product again to the sales channel.
:::
To remove a product from a sales channel:
- Go to Settings → Sales Channels
- In the sales channels list on the left, choose the sales channel you want to remove the product from.
- Find the product you want to remove from the sales channel.
- Click the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon at the right side of the product’s row.
- Choose from the dropdown list “Remove from the channel”.
:::info
You can also remove a product from a Sales Channel from the product’s edit page.
:::
![Remove from this channel link is the third link in the dropdown](https://i.imgur.com/3hZUBcx.png)
1. Go to Settings → Sales Channels
2. In the sales channels list on the left, choose the sales channel you want to delete.
3. At the top right of the right section, click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon.
4. Choose from the dropdown list “Delete channel”.
5. Confirm deleting the tax rate by clicking the “Yes, delete” button in the pop-up.

50
docs/content/user-guide/sales-channels/products.mdx Normal file
View File

@@ -0,0 +1,50 @@
---
sidebar_position: 3
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Products in Sales Channels
In this document, you’ll learn how to manage products in Sales Channels.
:::note
This guide covers managing products from the Sales Channels page. It’s also possible to manage the Sales Channels of products in the Products page.
:::
## Add Products to Sales Channels
To add products to a sales channel:
1. Go to Settings → Sales Channels
2. In the sales channels list on the left, choose the sales channel you want to add products to.
3. At the top right of the right section, click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon.
4. Choose from the dropdown list “Add products”.
5. This opens a window to add products with filters and search functionalities similar to those of a product page. Select the products you want to add to the sales channel.
6. Click Save.
:::info
Products in the list that are grayed out are products that are already added to the sales channel.
:::
---
## Remove Product from Sales Channel
:::info
If you remove a product from a sales channel, it will still be available in your ecommerce store, just not in that sales channel. You can also add the product again to the sales channel.
:::
To remove a product from a sales channel:
1. Go to Settings → Sales Channels
2. In the sales channels list on the left, choose the sales channel you want to remove the product from.
3. Find the product you want to remove from the sales channel.
4. Click the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon at the right side of the product’s row.
5. Choose from the dropdown list “Remove from the channel”.

6
docs/content/user-guide/taxes/_category_.json Normal file
View File

@@ -0,0 +1,6 @@
{
"position": 10,
"collapsed": false,
"link": null,
"label": "Taxes"
}

17
docs/content/user-guide/taxes/index.md
View File

@@ -1,3 +1,7 @@
---
sidebar_position: 1
---
# Taxes Overview
In this document, you’ll get an overview of taxes in Medusa and learn about their importance in your ecommerce store.
@@ -8,7 +12,7 @@ Taxes in Medusas are directly associated with [Regions](../regions/index.md). As
Taxes are calculated for products and shipping methods on checkout. Medusa provides a default tax provider to calculate the taxes, and merchants and developers can also integrate custom tax providers for advanced calculation of taxes.
![A look at the Taxes page](https://i.imgur.com/JxwB8tu.png)
---
## How are Taxes Created?
@@ -16,14 +20,19 @@ Once a region is created, a default tax rate is created for that region. You can
This also means that tax rates are deleted when a region is deleted.
---
## Customizing Tax Rates
A region’s default tax rate is applied for all products and shipping options. You can also have more customized tax rates.
Adding tax rates alongside the default one allows you to override the prices of specific products, product types, or shipping options. This further increase the customization capabilities of your ecommerce store.
![A look at tax rate overrides](https://i.imgur.com/KEDcYQT.png)
---
## What More Can you Do with Taxes?
## Learn More About Taxes
In the Medusa admin, you can manage taxes and their settings, and apply further customizations to tax rates. You can learn more in [this guide](./manage.mdx).
- [Manage Taxes](./manage.md)
- [Manage Tax Rates](./tax-rates.mdx)
- [Manage Tax Overrides](./tax-overrides.mdx)
- [Tax Inclusive Pricing Overview](./tax-inclusive.md)

75
docs/content/user-guide/taxes/manage.md Normal file
View File

@@ -0,0 +1,75 @@
---
sidebar_position: 2
---
# Manage Taxes
In this document, you’ll learn how to view and manage taxes in your Medusa Admin.
## View Taxes
To view taxes:
1. Click on Settings in the sidebar.
2. Choose Tax Settings from the list of settings.
This opens the Taxes page where you can find a list of regions. This is because every time you create a region, a default tax rate is associated with that region.
---
## Edit a Region’s Taxes
To edit a region’s taxes:
1. Go to Settings → Taxes.
2. Click on the region you want to edit the taxes for in the Regions section.
This opens a Details form to the right where you can edit the taxes calculation settings and manage the tax rates.
---
## Change Tax Calculation Settings
:::tip
The save button only appears when you make changes to the settings.
:::
### Change Tax Provider
The tax provider that you choose defines how taxes are calculated for products and shipping options on checkout. Medusa provides a default tax provider with the name “System Tax Provider”.
If you have integrated a custom tax provider and want to use it to calculate taxes in a region:
1. Select a region whose taxes you want to edit.
2. Change the selected tax provider in the Tax Provider field.
3. Click Save at the bottom right.
### Disable Automatic Taxes Calculation
By default, taxes are calculated automatically by Medusa. They’re calculated in different places during checkout, such as when a shipping method is chosen or when a new product is added to the cart.
If you use a third-party tax provider and you want to avoid sending too many requests to the tax provider, you can disable this behavior.
:::caution
If you switch off automatic taxes calculation, the taxes must be calculated manually on checkout. If you’re unsure how that works, please contact your technical team.
:::
To disable automatic taxes calculation:
1. Select a region whose tax you want to edit.
2. Check off the “Calculate taxes automatically” input.
3. Click Save at the bottom right.
### Disable Taxes for Gift Cards
To disable applying taxes for Gift Cards:
1. Select a region whose tax you want to edit.
2. Check off the “Apply tax to gift cards” input.
3. Click Save at the bottom right.
Enabling taxes for Gift Cards follows the same process, except you check the input.

189
docs/content/user-guide/taxes/manage.mdx
View File

@@ -1,189 +0,0 @@
import UiIcon from '@site/src/components/UiIcon';
# Manage Taxes
In this document, you’ll learn how to view and manage taxes in your Medusa Admin.
## View Taxes
To view taxes:
- Click on Settings in the sidebar.
- Choose Tax Settings from the list of settings.
This opens the Taxes page where you can find a list of regions. This is because every time you create a region, a default tax rate is associated with that region.
![List of Regions on the Taxes page](https://i.imgur.com/Hf3RazW.png)
## Edit a Region’s Taxes
To edit a region’s taxes:
- Go to Settings → Taxes.
- Click on the region you want to edit the taxes for in the Regions section.
This opens a Details form to the right where you can edit the taxes calculation settings and manage the tax rates.
![The details of a region's taxes](https://i.imgur.com/kdLmcVA.png)
## Change Tax Calculation Settings
![Available settings to change tax calculation settings](https://i.imgur.com/y3UUE27.png)
:::tip
The save button only appears when you make changes to the settings.
:::
### Change Tax Provider
The tax provider that you choose defines how taxes are calculated for products and shipping options on checkout. Medusa provides a default tax provider with the name “System Tax Provider”.
If you have integrated a custom tax provider and want to use it to calculate taxes in a region:
- Select a region whose taxes you want to edit.
- Change the selected tax provider in the Tax Provider field.
- Click Save at the bottom right.
### Disable Automatic Taxes Calculation
By default, taxes are calculated automatically by Medusa. They’re calculated in different places during checkout, such as when a shipping method is chosen or when a new product is added to the cart.
If you use a third-party tax provider and you want to avoid sending too many requests to the tax provider, you can disable this behavior.
:::caution
If you switch off automatic taxes calculation, the taxes must be calculated manually on checkout. If you’re unsure how that works, please contact your technical team.
:::
To disable automatic taxes calculation:
- Select a region whose tax you want to edit.
- Check off the “Calculate taxes automatically” input.
- Click Save at the bottom right.
### Disable Taxes for Gift Cards
To disable applying taxes for Gift Cards:
- Select a region whose tax you want to edit.
- Check off the “Apply tax to gift cards” input.
- Click Save at the bottom right.
Enabling taxes for Gift Cards follows the same process, except you check the input.
## Manage Tax Rates
Regions have at least one tax rate, which is the default tax rate. You can, however, add more tax rates for further customization.
### Create Tax Rates
To add a tax rate:
- Select a region that you want to add a new tax rate to.
- Click on New Tax Rate at the top right of the Details section.
- This opens the tax rate form in a new window.
- You can optionally [add overrides to the tax rate](#manage-tax-rate-overrides).
- Once done, click Save.
![Form to add a tax rate](https://i.imgur.com/y3UUE27.png)
### Edit Tax Rate
To edit a tax rate:
- Select the region that the tax rate you want to edit belongs to.
- From the list of tax rates in the Details section, find the tax rate you want to edit and click the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon.
- Choose Edit from the dropdown.
- In the form that opens in the new window, you can edit the basic details of the tax rate such as the name or rate. If you’re editing a tax rate that’s not the default, you can [manage overrides of this tax rate](#manage-tax-rate-overrides).
- Once done, click Save.
![Form to edit a tax rate](https://i.imgur.com/FG1Q1np.png)
### Delete Tax Rate
:::warning
If you delete a tax rate, you won’t be able to restore it or use it during checkout.
:::
To delete a tax rate:
- Select the region that the tax rate you want to delete belongs to.
- From the list of tax rates in the Details section, find the tax rate you want to delete and click the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon.
- Choose Delete Tax Rate from the dropdown.
- Confirm deleting the tax rate by clicking the “Yes, confirm” button in the pop-up.
:::info
Default tax rates can’t be deleted. If you don’t want to apply any taxes in a region, you can instead set the default tax rate to 0.
:::
![Delete tax rate link is the second link in the dropdown](https://i.imgur.com/MUarcT0.png)
## Manage Tax Rate Overrides
When you create or edit a tax rate, you can add, edit, and delete overrides. Overrides are used to customize the default tax rate for some products, product types, or shipping options.
### Override Types
There are three override types:
- **Products**: Used to override the tax rate applied on specific products during checkout.
- **Product Types:** Used to override the tax rate applied on a product type. This subsequently overrides the tax rate of any product having this type during checkout.
- **Shipping Options:** Used to override the tax rate applied on selected shipping methods during checkout.
### Add Override
To add an override while adding or editing a tax rate:
- Under the Overrides section, click Add Overrides
- Choose the type of the override, then choose the specific entries in that type that you want to apply the tax rate to. For example, if you chose the Products type, choose at least one product to apply the override to.
- Once done, click on Add.
- In the tax rate form, click on Save.
:::info
If you already have an override for one of the types, and you choose to add a new override for that same type, the new override replaces the old one. If you want to add new entries to the same type (for example, add more products to the Products override), you should [edit the existing override](#edit-override) instead.
:::
![Form to add an override](https://i.imgur.com/xIP8gnb.png)
### Edit Override
You can edit an override to select more entries for or remove entries from an override type.
To edit an override:
- Open the edit form of a tax rate.
- Under the overrides section, find the override type you want to edit. For example, if you want to add a product to the overrides, find the override with the title “Product Rules”.
- Click on the three dots next to the override type.
- Choose Edit from the dropdown.
- You can then change the selected entries for the override type.
- Once done, click Add.
- In the edit form of the tax rate, click Save.
![Edit link is the first link in the dropdown](https://i.imgur.com/1qE7vyF.png)
### Delete Override
:::caution
If you delete an override you won’t be able to restore it and it won’t be applied during checkout. If you want to, instead, remove some entries from an override type, you should [edit the override](#edit-override) instead.
:::
To delete an override:
- Open the edit form of a tax rate.
- Under the overrides section, find the override type you want to delete.
- Click on the three dots next to the override type.
- Choose "Delete rule" from the dropdown.
- Click Save.
![Delete rule link is the second link in the dropdown](https://i.imgur.com/c8yEmrD.png)

11
docs/content/user-guide/taxes/tax-inclusive.md Normal file
View File

@@ -0,0 +1,11 @@
---
sidebar_position: 5
---
# Tax Inclusive Pricing Overview
:::note
This guide is coming soon.
:::

78
docs/content/user-guide/taxes/tax-overrides.mdx Normal file
View File

@@ -0,0 +1,78 @@
---
sidebar_position: 4
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Tax Overrides
In this document, you’ll learn how to manage tax overrides in your Medusa Admin.
## Overview
When you create or edit a [tax rate](./tax-rates.mdx), you can add, edit, and delete overrides. Overrides are used to customize the tax rate applied for some products, product types, or shipping options.
### Override Types
There are three override types:
1. **Products**: Used to override the tax rate applied on specific products during checkout.
2. **Product Types:** Used to override the tax rate applied on a product type. This subsequently overrides the tax rate of any product having this type during checkout.
3. **Shipping Options:** Used to override the tax rate applied on selected shipping methods during checkout.
---
## Add Override
To add an override while [adding or editing a tax rate](./tax-rates.mdx#create-tax-rate):
1. Go to Settings → Taxes
2. Select the region that the tax rate you want to edit belongs to.
3. Under the Overrides section, click Add Overrides
4. Choose the type of the override, then choose the specific entries in that type that you want to apply the tax rate to. For example, if you chose the Products type, choose at least one product to apply the override to.
5. Once done, click on Add.
6. In the tax rate form, click on Save.
:::info
If you already have an override for one of the types, and you choose to add a new override for that same type, the new override replaces the old one. If you want to add new entries to the same type (for example, add more products to the Products override), you should edit the existing override instead.
:::
---
## Edit Override
You can edit an override to select more entries for or remove entries from an override type.
To edit an override:
1. Go to Settings → Taxes
2. Select the region that the tax rate you want to edit belongs to.
3. From the list of tax rates in the Details section, find the tax rate that the override you want to edit belongs to and click the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon.
4. Under the overrides section, find the override type you want to edit. For example, if you want to add a product to the overrides, find the override with the title “Product Rules”.
5. Click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon next to the override type.
6. Choose Edit from the dropdown.
7. You can then change the selected entries for the override type.
8. Once done, click Add.
9. In the edit form of the tax rate, click Save.
---
## Delete Override
:::caution
If you delete an override you won’t be able to restore it and it won’t be applied during checkout. If you want to, instead, remove some entries from an override type, you should edit the override instead.
:::
To delete an override:
1. Go to Settings → Taxes
2. Select the region that the tax rate you want to edit belongs to.
3. From the list of tax rates in the Details section, find the tax rate that the override you want to delete belongs to and click the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon.
4. Under the overrides section, find the override type you want to delete.
5. Click on the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon next to the override type.
6. Choose “Delete rule” from the dropdown.
7. Click Save.

63
docs/content/user-guide/taxes/tax-rates.mdx Normal file
View File

@@ -0,0 +1,63 @@
---
sidebar_position: 3
---
import UiIcon from '@site/src/components/UiIcon';
# Manage Tax Rates
In this document, you’ll learn how to manage tax rates in your Medusa Admin.
## Overview
Regions have at least one tax rate, which is the default tax rate. You can, however, add more tax rates for further customization. You can also edit or delete tax rates.
---
## Create Tax Rates
To add a tax rate:
1. Go to Settings → Taxes
2. Select a region that you want to add a new tax rate to.
3. Click on New Tax Rate at the top right of the Details section.
4. This opens the tax rate form in a new window.
5. You can optionally [add overrides to the tax rate](./tax-overrides.mdx).
6. Once done, click Save.
---
## Edit Tax Rate
To edit a tax rate:
1. Go to Settings → Taxes
2. Select the region that the tax rate you want to edit belongs to.
3. From the list of tax rates in the Details section, find the tax rate you want to edit and click the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon.
4. Choose Edit from the dropdown.
5. In the form that opens in the new window, you can edit the basic details of the tax rate such as the name or rate. If you’re editing a tax rate that’s not the default, you can [manage overrides of this tax rate](./tax-overrides.mdx).
6. Once done, click Save.
---
## Delete Tax Rate
:::warning
If you delete a tax rate, you won’t be able to restore it or use it during checkout.
:::
To delete a tax rate:
1. Go to Settings → Taxes
2. Select the region that the tax rate you want to delete belongs to.
3. From the list of tax rates in the Details section, find the tax rate you want to delete and click the <UiIcon lightIcon="https://i.imgur.com/1ordBC6.png" darkIcon="https://i.imgur.com/dSwWYBH.png" alt="three dots" /> icon.
4. Choose Delete Tax Rate from the dropdown.
5. Confirm deleting the tax rate by clicking the “Yes, confirm” button in the pop-up.
:::info
Default tax rates can’t be deleted. If you don’t want to apply any taxes in a region, you can instead set the default tax rate to 0.
:::