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

createDefaultSalesChannelStep - Medusa Core Workflows Reference

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

This step creates a default sales channel if none exist in the application. This is useful when creating seed scripts.

Example#

Code
1const data = createDefaultSalesChannelStep({2  data: {3    name: "Webshop",4  }5})

Input#

CreateDefaultSalesChannelStepInputCreateDefaultSalesChannelStepInput
The data to create a default sales channel.
dataCreateSalesChannelDTO
The default sales channel data.

Output#

SalesChannelDTOSalesChannelDTO
The sales channel details.
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
⇧↵