Sales Channel Module

Learn about the Sales Channel Module and how to manage multiple sales channels in Medusa.

Overview

The Sales Channel Module manages different sales channels for your commerce operations. Sales channels allow you to organize products, orders, and inventory across different storefronts, marketplaces, or distribution channels.

Key Features:

• Multiple sales channel support
• Channel-specific product availability
• Channel-based order tracking
• Inventory management per channel
• Channel metadata and customization

When to Use

Use the Sales Channel Module when you need to:

• Manage multiple storefronts (web, mobile app, etc.)
• Sell on different marketplaces
• Separate B2B and B2C channels
• Track sales by channel
• Control product availability per channel
• Support multi-brand commerce
• Implement channel-specific pricing or promotions

Data Models

SalesChannel

Represents a sales channel or storefront.

id · string · required

Unique sales channel identifier

name · string · required

Sales channel name

description · string

Sales channel description

is_disabled · boolean

Whether the channel is disabled (default: false)

metadata · object

Additional custom data

Service Interface

The Sales Channel Module service is available at @medusajs/medusa/sales-channel.

Create Sales Channel

Create a new sales channel.

Example

import { MedusaRequest, MedusaResponse } from "@medusajs/framework/http"
import { ISalesChannelModuleService } from "@medusajs/framework/types"
import { Modules } from "@medusajs/framework/utils"

export async function POST(
  req: MedusaRequest,
  res: MedusaResponse
) {
  const salesChannelModuleService: ISalesChannelModuleService = req.scope.resolve(
    Modules.SALES_CHANNEL
  )

  const salesChannel = await salesChannelModuleService.createSalesChannels({
    name: "Mobile App",
    description: "iOS and Android mobile applications",
    is_disabled: false,
  })

  res.json({ sales_channel: salesChannel })
}

data · CreateSalesChannelDTO | CreateSalesChannelDTO[] · required

Sales channel data

name · string · required

Sales channel name

description · string

Sales channel description

is_disabled · boolean

Whether to disable the channel

metadata · object

Custom metadata

salesChannel · SalesChannelDTO | SalesChannelDTO[]

The created sales channel(s)

Retrieve Sales Channel

Get a sales channel.

Example

const salesChannel = await salesChannelModuleService.retrieveSalesChannel(
  "sc_mobile"
)

console.log(salesChannel.name) // "Mobile App"

salesChannelId · string · required

The ID of the sales channel to retrieve

config · FindConfig

Configuration for the query

salesChannel · SalesChannelDTO

The retrieved sales channel

List Sales Channels

List all sales channels.

Example

const salesChannels = await salesChannelModuleService.listSalesChannels({
  is_disabled: false,
})

for (const channel of salesChannels) {
  console.log(channel.name)
}

filters · FilterableSalesChannelProps

Filters to apply

id · string | string[]

Filter by sales channel IDs

name · string | string[]

Filter by name

is_disabled · boolean

Filter by disabled status

salesChannels · SalesChannelDTO[]

Array of sales channels

Update Sales Channel

Modify a sales channel.

Example

const salesChannel = await salesChannelModuleService.updateSalesChannels(
  "sc_mobile",
  {
    description: "Updated mobile app channel",
    is_disabled: false,
  }
)

salesChannelId · string · required

ID of the sales channel to update

data · UpdateSalesChannelDTO · required

Fields to update

name · string

Sales channel name

description · string

Description

is_disabled · boolean

Whether to disable

Delete Sales Channel

Remove a sales channel.

Example

await salesChannelModuleService.deleteSalesChannels(["sc_old"])

Integration Examples

With Product Module

Associate products with sales channels.

Example

import { Modules } from "@medusajs/framework/utils"

const productModule = container.resolve(Modules.PRODUCT)
const salesChannelModule = container.resolve(Modules.SALES_CHANNEL)

// Create sales channels
const webChannel = await salesChannelModule.createSalesChannels({
  name: "Website",
})

const appChannel = await salesChannelModule.createSalesChannels({
  name: "Mobile App",
})

// Products are linked to sales channels via workflows
// or Link Modules in Medusa

With Cart Module

Create carts for specific channels.

