Skip to main content
POST
/
admin
/
stores
/
{id}
JS SDK
import Medusa from "@medusajs/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.store.update("store_123", {
  name: "My Store",
})
.then(({ store }) => {
  console.log(store)
})
{
  "store": {
    "id": "<string>",
    "name": "<string>",
    "supported_currencies": [
      {
        "id": "<string>",
        "currency_code": "usd",
        "store_id": "<string>",
        "is_default": true,
        "currency": {
          "code": "usd",
          "symbol": "$",
          "symbol_native": "$",
          "name": "<string>",
          "decimal_digits": 123,
          "rounding": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": "2023-11-07T05:31:56Z"
        },
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z"
      }
    ],
    "default_sales_channel_id": "<string>",
    "default_region_id": "<string>",
    "default_location_id": "<string>",
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The store's ID.

Query Parameters

​
fields
string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

Body

application/json

The properties to update in a store.

​
name
string

The store's name.

​
supported_currencies
object[]

The store's supported currencies.

​
default_sales_channel_id
string

The ID of the default sales channel in the store.

​
default_region_id
string

The ID of the default region in the store.

​
default_location_id
string

The ID of the default stock location in the store.

​
metadata
object

The store's metadata, can hold custom key-value pairs.

Response

OK

The store's details.

​
store
object
required

The store's details.