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})

UpdateSalesChannelsStepInputUpdateSalesChannelsStepInput

The data to update sales channels.

The filters to select the sales channels to update.

The data to update the sales channels.

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.

The locations of the sales channel.