asyavee/medusa-store
1
0 Fork 0
Code Issues Pull Requests Actions 3 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 authored and GitHub committed 2022-08-30 16:22:06 +03:00
1 parent 5a68665f33
commit f3170ba529
57 files changed
+1331 -1309
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/content/user-guide/sales-channels/_category_.json
+6
View File
@@ -0,0 +1,6 @@
{
"position": 11,
"collapsed": false,
"link": null,
"label": "Sales Channels"
}
docs/content/user-guide/sales-channels/index.md
+14 -9
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)
docs/content/user-guide/sales-channels/manage.mdx
+36 -88
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.
docs/content/user-guide/sales-channels/products.mdx
+50
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”.