Store Hooks - Admin Components

The store hooks retrieve the active store from the Medusa backend, including its supported currencies and default sales channel.

import {
  storeQueryKeys,
  useStore,
} from "@medusajs/dashboard/hooks"

These hooks are built on TanStack Query. Use them in your widgets and UI routes.

useStore#

Retrieve the active store. The hook lists the stores and returns the first one, so it doesn't accept an ID.

const { store, isPending } = useStore({
  fields: "+supported_currencies.*",
})

Parameters#

Returns#

Along with the following, the hook returns the rest of TanStack Query's useQuery result.

storeQueryKeys#

storeQueryKeys is the query key factory for store queries. useStore registers its data under storeQueryKeys.details().

Use it to invalidate the cached store after a custom mutation:

import { useQueryClient } from "@tanstack/react-query"
import { storeQueryKeys } from "@medusajs/dashboard/hooks"

const queryClient = useQueryClient()

queryClient.invalidateQueries({
  queryKey: storeQueryKeys.details(),
})