bb87db8342
This PR includes documentation that preps for v2 docs (but doesn't introduce new docs). _Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._ ## Changes - Change Medusa version in base OAS used for v2. - Fix to docblock generator related to not catching all path parameters. - Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules. - Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used. - Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment. - Upgraded docusaurus to v3.0.1 - Added new Vale rules to ensure correct spelling of Medusa Admin and module names. - Added new components to the `docs-ui` package that will be used in future documentation changes.
91 lines
5.0 KiB
Plaintext
91 lines
5.0 KiB
Plaintext
---
|
||
sidebar_position: 2
|
||
description: 'This user guide explains how to manage sales channels on the Medusa Admin. Learn how to create, edit, and delete sales channels.'
|
||
addHowToData: true
|
||
---
|
||
|
||
import UiIcon from '@site/src/components/UiIcon';
|
||
|
||
# Manage Sales Channels
|
||
|
||
In this document, you’ll learn how to view and manage sales channels in your Medusa Admin.
|
||
|
||
## View Sales Channels
|
||
|
||
To view sales channels:
|
||
|
||
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.
|
||
|
||
---
|
||
|
||
## Search Sales Channels
|
||
|
||
To search sales channels:
|
||
|
||
1. Go to Settings → Sales Channels
|
||
2. In the Sales Channels section on the left, click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999227/Medusa%20Docs/UI%20Icons/k0U0wpO_pizpfd.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999249/Medusa%20Docs/UI%20Icons/IdKjFak_ultvmh.png" alt="magnifier" /> icon next to the title of the section.
|
||
3. This shows an input to search sales channels by title and description.
|
||
|
||
To clear the search, click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999180/Medusa%20Docs/UI%20Icons/kvGRHQR_s0ptsm.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999200/Medusa%20Docs/UI%20Icons/RJ4SLIu_n30zqr.png" alt="X" /> icon in the search input.
|
||
|
||
---
|
||
|
||
## Create a Sales Channel
|
||
|
||
To add a new sales channel:
|
||
|
||
1. Go to Settings → Sales Channels
|
||
2. In the Sales Channels section on the left, click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999131/Medusa%20Docs/UI%20Icons/1hL8NiW_lqmjcq.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999150/Medusa%20Docs/UI%20Icons/8LtkPqW_jyqz5i.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.
|
||
|
||
---
|
||
|
||
## Change the Status of a Sales Channel
|
||
|
||
A sales channel can be enabled or disabled. If a sales channel is disabled, that means it’s saved as a draft. If it’s enabled, that means it’s published.
|
||
|
||
To enable or disable 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 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://res.cloudinary.com/dza7lstvk/image/upload/v1667999685/Medusa%20Docs/UI%20Icons/yrTcDO4_tulwph.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999685/Medusa%20Docs/UI%20Icons/yrTcDO4_tulwph.png" alt="green" /> icon if it’s enabled or a <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999700/Medusa%20Docs/UI%20Icons/0lUln3B_arpgmo.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999700/Medusa%20Docs/UI%20Icons/0lUln3B_arpgmo.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.
|
||
|
||
---
|
||
|
||
## Edit Sales Channel’s Information
|
||
|
||
To edit a sales channel’s information:
|
||
|
||
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://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.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.
|
||
|
||
---
|
||
|
||
## Delete a Sales Channel
|
||
|
||
:::warning
|
||
|
||
If you delete a sales channel, you won’t be able to restore it. Orders and Products associated with the sales channel will not be affected.
|
||
|
||
:::
|
||
|
||
To delete 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 delete.
|
||
3. At the top right of the right section, click on the <UiIcon lightIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999308/Medusa%20Docs/UI%20Icons/1ordBC6_ssysel.png" darkIcon="https://res.cloudinary.com/dza7lstvk/image/upload/v1667999326/Medusa%20Docs/UI%20Icons/dSwWYBH_stzgoi.png" alt="three dots" /> icon.
|
||
4. Choose from the dropdown list “Delete channel”.
|
||
5. Confirm deleting the sales channel by entering the name of the sales channel and clicking the “Yes, delete” button in the pop-up.
|