Skip to main content

How to Use SalesChannels APIs

In this document, you’ll learn how to manage sales channels and their products and orders using the Admin APIs.

If you’re looking to learn more in-depth about what Sales Channels are and how they work, check out this documentation instead.

Overview

Using Medusa’s Admin APIs, you can manage Sales Channels including creating, retrieving, updating, and deleting sales channels. You can also manage their products and orders.

This guide explains how to perform all these operations using the Admin APIs.


Prerequisites

Medusa Components

It's assumed that you already have a Medusa server installed and set up. If not, you can follow our quickstart guide to get started.

Enabled Feature Flags

The Sales Channels feature is currently in beta mode and guarded by a feature flag. To use sales channels either:

  1. Enable the
    Copy to Clipboard
    environment variable;
  2. Or enable the
    Copy to Clipboard
    key in the Medusa server's settings.

You can learn more about enabling it in the feature flags documentation.

JS Client

This guide includes code snippets to send requests to your Medusa server using Medusa’s JS Client, JavaScript’s Fetch API, or cURL.

If you follow the JS Client code blocks, it’s assumed you already have Medusa’s JS Client installed and have created an instance of the client.

Authenticated Admin User

You must be an authenticated admin user before following along with the steps in this guide.

You can learn more about authenticating as an admin user in the API reference.


Create Sales Channels

You can create a sales channel by sending a request to the Create a Sales Channel endpoint:

Report Incorrect Code
Report Incorrect CodeReport Incorrect Code
Copy to Clipboard
medusa.admin.salesChannels.create({
name: 'App',
description: 'Mobile app'
})
.then(({ sales_channel }) => {
console.log(sales_channel.id);
});
Copy to Clipboard

This request requires the request body parameters

Copy to Clipboard
, and optionally accepts the
Copy to Clipboard
and
Copy to Clipboard
request body parameters.

It returns the created sales channel.


List Sales Channels

You can list all sales channels by sending a request to the List Sales Channels endpoint:

Report Incorrect Code
Report Incorrect CodeReport Incorrect Code
Copy to Clipboard
medusa.admin.salesChannels.list()
.then(({ sales_channels, limit, offset, count }) => {
console.log(sales_channels.length);
});
Copy to Clipboard

This request returns an array of all sales channels in your store. You can also pass query parameters to filter or customize the pagination of the results. Check out the API Reference for a full list of query parameters.


Retrieve a Sales Channel

You can retrieve a sales channel’s details by its ID using the Get Sales Channel endpoint:

Report Incorrect Code
Report Incorrect CodeReport Incorrect Code
Copy to Clipboard
medusa.admin.salesChannels.retrieve(salesChannelId)
.then(({ sales_channel }) => {
console.log(sales_channel.id);
});
Copy to Clipboard

This request returns the sales channel with the specified ID.


Update a Sales Channel

You can update a Sales Channel’s details and attributes by sending a request to the Update Sales Channel endpoint:

Report Incorrect Code
Report Incorrect CodeReport Incorrect Code
Copy to Clipboard
medusa.admin.salesChannels.update(salesChannelId, {
is_disabled: false
})
.then(({ sales_channel }) => {
console.log(sales_channel.id);
});
Copy to Clipboard

In this example, you enable a sales channel by changing the value of the

Copy to Clipboard
attribute.

This request returns the updated sales channel.

You can check out the API Reference for a full list of body parameters that you can pass to this request.


Delete a Sales Channel

You can delete a sales channel by sending a request to the Delete Sales Channel endpoint with the ID of the sales channel to delete:

Report Incorrect Code
Report Incorrect CodeReport Incorrect Code
Copy to Clipboard
medusa.admin.salesChannels.delete(salesChannelId)
.then(({ id, object, deleted }) => {
console.log(id);
});
Copy to Clipboard

The ID of the deleted sales channel is returned in the response.


Manage Products

Add Product to a Sales Channel

To add a product to a sales channel, send a request to the Sales Channel’s Add Products endpoint:

Report Incorrect Code
Report Incorrect CodeReport Incorrect Code
Copy to Clipboard
medusa.admin.salesChannels.addProducts(salesChannelId, {
product_ids: [
{
id: productId
}
]
})
.then(({ sales_channel }) => {
console.log(sales_channel.id);
});
Copy to Clipboard

This request accepts the

Copy to Clipboard
body parameter, which is an array of objects. Each object in the array must have an
Copy to Clipboard
property with the ID of the product to add as a value.

This request returns the sales channel.

List Products Available in a Sales Channel

You can list the products available in a sales channel by sending a request to the List Products endpoint and passing the

Copy to Clipboard
query parameter to filter by a specific sales channel:

Report Incorrect Code
Report Incorrect CodeReport Incorrect Code
Copy to Clipboard
medusa.admin.products.list({
sales_channel_id: [
salesChannelId
]
})
.then(({ products, limit, offset, count }) => {
console.log(products.length);
});
Copy to Clipboard

The request returns an array of products that are available in the specified sales channel.

Delete Products from a Sales Channel

Deleting a product from a sales channel doesn't delete it completely. It only makes it unavailable in that sales channel.

You can delete a product from a sales channel by sending a request to the Sales Channel’s Delete Products endpoint:

Report Incorrect Code
Report Incorrect CodeReport Incorrect Code
Copy to Clipboard
medusa.admin.salesChannels.removeProducts(salesChannelId, {
product_ids: [
{
id: productId
}
]
})
.then(({ sales_channel }) => {
console.log(sales_channel.id);
});
Copy to Clipboard

This request accepts the

Copy to Clipboard
body parameter, which is an array of objects. Each object in the array must have an
Copy to Clipboard
property with the ID of the product to delete as a value.

This request returns the sales channel.


List Orders by Sales Channels

You can filter orders by a specific sales channel by sending a request to the List Orders endpoint and passing the

Copy to Clipboard
query parameter to filter by a specific sales channel:

Report Incorrect Code
Report Incorrect CodeReport Incorrect Code
Copy to Clipboard
medusa.admin.orders.list({
sales_channel_id: [
salesChannelId
],
limit: 50,
offset: 0
})
.then(({ orders, limit, offset, count }) => {
console.log(orders.length);
});
Copy to Clipboard

The request returns an array of orders that are associated with the specified sales channel.


What’s Next