Price Preference Hooks - Admin Components

The price preference hooks retrieve price preferences from the Medusa backend. A price preference controls how prices are displayed and entered for a region or a currency, such as whether prices are tax inclusive.

Code
1import {2  pricePreferencesQueryKeys,3  usePricePreferences,4} from "@medusajs/dashboard/hooks"

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

usePricePreferences#

Retrieve a paginated list of price preferences. Pass query parameters to filter the price preferences, for example by attribute or value.

Code
1const { price_preferences, count } = usePricePreferences({2  limit: 20,3})

Parameters#

Returns#

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

pricePreferencesQueryKeys#

pricePreferencesQueryKeys is the query key factory for price preference queries. Use all, lists(), list(query), details(), and detail(id) to build the keys that the hook above registers.

Use it to invalidate cached price preference data after a custom mutation:

Code
1import { useQueryClient } from "@tanstack/react-query"2import {3  pricePreferencesQueryKeys,4} from "@medusajs/dashboard/hooks"5
6const queryClient = useQueryClient()7
8queryClient.invalidateQueries({9  queryKey: pricePreferencesQueryKeys.lists(),10})