Update Store Details

Update the Store's details.

{ "store": { "id": "store_01G1G5V21KADXNGH29BJMAJ4B4", "name": "Medusa Store", "swap_link_template": null, "payment_link_template": null, "invite_link_template": null, "default_location_id": null, "default_sales_channel_id": null, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "default_currency_code": "usd", "metadata": { "car": "white" }, "default_currency": { "symbol": "$", "symbol_native": "$", "name": "US Dollar", "includes_tax": false, "code": "usd" }, "currencies": [ { "symbol": "$", "symbol_native": "$", "name": "US Dollar", "includes_tax": false, "code": "usd" } ], "default_sales_channel": { "id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A", "name": "Market", "description": "Multi-vendor market", "is_disabled": false, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "metadata": { "car": "white" }, "locations": [ { "id": "scloc_01G8X9A7ESKAJXG2H0E6F1MW7A", "sales_channel_id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A", "location_id": "string", "sales_channel": {}, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z" } ] } } }

Request

Body Params application/json

name

string

optional

The name of the Store

swap_link_template

string

optional

A template for Swap links - use {{cart_id}} to insert the Swap Cart ID

Example:

http://example.com/swaps/{{cart_id}}

payment_link_template

string

optional

A template for payment links - use {{cart_id}} to insert the Cart ID

Example:

http://example.com/payments/{{cart_id}}

invite_link_template

string

optional

A template for invite links - use {{invite_token}} to insert the invite token

Example:

http://example.com/invite?token={{invite_token}}

default_currency_code

string

optional

The default currency code of the Store.

metadata

object

optional

An optional set of key-value pairs with additional information.

currencies

array[string]

optional

Array of available currencies in the store. Each currency is in 3 character ISO code format.

Examples

Responses

🟢200OK

application/json

Body

store

object (Store)

required

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.

string

required

The store's ID

Example:

store_01G1G5V21KADXNGH29BJMAJ4B4

name

string

required

The name of the Store - this may be displayed to the Customer.

Example:

Medusa Store

swap_link_template

string | null

required

A template to generate Swap links from. Use {{cart_id}} to include the Swap's cart_id in the link.

Example:

null

payment_link_template

string | null

required

A template to generate Payment links from. Use {{cart_id}} to include the payment's cart_id in the link.

Example:

null

invite_link_template

string | null

required

A template to generate Invite links from

Example:

null

default_location_id

string | null

required

The location ID the store is associated with.

Example:

null

default_sales_channel_id

string | null

optional

The ID of the store's default sales channel.

Example:

null

created_at

string <date-time>

required

The date with timezone at which the resource was created.

updated_at

string <date-time>

required

The date with timezone at which the resource was updated.

default_currency_code

string

required

The 3 character currency code that is the default of the store.

Example:

usd

metadata

object | null

required

An optional key-value map with additional details

Example:

{"car":"white"}

default_currency

object (Currency)

optional

Currency

currencies

array[object (Currency) {5}]

optional

The details of the enabled currencies in the store.

default_sales_channel

object (Sales Channel)

optional

A Sales Channel is a method a business offers its products for purchase for the customers. For example, a Webshop can be a sales channel, and a mobile app can be another.

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error