docs: many improvements to settings user guides (#11536)
* docs: many improvements to settings user guides * fix build errors
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
dbd06fd41d
commit
39a0077e84
27 files changed
+1073
-649
No files matched your search
@@ -1,53 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
import { EllipsisHorizontal } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Sales Channels`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll learn how to manage sales channels in your Medusa Admin.
|
||||
|
||||
## Create a Sales Channel
|
||||
|
||||
To create a sales channel:
|
||||
|
||||
1. Go to Settings → Sales Channels.
|
||||
2. Click the Create button.
|
||||
3. In the form that opens, enter the sales channel's details.
|
||||
4. Once you're done, click the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Edit a Sales Channel
|
||||
|
||||
To edit a sales channel:
|
||||
|
||||
1. Go to Settings → Sales Channels.
|
||||
2. Find the sales channel in the list and click on it.
|
||||
3. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
|
||||
4. Choose Edit from the dropdown.
|
||||
5. In the drawer that opens, edit the sales channel's details.
|
||||
6. Once you're done, click the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Delete a Sales Channel
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Deleting a sales channel is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
To delete a sales channel:
|
||||
|
||||
1. Go to Settings → Sales Channels.
|
||||
2. Find the sales channel in the list and click on it.
|
||||
3. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
|
||||
4. Choose Delete from the dropdown.
|
||||
5. Confirm deleting the sales channel by entering its name in the field and clicking the Delete button in the pop-up.
|
||||
@@ -2,41 +2,134 @@
|
||||
sidebar_position: 8
|
||||
---
|
||||
|
||||
import { EllipsisHorizontal } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Sales Channels`,
|
||||
title: `Manage Sales Channels`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
In this document, you’ll get an overview of sales channels in Medusa.
|
||||
In this guide, you’ll learn what sales channels are and how to manage them in the Medusa Admin.
|
||||
|
||||
## What is a Sales Channel?
|
||||
|
||||
A sales channel is a channel that you sell your products through. For example, you can have a sales channel for the web storefront, another for the mobile app, and another for selling across social media platforms.
|
||||
|
||||
By default, there’s a default sales channel in a Medusa store. You can add multiple sales channels.
|
||||
You can set a default sales channel in your [store settings](../store/page.mdx) that is used when no sales channel is specified. This is also useful if you're not selling through multiple channels.
|
||||
|
||||
### How Sales Channels Work
|
||||
|
||||
Sales channels are associated with other data and settings in your commerce store:
|
||||
|
||||
- You can choose which products are available in a sales channel. This is useful when you provide different products for different types of channels. For example, you can have a B2B sales channel and only make B2B products available in it.
|
||||
- When a customer places an order from a sales channel, the order is associated with it. This is useful if you're processing orders differently for each sales channel. For example, orders placed through an offline store are processed differently than through an online storefront.
|
||||
- Stock locations and shipping options are also associated with sales channels. So, when a customer places an order, the items are fulfilled from the stock location associated with the order's sales channel.
|
||||
|
||||
<Note title="Technical Tip">
|
||||
|
||||
{/* TODO add link */}
|
||||
|
||||
Developers can use [Publishable API Keys](#) to easily associate a storefront or client with a sales channel.
|
||||
|
||||
</Note>
|
||||
|
||||
---
|
||||
|
||||
## How Sales Channels Work
|
||||
## View Sales Channels
|
||||
|
||||
Sales channels are associated with data and settings in your commerce store:
|
||||
To view sales channels in your store, go to Settings → Sales Channels. Here, you can see a list of all the sales channels you have set up in your store. You can also search, filter, and sort the sales channels to find the one you are looking for.
|
||||
|
||||
- You can choose which products are available in a sales channel.
|
||||
- When a customer places an order from a sales channel, the order is associated with it.
|
||||
- Locations used with inventory are also associated with sales channels.
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Sales Channels Settings Overview
|
||||
## Create Sales Channel
|
||||
|
||||
To view the available sales channels and settings, go to Settings → Sales channels.
|
||||
To create a sales channel:
|
||||
|
||||
The sales channels settings page shows available sales channels and allows you to manage sales channels.
|
||||
1. Go to Settings → Sales Channels.
|
||||
2. Click the Create button at the top right.
|
||||
3. In the form that opens:
|
||||
- In the Name field, enter a name for the sales channel. For example, "Web Storefront".
|
||||
- In the Description field, enter a description of the sales channel.
|
||||
- If you don't want to enable the sales channel immediately, disable the "Enabled" toggle.
|
||||
4. Once you're done, click the Save button.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Learn More About Sales Channels
|
||||
## View Sales Channel Details
|
||||
|
||||
- [Manage Sales Channels](./manage/page.mdx)
|
||||
- [Manage Products in Sales Channels](./products/page.mdx)
|
||||
To view the details of a sales channel:
|
||||
|
||||
1. Go to Settings → Sales Channels.
|
||||
2. Click on a sales channel from the list.
|
||||
|
||||
This opens the sales channel's details page where you can also manage the sales channel.
|
||||
|
||||
|
||||
|
||||
### Sales Channel Status
|
||||
|
||||
The status of a sales channel is shown at the top right of the first section in the details page. The status can be either "Enabled" or "Disabled". You can change the status by [editing the sales channel details](#edit-sales-channel-details).
|
||||
|
||||
---
|
||||
|
||||
## Edit Sales Channel Details
|
||||
|
||||
To edit the details of a sales channel:
|
||||
|
||||
1. Go to the sales channel's details page.
|
||||
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
|
||||
3. Choose Edit from the dropdown.
|
||||
4. In the side window that opens, you can edit the sales channel's name, description, and whether it's enabled.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Manage Products in Sales Channel
|
||||
|
||||
You can manage the products available in a sales channel from the sales channel's details page.
|
||||
|
||||
### Add Products to Sales Channel
|
||||
|
||||
To add products to a sales channel:
|
||||
|
||||
1. Go to the sales channel's details page.
|
||||
2. Click the "Add" button in the "Products" section.
|
||||
3. In the list that opens, check the products you want to add to the sales channel.
|
||||
4. Click the Save button.
|
||||
|
||||
|
||||
|
||||
### Remove Products from Sales Channel
|
||||
|
||||
To remove products from a sales channel:
|
||||
|
||||
1. Go to the sales channel's details page.
|
||||
2. Under the "Products" section, check the products you want to remove from the sales channel.
|
||||
3. Press <Kbd>R</Kbd> or click the Remove button at the bottom center of the page.
|
||||
4. Confirm removing the product by clicking the Delete button in the pop-up.
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Delete Sales Channel
|
||||
|
||||
<Note type="warning">
|
||||
|
||||
Deleting a sales channel is irreversible.
|
||||
|
||||
</Note>
|
||||
|
||||
To delete a sales channel:
|
||||
|
||||
1. Go to the sales channel's details page.
|
||||
2. Click the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon at the top right of the first section.
|
||||
3. Choose Delete from the dropdown.
|
||||
4. Confirm deleting the sales channel by entering the sales channel's name and clicking the "Delete" button in the pop-up.
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
sidebar_label: Manage Products
|
||||
---
|
||||
|
||||
import { EllipsisHorizontal } from "@medusajs/icons"
|
||||
|
||||
export const metadata = {
|
||||
title: `Manage Products in Sales Channels`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
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.
|
||||
|
||||
</Note>
|
||||
|
||||
## Add Products to Sales Channels
|
||||
|
||||
To add products to a sales channel:
|
||||
|
||||
1. Go to Settings → Sales Channels
|
||||
2. Find the sales channel in the list and click on it.
|
||||
3. Under the Products section, click the Add button at the top right.
|
||||
4. In the list of products shown, check the checkboxes next to the products to add.
|
||||
5. Once you're done, click the Save button.
|
||||
|
||||
---
|
||||
|
||||
## Remove Product from Sales Channel
|
||||
|
||||
To remove a product from a sales channel:
|
||||
|
||||
1. Go to Settings → Sales Channels
|
||||
2. Find the sales channel in the list and click on it.
|
||||
3. Under the Products section, find the product to remove and click on the <InlineIcon Icon={EllipsisHorizontal} alt="three-dots" /> icon to its right.
|
||||
4. Choose Remove from the dropdown.
|
||||
Reference in new issue
Block a user