- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Menu
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
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.
Input#
FindSalesChannelStepInput
FindSalesChannelStepInputThe details of the sales channel to find.
FindSalesChannelStepInput
FindSalesChannelStepInputsalesChannelId
null | stringOptionalThe ID of the sales channel to find.
salesChannelId
null | stringOptionalOutput#
SalesChannelDTO
SalesChannelDTOThe sales channel details.
SalesChannelDTO
SalesChannelDTOid
stringThe ID of the sales channel.
id
stringname
stringThe name of the sales channel.
name
stringdescription
null | stringThe description of the sales channel.
description
null | stringis_disabled
booleanWhether the sales channel is disabled.
is_disabled
booleanmetadata
null | Record<string, unknown>Holds custom data in key-value pairs.
metadata
null | Record<string, unknown>The locations of the sales channel.
Was this page helpful?