-
-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: added sales channel conceptual guide (#2342)
* docs: added sales channel conceptual guide * fixed file path * added dividers
- Loading branch information
1 parent
d516e04
commit 4836127
Showing
2 changed files
with
77 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
# Sales Channels | ||
|
||
In this document, you’ll learn about Sales Channels and how they can be used in Medusa. | ||
|
||
:::note | ||
|
||
The Sales Channels feature is currently in beta mode and guarded by a feature flag. To use Sales Channels either: | ||
|
||
1. Enable the `MEDUSA_FF_SALES_CHANNELS` environment variable; | ||
2. Or enable the `sales_channels` key in the Medusa server's settings. | ||
|
||
You can learn more about enabling it in the [feature flags](../feature-flags/toggle.md) documentation. | ||
|
||
::: | ||
|
||
## Introduction | ||
|
||
Sales Channels allow you to separate between the different channels you sell products in. For example, you can have a sales channel for your website and another for your mobile apps. | ||
|
||
Sales Channels are associated with stores, products, carts, and orders: A store has a default sales channel; you can define which products are available in a sales channel; you can specify the sales channel of a cart; you can filter orders by sales channel. | ||
|
||
### Example Use Cases | ||
|
||
The sales channel feature can be used in a variety of use cases including: | ||
|
||
- Implement a B2B Ecommerce Store. | ||
- Specifying different products for each channel you sell in. | ||
- Support Omnichannel in your ecommerce store. | ||
|
||
--- | ||
|
||
## SalesChannel Entity Overview | ||
|
||
A sales channel is stored in the database as a [SalesChannel](../../../references/entities/classes/SalesChannel.md) entity. Some of its important attributes are: | ||
|
||
- `name`: The name of the sales channel. | ||
- `is_disabled`: A boolean value indicating of the Sales Channel is disabled or not. | ||
|
||
--- | ||
|
||
## Relations to Other Entities | ||
|
||
### Store | ||
|
||
A store has a default sales channel. When you first run your Medusa server or seed your database, a default sales channel is created, if it doesn’t exist, and associated with the store. | ||
|
||
The relation is implemented in the [Store](../../../references/entities/classes/Store.md) entity. You can access the default sales channel of a store by expanding the `default_sales_channel` relation and using `store.default_sales_channel`. You can also access the ID of the default sales channel using `store.default_sales_channel_id`. | ||
|
||
### Product | ||
|
||
Products can be available in more than one sales channel. You can then filter products by a sales channel using the Storefront and Admin APIs. | ||
|
||
The relation is implemented in the [Product](../../../references/entities/classes/Product.md) entity. You can access the sales channels a product is available in by expanding the `sales_channels` relation and using `product.sales_channels`. | ||
|
||
### Cart | ||
|
||
When you create a cart, you can optionally specify the sales channel it belongs to. If you don’t set the sales channel, the store’s default sales channel will be associated with it. | ||
|
||
A cart can belong to only one sales channel. Only products that belong to the same sales channel as the cart can be added to it. | ||
|
||
The relation is implemented in the [Cart](../../../references/entities/classes/Cart.md) entity. You can access the sales channel a cart is associated with by expanding the `sales_channel` relation and using `cart.sales_channel`. You can also access the ID of the sales channel using `cart.sales_channel_id`. | ||
|
||
### Order | ||
|
||
Orders can optionally be associated with a sales channel. You can filter orders by a sales channel using the Storefront and Admin APIs. | ||
|
||
The relation is implemented in the [Order](../../../references/entities/classes/Order.md) entity. You can access the sales channel an order is associated with by expanding the `sales_channel` relation and using `order.sales_channel`. You can also access the ID of the sales channel using `order.sales_channel_id`. | ||
|
||
--- | ||
|
||
## What’s Next 🚀 | ||
|
||
- Check out the [Sales Channel’s Admin APIs](https://docs.medusajs.com/api/admin/#tag/Sales-Channel). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters