updateSalesChannelsWorkflow - Medusa Core Workflows Reference

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

This workflow updates sales channels matching the specified conditions. It's used by the Update Sales Channel Admin API Route.

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

Examples#

updateSalesChannelsStep

emitEventStep

Workflow hook

Step conditioned by when

View step details

UpdateSalesChannelsWorkflowInputUpdateSalesChannelsWorkflowInput

The data to update sales channels.

The filters to select the sales channels to update.

The data to update the sales channels.

UpdateSalesChannelsWorkflowOutputUpdateSalesChannelsWorkflowOutput

The updated 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.updated`	Emitted when sales channels are updated.	`[{ id, // The ID of the sales channel }]`

Was this page helpful?