createStoresWorkflow - Medusa Core Workflows Reference

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

This workflow creates one or more stores. By default, Medusa uses a single store. This is useful if you're building a multi-tenant application or a marketplace where each tenant has its own store.

You can use this workflow within your customizations or your own custom workflows, allowing you to create stores within your custom flows.

Source Code

Examples#

Steps#

Workflow Hook

Step conditioned by when

Input#

CreateStoresWorkflowInputCreateStoresWorkflowInput
The data to create stores.
The stores to create.

Output#

CreateStoresWorkflowOutputCreateStoresWorkflowOutput
The created stores.
idstring
The ID of the store.
namestring
The name of the store.
metadatanull | Record<string, any>
Holds custom data in key-value pairs.
created_atstring
The created at of the store.
updated_atstring
The updated at of the store.
supported_currenciesStoreCurrencyDTO[]Optional
The supported currency codes of the store.
default_sales_channel_idstringOptional
The associated default sales channel's ID.
default_region_idstringOptional
The associated default region's ID.
default_location_idstringOptional
The associated default location's ID.
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