import { TypeList } from "docs-ui" # medusa-react ## Namespaces - [Providers](../../medusa_react/medusa_react.Providers/page.mdx) - [Utilities](../../medusa_react/medusa_react.Utilities/page.mdx) - [Hooks](../../medusa_react/medusa_react.Hooks/page.mdx) ## Interfaces - [CartContext](../../medusa_react/interfaces/medusa_react.CartContext/page.mdx) - [CartProps](../../medusa_react/interfaces/medusa_react.CartProps/page.mdx) - [MedusaContextState](../../medusa_react/interfaces/medusa_react.MedusaContextState/page.mdx) - [MedusaProviderProps](../../medusa_react/interfaces/medusa_react.MedusaProviderProps/page.mdx) - [Item](../../medusa_react/interfaces/medusa_react.Item/page.mdx) - [SessionCartState](../../medusa_react/interfaces/medusa_react.SessionCartState/page.mdx) - [SessionCartContextState](../../medusa_react/interfaces/medusa_react.SessionCartContextState/page.mdx) - [SessionCartProviderProps](../../medusa_react/interfaces/medusa_react.SessionCartProviderProps/page.mdx) - [FormatVariantPriceParams](../../medusa_react/interfaces/medusa_react.FormatVariantPriceParams/page.mdx) - [ComputeVariantPriceParams](../../medusa_react/interfaces/medusa_react.ComputeVariantPriceParams/page.mdx) ## Type Aliases - [ComputeAmountParams](../../medusa_react/types/medusa_react.ComputeAmountParams/page.mdx) - [FormatAmountParams](../../medusa_react/types/medusa_react.FormatAmountParams/page.mdx) - [AdminUpdateClaimReq](../../medusa_react/types/medusa_react.AdminUpdateClaimReq/page.mdx) - [AdminFulfillClaimReq](../../medusa_react/types/medusa_react.AdminFulfillClaimReq/page.mdx) - [AdminCancelClaimFulfillmentReq](../../medusa_react/types/medusa_react.AdminCancelClaimFulfillmentReq/page.mdx) - [AdminDraftOrderUpdateLineItemReq](../../medusa_react/types/medusa_react.AdminDraftOrderUpdateLineItemReq/page.mdx) - [AdminUpdateLocationLevelReq](../../medusa_react/types/medusa_react.AdminUpdateLocationLevelReq/page.mdx) - [AdminUpdateVariantReq](../../medusa_react/types/medusa_react.AdminUpdateVariantReq/page.mdx) - [AdminUpdateProductOptionReq](../../medusa_react/types/medusa_react.AdminUpdateProductOptionReq/page.mdx) - [AdminFulfillSwapReq](../../medusa_react/types/medusa_react.AdminFulfillSwapReq/page.mdx) - [AdminCreateSwapShipmentReq](../../medusa_react/types/medusa_react.AdminCreateSwapShipmentReq/page.mdx) - [AdminCancelSwapFulfillmentReq](../../medusa_react/types/medusa_react.AdminCancelSwapFulfillmentReq/page.mdx) - [CreateCartReq](../../medusa_react/types/medusa_react.CreateCartReq/page.mdx) - [UpdatePaymentSessionReq](../../medusa_react/types/medusa_react.UpdatePaymentSessionReq/page.mdx) - [RefreshPaymentSessionMutationData](../../medusa_react/types/medusa_react.RefreshPaymentSessionMutationData/page.mdx) - [DeletePaymentSessionMutationData](../../medusa_react/types/medusa_react.DeletePaymentSessionMutationData/page.mdx) - [UpdateMeReq](../../medusa_react/types/medusa_react.UpdateMeReq/page.mdx) - [UpdateLineItemReq](../../medusa_react/types/medusa_react.UpdateLineItemReq/page.mdx) - [UseQueryOptionsWrapper](../../medusa_react/types/medusa_react.UseQueryOptionsWrapper/page.mdx) - [RegionInfo](../../medusa_react/types/medusa_react.RegionInfo/page.mdx) - [ProductVariant](../../medusa_react/types/medusa_react.ProductVariant/page.mdx) - [ProductVariantInfo](../../medusa_react/types/medusa_react.ProductVariantInfo/page.mdx) - [Cart](../../medusa_react/types/medusa_react.Cart/page.mdx) - [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx) ___ ## Variables ### adminAuthKeys `Const` **adminAuthKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"admin_auth", any, string> ### adminBatchJobsKeys `Const` **adminBatchJobsKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"admin_batches", any, string> ### adminCollectionKeys `Const` **adminCollectionKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"admin_collections", any, string> ### adminCurrenciesKeys `Const` **adminCurrenciesKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"admin_currencies", any, string> ### adminCustomerKeys `Const` **adminCustomerKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"admin_customers", any, string> ### adminDiscountKeys `Const` **adminDiscountKeys**: `Object` #### Properties readonly [`\"admin_discounts\"`, `\"detail\"`, `string`, `\"condition\"`, `any`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"all","type":"[`\"admin_discounts\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lists","type":"() => [`\"admin_discounts\"`, `\"list\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"(`query?`: `any`) => [`\"admin_discounts\"`, `\"list\"`, ``{ query: any }``]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"() => [`\"admin_discounts\"`, `\"detail\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"(`id`: `string`) => [`\"admin_discounts\"`, `\"detail\"`, `string`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="adminDiscountKeys"/> ### adminDraftOrderKeys `Const` **adminDraftOrderKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"admin_draft_orders", any, string> ### adminGiftCardKeys `Const` **adminGiftCardKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"admin_gift_cards", any, string> ### adminInventoryItemsKeys `Const` **adminInventoryItemsKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"admin_inventory_items", any, string> ### adminInviteKeys `Const` **adminInviteKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"admin_invites", any, string> ### adminNoteKeys `Const` **adminNoteKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"admin_notes", any, string> ### adminNotificationKeys `Const` **adminNotificationKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"admin_notifications", any, string> ### adminOrderEditsKeys `Const` **adminOrderEditsKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"admin_order_edits", any, string> ### adminOrderKeys `Const` **adminOrderKeys**: `Object` #### Properties (`string` \\| ``{ expand?: string ; fields?: string }``)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"all","type":"[`\"admin_orders\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lists","type":"() => [`\"admin_orders\"`, `\"list\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"(`query?`: `any`) => [`\"admin_orders\"`, `\"list\"`, ``{ query: any }``]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"() => [`\"admin_orders\"`, `\"detail\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"(`id`: `string`) => [`\"admin_orders\"`, `\"detail\"`, `string`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="adminOrderKeys"/> ### adminPaymentCollectionQueryKeys `Const` **adminPaymentCollectionQueryKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"paymentCollection", any, string> ### adminPaymentQueryKeys `Const` **adminPaymentQueryKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"payment", any, string> ### adminPriceListKeys `Const` **adminPriceListKeys**: `Object` #### Properties readonly [`\"admin_price_lists\"`, `\"detail\"`, `string`, `\"products\"`, `any`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"all","type":"[`\"admin_price_lists\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lists","type":"() => [`\"admin_price_lists\"`, `\"list\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"(`query?`: `any`) => [`\"admin_price_lists\"`, `\"list\"`, ``{ query: any }``]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"() => [`\"admin_price_lists\"`, `\"detail\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"(`id`: `string`) => [`\"admin_price_lists\"`, `\"detail\"`, `string`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="adminPriceListKeys"/> ### adminProductCategoryKeys `Const` **adminProductCategoryKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"product_categories", any, string> ### adminProductTagKeys `Const` **adminProductTagKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"admin_product_tags", any, string> ### adminProductTypeKeys `Const` **adminProductTypeKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"admin_product_types", any, string> ### adminProductKeys `Const` **adminProductKeys**: `Object` #### Properties readonly [`\"admin_products\"`, `\"detail\"`, `string`, `\"variants\"`, `any`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"all","type":"[`\"admin_products\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lists","type":"() => [`\"admin_products\"`, `\"list\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"(`query?`: `any`) => [`\"admin_products\"`, `\"list\"`, ``{ query: any }``]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"() => [`\"admin_products\"`, `\"detail\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"(`id`: `string`) => [`\"admin_products\"`, `\"detail\"`, `string`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="adminProductKeys"/> ### adminPublishableApiKeysKeys `Const` **adminPublishableApiKeysKeys**: `Object` #### Properties readonly [`\"admin_publishable_api_keys\"`, `\"detail\"`, `string`, `\"sales_channels\"`, `any`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"all","type":"[`\"admin_publishable_api_keys\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lists","type":"() => [`\"admin_publishable_api_keys\"`, `\"list\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"(`query?`: `any`) => [`\"admin_publishable_api_keys\"`, `\"list\"`, ``{ query: any }``]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"() => [`\"admin_publishable_api_keys\"`, `\"detail\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"(`id`: `string`) => [`\"admin_publishable_api_keys\"`, `\"detail\"`, `string`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="adminPublishableApiKeysKeys"/> ### adminRegionKeys `Const` **adminRegionKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"admin_regions", any, string> ### adminReservationsKeys `Const` **adminReservationsKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"admin_reservations", any, string> ### adminReturnReasonKeys `Const` **adminReturnReasonKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"admin_return_reasons", any, string> ### adminReturnKeys `Const` **adminReturnKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"admin_returns", any, string> ### adminSalesChannelsKeys `Const` **adminSalesChannelsKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"admin_sales_channels", any, string> ### adminShippingOptionKeys `Const` **adminShippingOptionKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"admin_shipping_options", any, string> ### adminShippingProfileKeys `Const` **adminShippingProfileKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"admin_shippingProfiles", any, string> ### adminStockLocationsKeys `Const` **adminStockLocationsKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"admin_stock_locations", any, string> ### adminStoreKeys `Const` **adminStoreKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"admin_store", any, string> ### adminSwapKeys `Const` **adminSwapKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"admin_swaps", any, string> ### adminTaxRateKeys `Const` **adminTaxRateKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"admin_tax_rates", any, string> ### adminUserKeys `Const` **adminUserKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"admin_users", any, string> ### adminVariantKeys `Const` **adminVariantKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"admin_variants", any, string> ### cartKeys `Const` **cartKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"carts", any, string> ### collectionKeys `Const` **collectionKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"collections", any, string> ### customerKeys `Const` **customerKeys**: `Object` #### Properties readonly [`\"customers\"`, `\"detail\"`, `string`, `\"orders\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"all","type":"[`\"customers\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lists","type":"() => [`\"customers\"`, `\"list\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"(`query?`: `any`) => [`\"customers\"`, `\"list\"`, ``{ query: any }``]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"() => [`\"customers\"`, `\"detail\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"(`id`: `string`) => [`\"customers\"`, `\"detail\"`, `string`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="customerKeys"/> ### giftCardKeys `Const` **giftCardKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"gift_cards", any, string> ### orderEditQueryKeys `Const` **orderEditQueryKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"orderEdit", any, string> ### orderKeys `Const` **orderKeys**: `Object` #### Properties readonly [`\"orders\"`, `\"detail\"`, `\"cart\"`, `string`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"all","type":"[`\"orders\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lists","type":"() => [`\"orders\"`, `\"list\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"list","type":"(`query?`: `StoreGetOrdersParams`) => [`\"orders\"`, `\"list\"`, ``{ query: undefined \\| StoreGetOrdersParams }``]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"details","type":"() => [`\"orders\"`, `\"detail\"`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"detail","type":"(`id`: `string`) => [`\"orders\"`, `\"detail\"`, `string`]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} sectionTitle="orderKeys"/> ### paymentCollectionQueryKeys `Const` **paymentCollectionQueryKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"paymentCollection", any, string> ### storeProductCategoryKeys `Const` **storeProductCategoryKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"product_categories", any, string> ### productTagKeys `Const` **productTagKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"product_tags", any, string> ### productTypeKeys `Const` **productTypeKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"product_types", any, string> ### productKeys `Const` **productKeys**: [TQueryKey](../../medusa_react/types/medusa_react.TQueryKey/page.mdx)<"products", StoreGetProductsParams, string> ___ ## Functions ### useAdminConfirmBatchJob When a batch job is created, it's not executed automatically if `dry_run` is set to `true`. This hook confirms that the batch job should be executed. #### Example ```ts import React from "react" import { useAdminConfirmBatchJob } from "medusa-react" type Props = { batchJobId: string } const BatchJob = ({ batchJobId }: Props) => { const confirmBatchJob = useAdminConfirmBatchJob(batchJobId) // ... const handleConfirm = () => { confirmBatchJob.mutate(undefined, { onSuccess: ({ batch_job }) => { console.log(batch_job) } }) } // ... } export default BatchJob ``` #### Hook Parameters #### Mutation Function Returned Data ### useAdminCreateInvite #### Mutation Function Parameters ### useAdminProductVariants #### Hook Parameters #### Query Returned Data ### queryKeysFactory #### Type Parameters #### Parameters #### Returns ### useLocalStorage #### Parameters #### Returns void, () => void]","type":"readonly [`string`, (`data`: `string`) => `void`, () => `void`]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} sectionTitle="useLocalStorage"/>