Skip to main content
Skip to main content

Store

A store holds the main settings of the commerce shop. By default, only one store is created and used within the Medusa backend. It holds settings related to the name of the store, available currencies, and more.

Properties

idstringRequired
The store's ID
created_atDateRequired
The date with timezone at which the resource was created.
updated_atDateRequired
The date with timezone at which the resource was updated.
namestringRequired
The name of the Store - this may be displayed to the Customer.

Default: Medusa Store

default_currency_codestringRequired
The three character currency code that is the default of the store.
default_currencyCurrencyRequired
The details of the store's default currency.

Default: usd

currenciesCurrency[]Required
The details of the enabled currencies in the store.
swap_link_templatenull | stringRequired
A template to generate Swap links from. Use {{cart_id}} to include the Swap's cart\_id in the link.
payment_link_templatenull | stringRequired
A template to generate Payment links from. Use {{cart_id}} to include the payment's cart\_id in the link.
invite_link_templatenull | stringRequired
A template to generate Invite links from
default_location_idstringRequired
The location ID the store is associated with.
metadatanull | Record<string, unknown>Required
An optional key-value map with additional details
default_sales_channel_idnull | stringRequired
The ID of the store's default sales channel.
default_sales_channelSalesChannelRequired
The details of the store's default sales channel.
Was this section helpful?