Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

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.

Source Code

Examples#

Steps#

updateSalesChannelsStep

emitEventStep

Workflow Hook

Step conditioned by when

Input#

UpdateSalesChannelsWorkflowInputUpdateSalesChannelsWorkflowInput
The data to update sales channels.
selectorFilterableSalesChannelProps
The filters to select the sales channels to update.
updateUpdateSalesChannelDTO
The data to update the sales channels.

Output#

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.
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
⇧↵