findSalesChannelStep - Medusa Core Workflows Reference

This documentation provides a reference to the findSalesChannelStep. It belongs to the @medusajs/medusa/core-flows package.

This step either retrieves a sales channel either using the ID provided as an input, or, if no ID is provided, the default sales channel of the first store.

src/workflows/my-workflow.ts
1import { createWorkflow } from "@medusajs/framework/workflows-sdk"2import { findSalesChannelStep } from "@medusajs/medusa/core-flows"3
4const myWorkflow = createWorkflow(5  "my-workflow",6  () => {7    const data = findSalesChannelStep({})8  }9)

Input#

FindSalesChannelStepInputFindSalesChannelStepInput
The details of the sales channel to find.
salesChannelIdnull | stringOptional
The ID of the sales channel to find.

Output#

SalesChannelDTOSalesChannelDTO
The sales channel details.
idstring
The ID of the sales channel.
namestring
The name of the sales channel.
descriptionnull | string
The description of the sales channel.
is_disabledboolean
Whether the sales channel is disabled.
metadatanull | Record<string, unknown>
Holds custom data in key-value pairs.
locationsSalesChannelLocationDTO[]Optional
The locations of the sales channel.
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break