Example

import { Modules } from "@medusajs/framework/utils"

const cartModule = container.resolve(Modules.CART)
const salesChannelModule = container.resolve(Modules.SALES_CHANNEL)

// Get sales channel
const salesChannel = await salesChannelModule.retrieveSalesChannel("sc_web")

// Create cart for channel
const cart = await cartModule.createCarts({
  sales_channel_id: salesChannel.id,
  currency_code: "usd",
  email: "[e-mail]",
})

With Order Module

Track orders by sales channel.

Example

import { Modules } from "@medusajs/framework/utils"

const orderModule = container.resolve(Modules.ORDER)

// List orders for specific channel
const orders = await orderModule.listOrders({
  sales_channel_id: "sc_mobile",
})

console.log(`${orders.length} orders from mobile app`)

With Inventory Module

Channel-specific inventory availability.

Example

import { Modules } from "@medusajs/framework/utils"

const inventoryModule = container.resolve(Modules.INVENTORY)

// Check inventory available for channel
// (via product-sales channel links)
const availableQuantity = await inventoryModule.retrieveAvailableQuantity(
  "iitem_123",
  ["sloc_warehouse"]
)

Common Use Cases

Multi-Storefront

Example

// Main website
const webChannel = await salesChannelModuleService.createSalesChannels({
  name: "Website",
  description: "Main e-commerce website",
})

// Mobile app
const appChannel = await salesChannelModuleService.createSalesChannels({
  name: "Mobile App",
  description: "iOS and Android apps",
})

// Physical stores
const storeChannel = await salesChannelModuleService.createSalesChannels({
  name: "Retail Stores",
  description: "Point of sale systems in physical locations",
})

Marketplace Integration

Example

// Amazon
const amazonChannel = await salesChannelModuleService.createSalesChannels({
  name: "Amazon",
  description: "Amazon marketplace integration",
  metadata: {
    marketplace: "amazon",
    seller_id: "ABC123",
  },
})

// eBay
const ebayChannel = await salesChannelModuleService.createSalesChannels({
  name: "eBay",
  description: "eBay marketplace integration",
  metadata: {
    marketplace: "ebay",
    store_name: "MyStore",
  },
})

B2B vs B2C

Example

// B2C channel
const b2cChannel = await salesChannelModuleService.createSalesChannels({
  name: "Retail",
  description: "Direct to consumer sales",
  metadata: {
    type: "b2c",
  },
})

// B2B channel
const b2bChannel = await salesChannelModuleService.createSalesChannels({
  name: "Wholesale",
  description: "Business to business sales",
  metadata: {
    type: "b2b",
    minimum_order: 1000,
  },
})

Multi-Brand

Example

// Brand A
const brandAChannel = await salesChannelModuleService.createSalesChannels({
  name: "Brand A Store",
  description: "Premium brand storefront",
  metadata: {
    brand: "brand-a",
  },
})

// Brand B
const brandBChannel = await salesChannelModuleService.createSalesChannels({
  name: "Brand B Store",
  description: "Economy brand storefront",
  metadata: {
    brand: "brand-b",
  },
})

Best Practices

1. Channel Naming: Use clear, descriptive names that identify the channel’s purpose (“Website”, “Mobile App”, “Amazon”, etc.).

2. Metadata Usage: Store channel-specific configuration in metadata:

   • API credentials for marketplace integrations
   • Channel type (b2b, b2c, marketplace)
   • Brand identifiers
   • Custom settings

3. Default Channel: Create a default sales channel for your primary storefront during initial setup.

4. Disabled Channels: Use is_disabled instead of deleting channels to maintain historical data and reporting.

5. Product Availability: Control which products appear in each channel using product-sales channel links (managed via workflows).

6. Analytics: Track performance by channel by filtering orders, carts, and sales data by sales_channel_id.

7. Channel Context: Always include sales_channel_id when:

   • Creating carts
   • Creating orders
   • Checking product availability
   • Calculating prices

Related Modules

• Product Module - Control product availability per channel
• Cart Module - Create channel-specific carts
• Order Module - Track orders by channel
• Inventory Module - Channel inventory management