Menu

updateSalesChannelsStep - Medusa Core Workflows Reference

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

This step updates sales channels matching the specified filters.

Example#

Code
1const data = updateSalesChannelsStep({2  selector: {3    id: "sc_123"4  },5  update: {6    name: "Webshop"7  }8})

Input#

UpdateSalesChannelsStepInputUpdateSalesChannelsStepInput
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#

SalesChannelDTO[]SalesChannelDTO[]
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
⇧↵