createSalesChannelsWorkflow - Medusa Core Workflows Reference

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

This workflow creates one or more sales channels. It's used by the Create Sales Channel Admin API Route.

You can use this workflow within your customizations or your own custom workflows, allowing you to create sales channels within your custom flows.

Examples#

createSalesChannelsStep

emitEventStep

Workflow hook

Step conditioned by when

View step details

CreateSalesChannelsWorkflowInputCreateSalesChannelsWorkflowInput

The data to create sales channels.

The sales channels to create.

CreateSalesChannelsWorkflowOutputCreateSalesChannelsWorkflowOutput

The created sales channels.

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.

The locations of the sales channel.

This section lists the events that are either triggered by the emitEventStep in the workflow, or by another workflow executed within this workflow.

You can listen to these events in a subscriber, as explained in the Subscribers documentation.

Event	Description	Payload	Action
`sales-channel.created`	Emitted when sales channels are created.	`[{ id, // The ID of the sales channel }]`

Was this page helpful?