* docs(refactoring): configured eslint and typescript (#3511) * docs: configured eslint and typescript * fixed yarn.lock * docs(refactoring): migrate components directory to typescript (#3517) * docs: migrate components directory to typescript * removed vscode settings * fix following merge * docs: refactored QueryNote component (#3576) * docs: refactored first batch of theme components (#3579) * docs: refactored second batch of theme components (#3580) * added missing badge styles * fix after merge * docs(refactoring): migrated remaining component to TypeScript (#3770) * docs(refactoring): configured eslint and typescript (#3511) * docs: configured eslint and typescript * fixed yarn.lock * docs(refactoring): migrate components directory to typescript (#3517) * docs: migrate components directory to typescript * removed vscode settings * fix following merge * docs: refactored QueryNote component (#3576) * docs: refactored first batch of theme components (#3579) * docs: refactored second batch of theme components (#3580) * added missing badge styles * docs: refactoring second batch of theme components * fix after merge * refactored icons and other components * docs: refactored all components * docs(refactoring): set up and configured Tailwind Css (#3841) * docs: added tailwind config * docs: added more tailwind configurations * add includes option * added more tailwind configurations * fix to configurations * docs(refactoring): use tailwind css (#4134) * docs: added tailwind config * docs: added more tailwind configurations * add includes option * added more tailwind configurations * fix to configurations * docs(refactoring): refactored all styles to use tailwind css (#4132) * refactored Badge component to use tailwind css * refactored Bordered component to use tailwind css * updated to latest docusaurus * refactored BorderedIcon component to use tailwind css * refactored Feedback component to use tailwind css * refactored icons and footersociallinks to tailwind css * start refactoring of large card * refactored large card styling * refactored until admonitions * refactored until codeblock * refactored until Tabs * refactored Tabs (without testing * finished refactoring styles to tailwind css * upgraded to version 2.4.1 * general fixes * adjusted eslint configurations * fixed ignore files * fixes to large card * fix search styling * fix npx command * updated tabs to use isCodeTabs prop * fixed os tabs * removed os-tabs class in favor of general styling * improvements to buttons * fix for searchbar * fixed redocly download button * chore: added eslint code action (#4135) * small change in commerce modules page
256 lines
6.6 KiB
Plaintext
256 lines
6.6 KiB
Plaintext
---
|
||
description: 'Learn how to implement sales channel functionalities in the storefront using REST APIs. This includes filtering products by Sales Channel and associating a cart with a sales channel.'
|
||
addHowToData: true
|
||
---
|
||
|
||
import Tabs from '@theme/Tabs';
|
||
import TabItem from '@theme/TabItem';
|
||
|
||
# How to Use Sales Channels in Storefronts
|
||
|
||
In this document, you’ll learn how to use sales channels in your storefront.
|
||
|
||
## Overview
|
||
|
||
In your storefront, you can filter products by sales channels. You can also associate carts with a sales channel.
|
||
|
||
This guide explains how to perform these operations using the Storefront APIs.
|
||
|
||
### Alternative Approach: Publishable API keys
|
||
|
||
This guide covers how to pass the sales channel ID into different requests to retrieve or process data associated with the sales channel.
|
||
|
||
An alternative approach is to use Publishable API keys. You can learn how to use them in the following documents:
|
||
|
||
- [Using publishable API keys in requests](../../../development/publishable-api-keys/index.mdx)
|
||
- Managing publishable API keys using [admin APIs](../../../development/publishable-api-keys/admin/manage-publishable-api-keys.mdx) or using [Medusa Admin](../../../user-guide/settings/publishable-api-keys.mdx)
|
||
|
||
---
|
||
|
||
## Prerequisites
|
||
|
||
### Medusa Components
|
||
|
||
It's assumed that you already have a Medusa backend installed and set up. If not, you can follow our [quickstart guide](../../../development/backend/install.mdx) to get started.
|
||
|
||
It is also assumed you already have a storefront set up. It can be a custom storefront or one of Medusa’s storefronts. If you don’t have a storefront set up, you can install the [Next.js starter storefront](../../../starters/nextjs-medusa-starter.mdx).
|
||
|
||
### JS Client
|
||
|
||
This guide includes code snippets to send requests to your Medusa backend using Medusa’s JS Client, among other methods.
|
||
|
||
If you follow the JS Client code blocks, it’s assumed you already have [Medusa’s JS Client installed](../../../js-client/overview.md) and have [created an instance of the client](../../../js-client/overview.md#configuration).
|
||
|
||
### Medusa React
|
||
|
||
This guide also includes code snippets to send requests to your Medusa backend using Medusa React, among other methods.
|
||
|
||
If you follow the Medusa React code blocks, it's assumed you already have [Medusa React installed](../../../medusa-react/overview.md) and have [used MedusaProvider higher in your component tree](../../../medusa-react/overview.md#usage).
|
||
|
||
For requests that use the cart, it's also assumed you already have [used CartProvider higher in your component tree](../../../medusa-react/overview.md#cartprovider).
|
||
|
||
---
|
||
|
||
## Filter Products by Sales Channel
|
||
|
||
To filter products by a specific sales channel, pass the `sales_channel_id` query parameter to the List Products endpoint:
|
||
|
||
<Tabs groupId="request-type" isCodeTabs={true}>
|
||
<TabItem value="client" label="Medusa JS Client" default>
|
||
|
||
```ts
|
||
medusa.products.list({
|
||
sales_channel_id: [
|
||
salesChannelId,
|
||
],
|
||
})
|
||
.then(({ products, limit, offset, count }) => {
|
||
console.log(products.length)
|
||
})
|
||
```
|
||
|
||
</TabItem>
|
||
<TabItem value="medusa-react" label="Medusa React">
|
||
|
||
```tsx
|
||
import { Product } from "@medusajs/medusa"
|
||
import { useProducts } from "medusa-react"
|
||
|
||
const Products = () => {
|
||
const { products, isLoading } = useProducts({
|
||
sales_channel_id: [
|
||
salesChannelId,
|
||
],
|
||
})
|
||
|
||
return (
|
||
<div>
|
||
{isLoading && <span>Loading...</span>}
|
||
{products && products.length > 0 && (
|
||
<ul>
|
||
{products.map((product: Product) => (
|
||
<li key={product.id}>{product.title}</li>
|
||
))}
|
||
</ul>
|
||
)}
|
||
{products && !products.length && <span>No Products</span>}
|
||
</div>
|
||
)
|
||
}
|
||
|
||
export default Products
|
||
```
|
||
|
||
</TabItem>
|
||
<TabItem value="fetch" label="Fetch API">
|
||
|
||
<!-- eslint-disable max-len -->
|
||
|
||
```ts
|
||
fetch(`<BACKEND_URL>/store/products?sales_channel_id[0]=${salesChannelId}`)
|
||
.then((response) => response.json())
|
||
.then(({ products, limit, offset, count }) => {
|
||
console.log(products.length)
|
||
})
|
||
```
|
||
|
||
</TabItem>
|
||
</Tabs>
|
||
|
||
The `sales_channel_id` query parameter is an array of sales channel IDs. You can pass more than one sales channel.
|
||
|
||
The request returns an array of products. These are the products that are available in the sales channel.
|
||
|
||
---
|
||
|
||
## Associate a Cart with a Sales Channel
|
||
|
||
### When Creating a Cart
|
||
|
||
To associate a sales channel with a cart while creating it, you can pass the `sales_channel_id` request body parameter with the ID of the sales channel:
|
||
|
||
<Tabs groupId="request-type" isCodeTabs={true}>
|
||
<TabItem value="client" label="Medusa JS Client" default>
|
||
|
||
|
||
```ts
|
||
medusa.carts.create({
|
||
sales_channel_id: salesChannelId,
|
||
})
|
||
.then(({ cart }) => {
|
||
console.log(cart.id)
|
||
})
|
||
```
|
||
|
||
</TabItem>
|
||
<TabItem value="medusa-react" label="Medusa React">
|
||
|
||
```tsx
|
||
import { useCart } from "medusa-react"
|
||
|
||
const Cart = () => {
|
||
const { cart, createCart } = useCart()
|
||
|
||
const handleCreateCart = () => {
|
||
createCart.mutate(
|
||
{
|
||
sales_channel_id: salesChannelId,
|
||
},
|
||
{
|
||
onSuccess: ({ cart }) => {
|
||
localStorage.setItem("cart_id", cart.id)
|
||
},
|
||
}
|
||
)
|
||
}
|
||
|
||
// ...
|
||
}
|
||
|
||
export default Cart
|
||
```
|
||
|
||
</TabItem>
|
||
<TabItem value="fetch" label="Fetch API">
|
||
|
||
```ts
|
||
fetch(`<BACKEND_URL>/store/carts`, {
|
||
method: "POST",
|
||
headers: {
|
||
"Content-Type": "application/json",
|
||
},
|
||
body: JSON.stringify({
|
||
sales_channel_id: salesChannelId,
|
||
}),
|
||
})
|
||
.then((response) => response.json())
|
||
.then(({ cart }) => {
|
||
console.log(cart.id)
|
||
})
|
||
```
|
||
|
||
</TabItem>
|
||
</Tabs>
|
||
|
||
The request returns the created cart.
|
||
|
||
### Updating an Existing Cart
|
||
|
||
You can update the sales channel of an existing cart by passing the `sales_channel_id` request body parameter with the ID of the sales channel:
|
||
|
||
<Tabs groupId="request-type" isCodeTabs={true}>
|
||
<TabItem value="client" label="Medusa JS Client" default>
|
||
|
||
```ts
|
||
medusa.carts.update(cartId, {
|
||
sales_channel_id: salesChannelId,
|
||
})
|
||
.then(({ cart }) => {
|
||
console.log(cart.id)
|
||
})
|
||
```
|
||
|
||
</TabItem>
|
||
<TabItem value="medusa-react" label="Medusa React">
|
||
|
||
```tsx
|
||
import { useCart } from "medusa-react"
|
||
|
||
const Cart = () => {
|
||
// ...
|
||
|
||
const { updateCart } = useCart()
|
||
|
||
const changeSalesChannel = (salesChannelId: string) => {
|
||
updateCart.mutate({
|
||
sales_channel_id: salesChannelId,
|
||
})
|
||
}
|
||
|
||
// ...
|
||
}
|
||
|
||
export default Cart
|
||
```
|
||
|
||
</TabItem>
|
||
<TabItem value="fetch" label="Fetch API">
|
||
|
||
```ts
|
||
fetch(`<BACKEND_URL>/store/carts/${cartId}`, {
|
||
method: "POST",
|
||
headers: {
|
||
"Content-Type": "application/json",
|
||
},
|
||
body: JSON.stringify({
|
||
sales_channel_id: salesChannelId,
|
||
}),
|
||
})
|
||
.then((response) => response.json())
|
||
.then(({ cart }) => console.log(cart.id))
|
||
```
|
||
|
||
</TabItem>
|
||
</Tabs>
|
||
|
||
The request returns the updated cart. |