api-ref: custom API reference (#4770)
* initialized next.js project * finished markdown sections * added operation schema component * change page metadata * eslint fixes * fixes related to deployment * added response schema * resolve max stack issue * support for different property types * added support for property types * added loading for components * added more loading * type fixes * added oneOf type * removed console * fix replace with push * refactored everything * use static content for description * fixes and improvements * added code examples section * fix path name * optimizations * fixed tag navigation * add support for admin and store references * general enhancements * optimizations and fixes * fixes and enhancements * added search bar * loading enhancements * added loading * added code blocks * added margin top * add empty response text * fixed oneOf parameters * added path and query parameters * general fixes * added base path env variable * small fix for arrays * enhancements * design enhancements * general enhancements * fix isRequired * added enum values * enhancements * general fixes * general fixes * changed oas generation script * additions to the introduction section * added copy button for code + other enhancements * fix response code block * fix metadata * formatted store introduction * move sidebar logic to Tags component * added test env variables * fix code block bug * added loading animation * added expand param + loading * enhance operation loading * made responsive + improvements * added loading provider * fixed loading * adjustments for small devices * added sidebar label for endpoints * added feedback component * fixed analytics * general fixes * listen to scroll for other headings * added sample env file * update api ref files + support new fields * fix for external docs link * added new sections * fix last item in sidebar not showing * move docs content to www/docs * change redirect url * revert change * resolve build errors * configure rewrites * changed to environment variable url * revert changing environment variable name * add environment variable for API path * fix links * fix tailwind settings * remove vercel file * reconfigured api route * move api page under api * fix page metadata * fix external link in navigation bar * update api spec * updated api specs * fixed google lint error * add max-height on request samples * add padding before loading * fix for one of name * fix undefined types * general fixes * remove response schema example * redesigned navigation bar * redesigned sidebar * fixed up paddings * added feedback component + report issue * fixed up typography, padding, and general styling * redesigned code blocks * optimization * added error timeout * fixes * added indexing with algolia + fixes * fix errors with algolia script * redesign operation sections * fix heading scroll * design fixes * fix padding * fix padding + scroll issues * fix scroll issues * improve scroll performance * fixes for safari * optimization and fixes * fixes to docs + details animation * padding fixes for code block * added tab animation * fixed incorrect link * added selection styling * fix lint errors * redesigned details component * added detailed feedback form * api reference fixes * fix tabs * upgrade + fixes * updated documentation links * optimizations to sidebar items * fix spacing in sidebar item * optimizations and fixes * fix endpoint path styling * remove margin * final fixes * change margin on small devices * generated OAS * fixes for mobile * added feedback modal * optimize dark mode button * fixed color mode useeffect * minimize dom size * use new style system * radius and spacing design system * design fixes * fix eslint errors * added meta files * change cron schedule * fix docusaurus configurations * added operating system to feedback data * change content directory name * fixes to contribution guidelines * revert renaming content * added api-reference to documentation workflow * fixes for search * added dark mode + fixes * oas fixes * handle bugs * added code examples for clients * changed tooltip text * change authentication to card * change page title based on selected section * redesigned mobile navbar * fix icon colors * fix key colors * fix medusa-js installation command * change external regex in algolia * change changeset * fix padding on mobile * fix hydration error * update depedencies
This commit is contained in:
Shahed Nasser
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"position": 11,
|
||||
"collapsed": false,
|
||||
"link": null,
|
||||
"label": "Sales Channels",
|
||||
"customProps": {
|
||||
"sidebar_is_group_headline": true
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,63 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
description: 'Medusa admin allows merchants to manage their sales channels. Merchants can separate products into multiple sales channels.'
|
||||
---
|
||||
|
||||
# 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.
|
||||
|
||||
## Overview
|
||||
|
||||
Sales Channels are multiple channels that you can 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.
|
||||
|
||||
---
|
||||
|
||||
## How Sales Channels Work
|
||||
|
||||
Sales channels are associated with data and settings in your ecommerce store.
|
||||
|
||||
For each sales channel, you can choose which products belong to that sales channel. A product can be available in more than one sales channel.
|
||||
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
## View Sales Channels of Orders
|
||||
|
||||
### Orders Page
|
||||
|
||||
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.
|
||||
|
||||
### Orders Details Page
|
||||
|
||||
In the details page of an order, you can find the sales channel the order belongs to, if there are any.
|
||||
|
||||
---
|
||||
|
||||
## View Sales Channels of Products
|
||||
|
||||
### Products Page
|
||||
|
||||
In the Products page, you can see the sales channels a product belongs to under the Availability column if there are any.
|
||||
|
||||
### 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.
|
||||
|
||||
---
|
||||
|
||||
## Learn More About Sales Channels
|
||||
|
||||
- [Manage Sales Channels](./manage.mdx)
|
||||
- [Manage Products in Sales Channels](./products.mdx)
|
||||
@@ -0,0 +1,90 @@
|
||||
---
|
||||
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 tax rate by clicking the “Yes, delete” button in the pop-up.
|
||||
@@ -0,0 +1,53 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
sidebar_label: Manage Products
|
||||
description: 'This user guide explains how to manage products in sales channels on the Medusa admin.'
|
||||
addHowToData: true
|
||||
---
|
||||
|
||||
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://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 “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://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 at the right side of the product’s row.
|
||||
5. Choose from the dropdown list “Remove from the channel”.
|
||||
Reference in New Issue
Block a user