From 8b1ee3705e62ad74666166ac3ed9329d861d275d Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Mon, 10 Mar 2025 10:32:45 +0200 Subject: [PATCH] split sidebars + optimize generated files loading --- www/apps/book/components/EditButton/index.tsx | 32 +- .../app/references/[...slug]/page.tsx | 3 +- .../resources/components/EditButton/index.tsx | 37 +- www/apps/resources/config/index.ts | 5 +- .../generated-how-to-tutorials-sidebar.mjs | 320 + .../generated/generated-recipes-sidebar.mjs | 168 + .../generated/generated-resources-sidebar.mjs | 25377 +++++++++++++++ www/apps/resources/generated/sidebar.mjs | 25861 ---------------- www/apps/resources/next.config.mjs | 2 +- www/apps/resources/providers/sidebar.tsx | 33 +- www/apps/resources/scripts/prepare.mjs | 10 +- .../resources/utils/get-sidebar-for-path.ts | 53 + .../components/EditButton/index.tsx | 24 +- .../build-scripts/src/generate-sidebar.ts | 35 +- .../src/generate-split-sidebars.ts | 51 + www/packages/build-scripts/src/index.ts | 1 + .../docs-ui/src/providers/Sidebar/index.tsx | 6 + 17 files changed, 26105 insertions(+), 25913 deletions(-) create mode 100644 www/apps/resources/generated/generated-how-to-tutorials-sidebar.mjs create mode 100644 www/apps/resources/generated/generated-recipes-sidebar.mjs create mode 100644 www/apps/resources/generated/generated-resources-sidebar.mjs delete mode 100644 www/apps/resources/generated/sidebar.mjs create mode 100644 www/apps/resources/utils/get-sidebar-for-path.ts create mode 100644 www/packages/build-scripts/src/generate-split-sidebars.ts diff --git a/www/apps/book/components/EditButton/index.tsx b/www/apps/book/components/EditButton/index.tsx index 17bea0f437..159b0a1e63 100644 --- a/www/apps/book/components/EditButton/index.tsx +++ b/www/apps/book/components/EditButton/index.tsx @@ -2,19 +2,37 @@ import { EditButton as UiEditButton } from "docs-ui" import { usePathname } from "next/navigation" -import { useMemo } from "react" -import { generatedEditDates } from "../../generated/edit-dates.mjs" +import { useCallback, useEffect, useState } from "react" const EditButton = () => { const pathname = usePathname() + const [editDate, setEditDate] = useState() - const editDate = useMemo( - () => + // const editDate = useMemo( + // () => + // (generatedEditDates as Record)[ + // `app${pathname.replace(/\/$/, "")}/page.mdx` + // ], + // [pathname] + // ) + + const loadEditDate = useCallback(async () => { + const generatedEditDates = (await import("../../generated/edit-dates.mjs")) + .generatedEditDates + setEditDate( (generatedEditDates as Record)[ `app${pathname.replace(/\/$/, "")}/page.mdx` - ], - [pathname] - ) + ] + ) + }, [pathname]) + + useEffect(() => { + void loadEditDate() + }, [loadEditDate]) + + if (!editDate) { + return <> + } return ( f.newSlug === pathname) || filesMap.find((f) => f.pathname === pathname) diff --git a/www/apps/resources/components/EditButton/index.tsx b/www/apps/resources/components/EditButton/index.tsx index b6a3286f8f..c3f2ecb0d6 100644 --- a/www/apps/resources/components/EditButton/index.tsx +++ b/www/apps/resources/components/EditButton/index.tsx @@ -1,31 +1,38 @@ "use client" import { usePathname } from "next/navigation" -import { useMemo } from "react" +import { useCallback, useEffect, useState } from "react" import { EditButton as UiEditButton } from "docs-ui" -import { filesMap } from "../../generated/files-map.mjs" -import { generatedEditDates } from "../../generated/edit-dates.mjs" const EditButton = () => { const pathname = usePathname() - const filePath = useMemo( - () => filesMap.find((file) => file.pathname === pathname), - [pathname] - ) + const [editDate, setEditDate] = useState() + const [filePath, setFilePath] = useState() - const editDate = useMemo( - () => - (generatedEditDates as Record)[ + const loadData = useCallback(async () => { + const filesMap = await import("../../generated/files-map.mjs") + const generatedEditDates = await import("../../generated/edit-dates.mjs") + + setFilePath( + filesMap.filesMap.find((file) => file.pathname === pathname)?.filePath || + undefined + ) + setEditDate( + (generatedEditDates.generatedEditDates as Record)[ `app${pathname.replace(/\/$/, "")}/page.mdx` - ], - [pathname] - ) + ] + ) + }, [pathname]) - if (!filePath) { + useEffect(() => { + void loadData() + }, [loadData]) + + if (!editDate || !filePath) { return <> } - return + return } export default EditButton diff --git a/www/apps/resources/config/index.ts b/www/apps/resources/config/index.ts index 034d4eb79b..03c9220d72 100644 --- a/www/apps/resources/config/index.ts +++ b/www/apps/resources/config/index.ts @@ -1,5 +1,4 @@ -import { DocsConfig, Sidebar } from "types" -import { generatedSidebars } from "../generated/sidebar.mjs" +import { DocsConfig } from "types" import { globalConfig } from "docs-ui" const baseUrl = process.env.NEXT_PUBLIC_BASE_URL || "http://localhost:3000" @@ -9,7 +8,7 @@ export const config: DocsConfig = { titleSuffix: "Medusa Development Resources", baseUrl, basePath: process.env.NEXT_PUBLIC_BASE_PATH, - sidebars: generatedSidebars as Sidebar.Sidebar[], + sidebars: [], project: { title: "Development Resources", key: "resources", diff --git a/www/apps/resources/generated/generated-how-to-tutorials-sidebar.mjs b/www/apps/resources/generated/generated-how-to-tutorials-sidebar.mjs new file mode 100644 index 0000000000..4cfda07881 --- /dev/null +++ b/www/apps/resources/generated/generated-how-to-tutorials-sidebar.mjs @@ -0,0 +1,320 @@ +const generatedgeneratedHowToTutorialsSidebarSidebar = { + "sidebar_id": "how-to-tutorials", + "title": "How-To & Tutorials", + "items": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/how-to-tutorials", + "title": "Overview", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/examples", + "title": "Example Snippets", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "How-To Guides", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Server", + "autogenerate_tags": "howTo+server", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Actor Type", + "path": "https://docs.medusajs.com/resources/commerce-modules/auth/create-actor-type", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Auth Provider", + "path": "https://docs.medusajs.com/resources/references/auth/provider", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Cache Module", + "path": "https://docs.medusajs.com/resources/architectural-modules/cache/create", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Event Module", + "path": "https://docs.medusajs.com/resources/architectural-modules/event/create", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Fulfillment Provider", + "path": "https://docs.medusajs.com/resources/references/fulfillment/provider", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Notification Provider", + "path": "https://docs.medusajs.com/resources/references/notification-provider-module", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Payment Provider", + "path": "https://docs.medusajs.com/resources/references/payment/provider", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Tax Provider", + "path": "https://docs.medusajs.com/resources/references/tax/provider", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Get Variant Price with Taxes", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price-with-taxes", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Get Variant Prices", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Handle Password Reset Event", + "path": "https://docs.medusajs.com/resources/commerce-modules/auth/reset-password", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Send Notification", + "path": "https://docs.medusajs.com/resources/architectural-modules/notification/send-notification", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "howTo+admin", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/admin-components", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Components", + "autogenerate_path": "/admin-components/components", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Layouts", + "autogenerate_path": "/admin-components/layouts", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Tutorials", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Custom Item Pricing", + "path": "/examples/guides/custom-item-price", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Wishlist", + "path": "/plugins/guides/wishlist", + "description": "Learn how to build a wishlist plugin.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Extend Modules", + "autogenerate_tags": "tutorial+extendModule", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Extend Cart", + "path": "https://docs.medusajs.com/resources/commerce-modules/cart/extend", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Extend Customer", + "path": "https://docs.medusajs.com/resources/commerce-modules/customer/extend", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Extend Product", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/extend", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Extend Promotion", + "path": "https://docs.medusajs.com/resources/commerce-modules/promotion/extend", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Deployment", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/deployment", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Medusa Cloud", + "path": "https://medusajs.com/pricing", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Self-Hosting", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "https://docs.medusajs.com/learn/deployment/general", + "title": "General", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/deployment/medusa-application/railway", + "title": "Railway", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Next.js Starter", + "autogenerate_path": "/deployment/storefront", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/deployment/storefront/vercel", + "title": "Vercel", + "description": "", + "children": [] + } + ] + } + ] + } + ] +} + +export default generatedgeneratedHowToTutorialsSidebarSidebar \ No newline at end of file diff --git a/www/apps/resources/generated/generated-recipes-sidebar.mjs b/www/apps/resources/generated/generated-recipes-sidebar.mjs new file mode 100644 index 0000000000..f672643512 --- /dev/null +++ b/www/apps/resources/generated/generated-recipes-sidebar.mjs @@ -0,0 +1,168 @@ +const generatedgeneratedRecipesSidebarSidebar = { + "sidebar_id": "recipes", + "title": "Recipes", + "items": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/marketplace", + "title": "Marketplace", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/marketplace/examples/vendors", + "title": "Example: Vendors", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/marketplace/examples/restaurant-delivery", + "title": "Example: Restaurant-Delivery", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/subscriptions", + "title": "Subscriptions", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/subscriptions/examples/standard", + "title": "Example", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/digital-products", + "title": "Digital Products", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/digital-products/examples/standard", + "title": "Example", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/erp", + "title": "Integrate ERP", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/erp/odoo", + "title": "Example: Odoo Integration", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/b2b", + "title": "B2B", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/commerce-automation", + "title": "Commerce Automation", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/commerce-automation/restock-notification", + "title": "Example: Restock Notifications", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/ecommerce", + "title": "Ecommerce", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/multi-region-store", + "title": "Multi-Region Store", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/omnichannel", + "title": "Omnichannel Store", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/oms", + "title": "OMS", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/personalized-products", + "title": "Personalized Products", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/recipes/pos", + "title": "POS", + "children": [] + } + ] +} + +export default generatedgeneratedRecipesSidebarSidebar \ No newline at end of file diff --git a/www/apps/resources/generated/generated-resources-sidebar.mjs b/www/apps/resources/generated/generated-resources-sidebar.mjs new file mode 100644 index 0000000000..2d571eff8b --- /dev/null +++ b/www/apps/resources/generated/generated-resources-sidebar.mjs @@ -0,0 +1,25377 @@ +const generatedgeneratedResourcesSidebarSidebar = { + "sidebar_id": "resources", + "title": "Development Resources", + "items": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/", + "title": "Overview", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "examples", + "title": "Examples", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "path": "/recipes", + "title": "Recipes", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "path": "/plugins", + "title": "Plugins", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "path": "/integrations", + "title": "Integrations", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Examples", + "autogenerate_tags": "example+storefront", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Implement Express Checkout with Medusa", + "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", + "children": [] + } + ] + } + ] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules", + "title": "Commerce Modules", + "hideChildren": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "api-key", + "title": "API Key Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/api-key", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/api-key/concepts", + "title": "API Key Concepts", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/api-key/links-to-other-modules", + "title": "Link to Modules", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Server Guides", + "autogenerate_tags": "server+auth", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to use the API Key Module in your customizations on the Medusa application server.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Actor Type", + "path": "https://docs.medusajs.com/resources/commerce-modules/auth/create-actor-type", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Auth Provider", + "path": "https://docs.medusajs.com/resources/references/auth/provider", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Guides", + "autogenerate_tags": "storefront+apiKey,-jsSdk", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to integrate the API Key Module's features into your storefront.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Use a Publishable API Key in the Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/publishable-api-keys", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+apiKey", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage API Key features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Publishable API Keys", + "path": "https://docs.medusajs.com/user-guide/settings/developer/publishable-api-keys", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Secret API Keys", + "path": "https://docs.medusajs.com/user-guide/settings/developer/secret-api-keys", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "description": "Find references for tools and resources related to the API Key Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/api-key/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+apiKey", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createApiKeysWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createApiKeysWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteApiKeysWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteApiKeysWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "revokeApiKeysWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/revokeApiKeysWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateApiKeysWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateApiKeysWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+apiKey", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createApiKeysStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createApiKeysStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteApiKeysStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteApiKeysStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "revokeApiKeysStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/revokeApiKeysStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateApiKeysStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateApiKeysStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/api-key/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+apiKey", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the API Key Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "apiKey", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/apiKey", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/api-key/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "api-key-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "API Key Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/api-key", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "hasTitleStyling": true, + "autogenerate_path": "/references/api_key/IApiKeyModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/api-key/authenticate", + "title": "authenticate", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/api-key/createApiKeys", + "title": "createApiKeys", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/api-key/deleteApiKeys", + "title": "deleteApiKeys", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/api-key/listAndCountApiKeys", + "title": "listAndCountApiKeys", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/api-key/listApiKeys", + "title": "listApiKeys", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/api-key/retrieveApiKey", + "title": "retrieveApiKey", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/api-key/revoke", + "title": "revoke", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/api-key/updateApiKeys", + "title": "updateApiKeys", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/api-key/upsertApiKeys", + "title": "upsertApiKeys", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "api-key-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "API Key Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/api-key/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "hasTitleStyling": true, + "autogenerate_path": "/references/api_key_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/api-key/models/ApiKey", + "title": "ApiKey", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "auth", + "title": "Auth Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth", + "title": "Overview", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/module-options", + "title": "Module Options", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/auth-identity-and-actor-types", + "title": "Identity and Actor Types", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/auth-providers", + "title": "Auth Providers", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/auth-flows", + "title": "Auth Flow with Module", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/authentication-route", + "title": "Auth Flow with Routes", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Server Guides", + "autogenerate_tags": "server+auth", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to use the Auth Module in your customizations on the Medusa application server.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Actor Type", + "path": "https://docs.medusajs.com/resources/commerce-modules/auth/create-actor-type", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/create-actor-type", + "title": "Create an Actor Type", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Auth Provider", + "path": "https://docs.medusajs.com/resources/references/auth/provider", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/provider", + "title": "Create Auth Provider Module", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/reset-password", + "title": "Handle Password Reset Event", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Guides", + "autogenerate_tags": "storefront+auth,-jsSdk", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to integrate the Auth Module's features into your storefront.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Log-out Customer in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/log-out", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Login Customer in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/login", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Register Customer in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/register", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Reset Customer Password in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/reset-password", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Retrieve Logged-In Customer in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/retrieve", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Third-Party or Social Login in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/third-party-login", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+auth", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Auth features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Reset Password", + "path": "https://docs.medusajs.com/user-guide/reset-password", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Providers", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/auth-providers/emailpass", + "title": "Emailpass Provider", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/auth-providers/google", + "title": "Google Provider", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/auth-providers/github", + "title": "GitHub Provider", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "description": "Find references for tools and resources related to the Auth Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+auth", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "acceptInviteWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/acceptInviteWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCustomerAccountWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCustomerAccountWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createUserAccountWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createUserAccountWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeCustomerAccountWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeCustomerAccountWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeUserAccountWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeUserAccountWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+auth", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "setAuthAppMetadataStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/setAuthAppMetadataStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "autogenerate_tags": "jsSdk+auth", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "callback", + "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/callback", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "login", + "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/login", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "logout", + "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/logout", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refresh", + "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/refresh", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "register", + "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/register", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "resetPassword", + "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/resetPassword", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProvider", + "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/updateProvider", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/events", + "title": "Events Reference", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "auth-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Auth Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/auth/IAuthModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/authenticate", + "title": "authenticate", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/createAuthIdentities", + "title": "createAuthIdentities", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/createProviderIdentities", + "title": "createProviderIdentities", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/deleteAuthIdentities", + "title": "deleteAuthIdentities", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/deleteProviderIdentities", + "title": "deleteProviderIdentities", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/listAndCountAuthIdentities", + "title": "listAndCountAuthIdentities", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/listAuthIdentities", + "title": "listAuthIdentities", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/listProviderIdentities", + "title": "listProviderIdentities", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/register", + "title": "register", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/retrieveAuthIdentity", + "title": "retrieveAuthIdentity", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/retrieveProviderIdentity", + "title": "retrieveProviderIdentity", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/updateAuthIdentities", + "title": "updateAuthIdentities", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/updateProvider", + "title": "updateProvider", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/updateProviderIdentities", + "title": "updateProviderIdentities", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/validateCallback", + "title": "validateCallback", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "auth-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Auth Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "autogenerate_path": "/references/auth_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/models/AuthIdentity", + "title": "AuthIdentity", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/auth/models/ProviderIdentity", + "title": "ProviderIdentity", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "cart", + "title": "Cart Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/cart", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/cart/concepts", + "title": "Cart Concepts", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/cart/promotions", + "title": "Promotion Adjustments", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/cart/tax-lines", + "title": "Tax Lines", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/cart/links-to-other-modules", + "title": "Links to Other Modules", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Server Guides", + "autogenerate_tags": "server+cart", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to use the Cart Module in your customizations on the Medusa application server.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Extend Cart", + "path": "https://docs.medusajs.com/resources/commerce-modules/cart/extend", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/cart/extend", + "title": "Extend Module", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Implement Custom Line Item Pricing in Medusa", + "path": "https://docs.medusajs.com/resources/examples/guides/custom-item-price", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Guides", + "autogenerate_tags": "storefront+cart,-jsSdk", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to integrate the Cart Module's features into your storefront.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Checkout Step 1: Enter Email", + "path": "https://docs.medusajs.com/resources/storefront-development/checkout/email", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Checkout Step 2: Set Address", + "path": "https://docs.medusajs.com/resources/storefront-development/checkout/address", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Checkout Step 3: Choose Shipping Method", + "path": "https://docs.medusajs.com/resources/storefront-development/checkout/shipping", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Checkout Step 4: Choose Payment Provider", + "path": "https://docs.medusajs.com/resources/storefront-development/checkout/payment", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Checkout Step 5: Complete Cart", + "path": "https://docs.medusajs.com/resources/storefront-development/checkout/complete-cart", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Cart Context in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/cart/context", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Cart in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/cart/create", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Implement Express Checkout with Medusa", + "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Cart's Items in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/cart/manage-items", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Payment with Stripe in React Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/checkout/payment/stripe", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Retrieve Cart in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/cart/retrieve", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Update Cart in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/cart/update", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "description": "Find references for tools and resources related to the Cart Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/cart/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+cart", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addShippingMethodToCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addShippingMethodToCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addToCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addToCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "completeCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/completeCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteLineItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refreshCartItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refreshCartShippingMethodsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartShippingMethodsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "transferCartCustomerWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/transferCartCustomerWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartPromotionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartPromotionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateLineItemInCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateLineItemInCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateTaxLinesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateTaxLinesWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+cart", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addShippingMethodToCartStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/addShippingMethodToCartStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCartsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createLineItemAdjustmentsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createLineItemAdjustmentsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createLineItemsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createLineItemsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createShippingMethodAdjustmentsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createShippingMethodAdjustmentsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteLineItemsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteLineItemsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "getLineItemActionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/getLineItemActionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeLineItemAdjustmentsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/removeLineItemAdjustmentsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeShippingMethodAdjustmentsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/removeShippingMethodAdjustmentsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeShippingMethodFromCartStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/removeShippingMethodFromCartStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "setTaxLinesForItemsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/setTaxLinesForItemsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCartsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateLineItemsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateLineItemsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateLineItemsStepWithSelector", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateLineItemsStepWithSelector", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateShippingMethodsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateShippingMethodsStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/cart/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Store", + "autogenerate_tags": "jsSdk+storefront+cart", + "description": "The following methods or properties are used to send requests to Store API Routes related to the Cart Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cart", + "path": "https://docs.medusajs.com/resources/references/js-sdk/store/cart", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/cart/events", + "title": "Events Reference", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "cart-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Cart Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/cart/ICartModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/addLineItemAdjustments", + "title": "addLineItemAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/addLineItemTaxLines", + "title": "addLineItemTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/addLineItems", + "title": "addLineItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/addShippingMethodAdjustments", + "title": "addShippingMethodAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/addShippingMethodTaxLines", + "title": "addShippingMethodTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/addShippingMethods", + "title": "addShippingMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/createAddresses", + "title": "createAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/createCarts", + "title": "createCarts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/deleteAddresses", + "title": "deleteAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/deleteCarts", + "title": "deleteCarts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/deleteLineItemAdjustments", + "title": "deleteLineItemAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/deleteLineItemTaxLines", + "title": "deleteLineItemTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/deleteLineItems", + "title": "deleteLineItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/deleteShippingMethodAdjustments", + "title": "deleteShippingMethodAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/deleteShippingMethodTaxLines", + "title": "deleteShippingMethodTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/deleteShippingMethods", + "title": "deleteShippingMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/listAddresses", + "title": "listAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/listAndCountCarts", + "title": "listAndCountCarts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/listCarts", + "title": "listCarts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/listLineItemAdjustments", + "title": "listLineItemAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/listLineItemTaxLines", + "title": "listLineItemTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/listLineItems", + "title": "listLineItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/listShippingMethodAdjustments", + "title": "listShippingMethodAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/listShippingMethodTaxLines", + "title": "listShippingMethodTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/listShippingMethods", + "title": "listShippingMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/restoreAddresses", + "title": "restoreAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/restoreCarts", + "title": "restoreCarts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/restoreLineItemAdjustments", + "title": "restoreLineItemAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/restoreLineItemTaxLines", + "title": "restoreLineItemTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/restoreLineItems", + "title": "restoreLineItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/restoreShippingMethodAdjustments", + "title": "restoreShippingMethodAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/restoreShippingMethodTaxLines", + "title": "restoreShippingMethodTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/restoreShippingMethods", + "title": "restoreShippingMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/retrieveCart", + "title": "retrieveCart", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/retrieveLineItem", + "title": "retrieveLineItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/setLineItemAdjustments", + "title": "setLineItemAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/setLineItemTaxLines", + "title": "setLineItemTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/setShippingMethodAdjustments", + "title": "setShippingMethodAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/setShippingMethodTaxLines", + "title": "setShippingMethodTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/softDeleteAddresses", + "title": "softDeleteAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/softDeleteCarts", + "title": "softDeleteCarts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/softDeleteLineItemAdjustments", + "title": "softDeleteLineItemAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/softDeleteLineItemTaxLines", + "title": "softDeleteLineItemTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/softDeleteLineItems", + "title": "softDeleteLineItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/softDeleteShippingMethodAdjustments", + "title": "softDeleteShippingMethodAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/softDeleteShippingMethodTaxLines", + "title": "softDeleteShippingMethodTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/softDeleteShippingMethods", + "title": "softDeleteShippingMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/updateAddresses", + "title": "updateAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/updateCarts", + "title": "updateCarts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/updateLineItems", + "title": "updateLineItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/updateShippingMethods", + "title": "updateShippingMethods", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "cart-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Cart Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "autogenerate_path": "/references/cart_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/models/Address", + "title": "Address", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/models/Cart", + "title": "Cart", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/models/CreditLine", + "title": "CreditLine", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/models/LineItem", + "title": "LineItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/models/LineItemAdjustment", + "title": "LineItemAdjustment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/models/LineItemTaxLine", + "title": "LineItemTaxLine", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/models/ShippingMethod", + "title": "ShippingMethod", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/models/ShippingMethodAdjustment", + "title": "ShippingMethodAdjustment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/cart/models/ShippingMethodTaxLine", + "title": "ShippingMethodTaxLine", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "currency", + "title": "Currency Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/currency", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Concepts", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/currency/links-to-other-modules", + "title": "Link to Modules", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+currency", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Currency features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Store", + "path": "https://docs.medusajs.com/user-guide/settings/store", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "References", + "description": "Find references for tools and resources related to the Currency Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/currency/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+currency", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Currency Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "currency", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/currency", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "currency-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Currency Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/currency", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/currency/ICurrencyModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/currency/listAndCountCurrencies", + "title": "listAndCountCurrencies", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/currency/listCurrencies", + "title": "listCurrencies", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/currency/retrieveCurrency", + "title": "retrieveCurrency", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "currency-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Currency Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/currency/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "autogenerate_path": "/references/currency_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/currency/models/Currency", + "title": "Currency", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "customer", + "title": "Customer Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/customer", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/customer/customer-accounts", + "title": "Customer Accounts", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/customer/links-to-other-modules", + "title": "Link to Modules", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Server Guides", + "autogenerate_tags": "server+customer", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to use the Customer Module in your customizations on the Medusa application server.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Extend Customer", + "path": "https://docs.medusajs.com/resources/commerce-modules/customer/extend", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/customer/extend", + "title": "Extend Module", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Guides", + "autogenerate_tags": "storefront+customer,-jsSdk", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to integrate the Customer Module's features into your storefront.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Customer Context in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/context", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Edit Customer Profile in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/profile", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Log-out Customer in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/log-out", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Login Customer in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/login", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Customer Addresses in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/addresses", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Register Customer in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/register", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Reset Customer Password in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/reset-password", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Retrieve Logged-In Customer in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/retrieve", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Third-Party or Social Login in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/customers/third-party-login", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+customer", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Customer features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Customers Overview", + "path": "https://docs.medusajs.com/user-guide/customers", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Customer Groups", + "path": "https://docs.medusajs.com/user-guide/customers/groups", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Customers", + "path": "https://docs.medusajs.com/user-guide/customers/manage", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "description": "Find references for tools and resources related to the Customer Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/customer/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+customer", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addOrderLineItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrderLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCustomerAccountWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCustomerAccountWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCustomerAddressesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCustomerAddressesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCustomerGroupsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCustomerGroupsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCustomersWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCustomersWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCustomerAddressesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteCustomerAddressesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCustomerGroupsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteCustomerGroupsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCustomersWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteCustomersWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "linkCustomerGroupsToCustomerWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/linkCustomerGroupsToCustomerWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "linkCustomersToCustomerGroupWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/linkCustomersToCustomerGroupWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderClaimAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderEditAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderExchangeAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeCustomerAccountWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeCustomerAccountWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCustomerAddressesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCustomerAddressesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCustomerGroupsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCustomerGroupsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCustomersWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCustomersWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+customer", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCustomerAddressesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCustomerAddressesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCustomerGroupsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCustomerGroupsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCustomersStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCustomersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCustomerAddressesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteCustomerAddressesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCustomerGroupStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteCustomerGroupStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCustomersStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteCustomersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "findOrCreateCustomerStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/findOrCreateCustomerStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "linkCustomerGroupsToCustomerStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/linkCustomerGroupsToCustomerStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "linkCustomersToCustomerGroupStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/linkCustomersToCustomerGroupStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "maybeUnsetDefaultBillingAddressesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/maybeUnsetDefaultBillingAddressesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "maybeUnsetDefaultShippingAddressesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/maybeUnsetDefaultShippingAddressesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCustomerAddressesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCustomerAddressesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCustomerGroupsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCustomerGroupsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCustomersStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCustomersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "validateCustomerAccountCreation", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateCustomerAccountCreation", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/customer/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Store", + "autogenerate_tags": "jsSdk+storefront+customer", + "description": "The following methods or properties are used to send requests to Store API Routes related to the Customer Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "customer", + "path": "https://docs.medusajs.com/resources/references/js-sdk/store/customer", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+customer", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Customer Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "customer", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/customer", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "customerGroup", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/customerGroup", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/customer/events", + "title": "Events Reference", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/customer/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "customer-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Customer Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/customer/ICustomerModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/addCustomerToGroup", + "title": "addCustomerToGroup", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/createCustomerAddresses", + "title": "createCustomerAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/createCustomerGroups", + "title": "createCustomerGroups", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/createCustomers", + "title": "createCustomers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/deleteCustomerAddresses", + "title": "deleteCustomerAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/deleteCustomerGroups", + "title": "deleteCustomerGroups", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/deleteCustomers", + "title": "deleteCustomers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/listAndCountCustomerAddresses", + "title": "listAndCountCustomerAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/listAndCountCustomerGroups", + "title": "listAndCountCustomerGroups", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/listAndCountCustomers", + "title": "listAndCountCustomers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/listCustomerAddresses", + "title": "listCustomerAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/listCustomerGroupCustomers", + "title": "listCustomerGroupCustomers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/listCustomerGroups", + "title": "listCustomerGroups", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/listCustomers", + "title": "listCustomers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/removeCustomerFromGroup", + "title": "removeCustomerFromGroup", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/restoreCustomerGroups", + "title": "restoreCustomerGroups", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/restoreCustomers", + "title": "restoreCustomers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/retrieveCustomer", + "title": "retrieveCustomer", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/retrieveCustomerGroup", + "title": "retrieveCustomerGroup", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/softDeleteCustomerGroups", + "title": "softDeleteCustomerGroups", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/softDeleteCustomers", + "title": "softDeleteCustomers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/updateCustomerAddresses", + "title": "updateCustomerAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/updateCustomerGroups", + "title": "updateCustomerGroups", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/updateCustomers", + "title": "updateCustomers", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "customer-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Customer Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "autogenerate_path": "/references/customer_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/models/Customer", + "title": "Customer", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/models/CustomerAddress", + "title": "CustomerAddress", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/models/CustomerGroup", + "title": "CustomerGroup", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/customer/models/CustomerGroupCustomer", + "title": "CustomerGroupCustomer", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "fulfillment", + "title": "Fulfillment Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/fulfillment", + "title": "Overview", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/fulfillment/module-options", + "title": "Module Options", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "autogenerate_tags": "concept+fulfillment", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/fulfillment/concepts", + "title": "Fulfillment Concepts", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/fulfillment/fulfillment-provider", + "title": "Fulfillment Provider", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/fulfillment/shipping-option", + "title": "Shipping Option", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/fulfillment/item-fulfillment", + "title": "Item Fulfillment", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/fulfillment/links-to-other-modules", + "title": "Links to Other Modules", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Product Shipping Requirement", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/selling-products", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Server Guides", + "autogenerate_tags": "server+fulfillment", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to use the Fulfillment Module in your customizations on the Medusa application server.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Fulfillment Provider", + "path": "https://docs.medusajs.com/resources/references/fulfillment/provider", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/provider", + "title": "Create Fulfillment Provider Module", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "path": "/integrations/guides/shipstation", + "title": "Integrate ShipStation", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Guides", + "autogenerate_tags": "storefront+fulfillment,-jsSdk", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to integrate the Fulfillment Module's features into your storefront.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Checkout Step 3: Choose Shipping Method", + "path": "https://docs.medusajs.com/resources/storefront-development/checkout/shipping", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Implement Express Checkout with Medusa", + "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+fulfillment", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Fulfillment features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Locations & Shipping Overview", + "path": "https://docs.medusajs.com/user-guide/settings/locations-and-shipping", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Order Fulfillments", + "path": "https://docs.medusajs.com/user-guide/orders/fulfillments", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Shipping Profiles", + "path": "https://docs.medusajs.com/user-guide/settings/locations-and-shipping/shipping-profiles", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "description": "Find references for tools and resources related to the Fulfillment Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/fulfillment/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+fulfillment", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addShippingMethodToCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addShippingMethodToCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addToCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addToCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchShippingOptionRulesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchShippingOptionRulesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "calculateShippingOptionsPricesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/calculateShippingOptionsPricesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelFulfillmentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderFulfillmentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmClaimRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmClaimRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmExchangeRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmExchangeRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmReturnRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmReturnRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createAndCompleteReturnOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createAndCompleteReturnOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createFulfillmentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createLocationFulfillmentSetWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createLocationFulfillmentSetWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderFulfillmentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderShipmentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderShipmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createReturnFulfillmentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createReturnFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createServiceZonesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createServiceZonesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createShipmentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createShipmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createShippingOptionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createShippingOptionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createShippingProfilesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createShippingProfilesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteFulfillmentSetsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteFulfillmentSetsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteLineItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteServiceZonesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteServiceZonesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteShippingOptionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteShippingOptionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteShippingProfileWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteShippingProfileWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "importProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/importProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "listShippingOptionsForCartWithPricingWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/listShippingOptionsForCartWithPricingWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "markFulfillmentAsDeliveredWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/markFulfillmentAsDeliveredWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "markOrderFulfillmentAsDeliveredWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/markOrderFulfillmentAsDeliveredWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refreshCartItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refreshCartShippingMethodsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartShippingMethodsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "transferCartCustomerWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/transferCartCustomerWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateFulfillmentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateLineItemInCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateLineItemInCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateServiceZonesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateServiceZonesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateShippingOptionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateShippingOptionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateShippingProfilesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateShippingProfilesWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+fulfillment", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "calculateShippingOptionsPricesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/calculateShippingOptionsPricesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelFulfillmentStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelFulfillmentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createFulfillmentSets", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createFulfillmentSets", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createFulfillmentStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createFulfillmentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createReturnFulfillmentStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createReturnFulfillmentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createServiceZonesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createServiceZonesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createShippingOptionRulesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createShippingOptionRulesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createShippingProfilesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createShippingProfilesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteFulfillmentSetsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteFulfillmentSetsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteServiceZonesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteServiceZonesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteShippingOptionRulesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteShippingOptionRulesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteShippingOptionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteShippingOptionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteShippingProfilesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteShippingProfilesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "parseProductCsvStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/parseProductCsvStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateFulfillmentStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateFulfillmentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateServiceZonesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateServiceZonesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateShippingOptionRulesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateShippingOptionRulesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateShippingProfilesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateShippingProfilesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "upsertShippingOptionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/upsertShippingOptionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "validateAndReturnShippingMethodsDataStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateAndReturnShippingMethodsDataStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "validateCartShippingOptionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateCartShippingOptionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "validateShipmentStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateShipmentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "validateShippingOptionPricesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateShippingOptionPricesStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/fulfillment/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Store", + "autogenerate_tags": "jsSdk+storefront+fulfillment", + "description": "The following methods or properties are used to send requests to Store API Routes related to the Fulfillment Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "fulfillment", + "path": "https://docs.medusajs.com/resources/references/js-sdk/store/fulfillment", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+fulfillment", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Fulfillment Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "fulfillment", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/fulfillment", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "fulfillmentProvider", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/fulfillmentProvider", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "fulfillmentSet", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/fulfillmentSet", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "shippingOption", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/shippingOption", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "shippingProfile", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/shippingProfile", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/fulfillment/events", + "title": "Events Reference", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/fulfillment/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "fulfillment-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Fulfillment Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/fulfillment/IFulfillmentModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/calculateShippingOptionsPrices", + "title": "calculateShippingOptionsPrices", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/cancelFulfillment", + "title": "cancelFulfillment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/createFulfillment", + "title": "createFulfillment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/createFulfillmentSets", + "title": "createFulfillmentSets", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/createGeoZones", + "title": "createGeoZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/createReturnFulfillment", + "title": "createReturnFulfillment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/createServiceZones", + "title": "createServiceZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/createShippingOptionRules", + "title": "createShippingOptionRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/createShippingOptions", + "title": "createShippingOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/createShippingProfiles", + "title": "createShippingProfiles", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/deleteFulfillment", + "title": "deleteFulfillment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/deleteFulfillmentSets", + "title": "deleteFulfillmentSets", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/deleteGeoZones", + "title": "deleteGeoZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/deleteServiceZones", + "title": "deleteServiceZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/deleteShippingOptionRules", + "title": "deleteShippingOptionRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/deleteShippingOptionTypes", + "title": "deleteShippingOptionTypes", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/deleteShippingOptions", + "title": "deleteShippingOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/deleteShippingProfiles", + "title": "deleteShippingProfiles", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listAndCountFulfillmentSets", + "title": "listAndCountFulfillmentSets", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listAndCountFulfillments", + "title": "listAndCountFulfillments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listAndCountGeoZones", + "title": "listAndCountGeoZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listAndCountServiceZones", + "title": "listAndCountServiceZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listAndCountShippingOptionRules", + "title": "listAndCountShippingOptionRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listAndCountShippingOptionTypes", + "title": "listAndCountShippingOptionTypes", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listAndCountShippingOptions", + "title": "listAndCountShippingOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listAndCountShippingProfiles", + "title": "listAndCountShippingProfiles", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listFulfillmentProviders", + "title": "listFulfillmentProviders", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listFulfillmentSets", + "title": "listFulfillmentSets", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listFulfillments", + "title": "listFulfillments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listGeoZones", + "title": "listGeoZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listServiceZones", + "title": "listServiceZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listShippingOptionRules", + "title": "listShippingOptionRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listShippingOptionTypes", + "title": "listShippingOptionTypes", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listShippingOptions", + "title": "listShippingOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listShippingOptionsForContext", + "title": "listShippingOptionsForContext", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/listShippingProfiles", + "title": "listShippingProfiles", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/restoreFulfillmentSets", + "title": "restoreFulfillmentSets", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/restoreGeoZones", + "title": "restoreGeoZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/restoreServiceZones", + "title": "restoreServiceZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/restoreShippingOptions", + "title": "restoreShippingOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/restoreShippingProfiles", + "title": "restoreShippingProfiles", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/retrieveFulfillment", + "title": "retrieveFulfillment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/retrieveFulfillmentOptions", + "title": "retrieveFulfillmentOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/retrieveFulfillmentSet", + "title": "retrieveFulfillmentSet", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/retrieveGeoZone", + "title": "retrieveGeoZone", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/retrieveServiceZone", + "title": "retrieveServiceZone", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/retrieveShippingOption", + "title": "retrieveShippingOption", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/retrieveShippingOptionRule", + "title": "retrieveShippingOptionRule", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/retrieveShippingOptionType", + "title": "retrieveShippingOptionType", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/retrieveShippingProfile", + "title": "retrieveShippingProfile", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/softDeleteFulfillmentSets", + "title": "softDeleteFulfillmentSets", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/softDeleteGeoZones", + "title": "softDeleteGeoZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/softDeleteServiceZones", + "title": "softDeleteServiceZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/softDeleteShippingOptions", + "title": "softDeleteShippingOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/softDeleteShippingProfiles", + "title": "softDeleteShippingProfiles", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/updateFulfillment", + "title": "updateFulfillment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/updateFulfillmentSets", + "title": "updateFulfillmentSets", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/updateGeoZones", + "title": "updateGeoZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/updateServiceZones", + "title": "updateServiceZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/updateShippingOptionRules", + "title": "updateShippingOptionRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/updateShippingOptions", + "title": "updateShippingOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/updateShippingProfiles", + "title": "updateShippingProfiles", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/upsertServiceZones", + "title": "upsertServiceZones", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/upsertShippingOptions", + "title": "upsertShippingOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/upsertShippingProfiles", + "title": "upsertShippingProfiles", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/validateFulfillmentData", + "title": "validateFulfillmentData", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/validateFulfillmentOption", + "title": "validateFulfillmentOption", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/validateShippingOption", + "title": "validateShippingOption", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/validateShippingOptionsForPriceCalculation", + "title": "validateShippingOptionsForPriceCalculation", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "fulfillment-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Fulfillment Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "hasTitleStyling": true, + "autogenerate_path": "/references/fulfillment_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/models/Fulfillment", + "title": "Fulfillment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/models/FulfillmentAddress", + "title": "FulfillmentAddress", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/models/FulfillmentItem", + "title": "FulfillmentItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/models/FulfillmentLabel", + "title": "FulfillmentLabel", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/models/FulfillmentProvider", + "title": "FulfillmentProvider", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/models/FulfillmentSet", + "title": "FulfillmentSet", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/models/GeoZone", + "title": "GeoZone", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/models/ServiceZone", + "title": "ServiceZone", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/models/ShippingOption", + "title": "ShippingOption", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/models/ShippingOptionRule", + "title": "ShippingOptionRule", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/models/ShippingOptionType", + "title": "ShippingOptionType", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/fulfillment/models/ShippingProfile", + "title": "ShippingProfile", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "inventory", + "title": "Inventory Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/inventory", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "autogenerate_tags": "concept+inventory", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/inventory/concepts", + "title": "Inventory Concepts", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/inventory/inventory-in-flows", + "title": "Inventory in Flows", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/inventory/inventory-kit", + "title": "Inventory Kit", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/inventory/links-to-other-modules", + "title": "Links to Modules", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Inventory Kits", + "path": "https://docs.medusajs.com/resources/commerce-modules/inventory/inventory-kit", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Product Variant Inventory", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/variant-inventory", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Guides", + "autogenerate_tags": "storefront+inventory,-jsSdk", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to integrate the Inventory Module's features into your storefront.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Retrieve Product Variant's Inventory in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/inventory", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+inventory", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Inventory features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Inventory Overview", + "path": "https://docs.medusajs.com/user-guide/inventory", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Inventory Items", + "path": "https://docs.medusajs.com/user-guide/inventory/inventory", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Reservations", + "path": "https://docs.medusajs.com/user-guide/inventory/reservations", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "description": "Find references for tools and resources related to the Inventory Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/inventory/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+inventory", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addOrderLineItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrderLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addToCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addToCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchInventoryItemLevelsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchInventoryItemLevelsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchProductVariantsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "bulkCreateDeleteLevelsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/bulkCreateDeleteLevelsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderClaimWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderClaimWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderExchangeWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderExchangeWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderFulfillmentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "completeCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/completeCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmClaimRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmClaimRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmExchangeRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmExchangeRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmOrderEditRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmOrderEditRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmReturnReceiveWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmReturnReceiveWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmVariantInventoryWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmVariantInventoryWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createInventoryItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createInventoryItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createInventoryLevelsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createInventoryLevelsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderFulfillmentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductVariantsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createReservationsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createReservationsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteInventoryItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteInventoryItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductVariantsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteReservationsByLineItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteReservationsByLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteReservationsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteReservationsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderClaimAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderEditAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderExchangeAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateInventoryItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateInventoryItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateInventoryLevelsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateInventoryLevelsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateLineItemInCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateLineItemInCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateReservationsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateReservationsWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+inventory", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "adjustInventoryLevelsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/adjustInventoryLevelsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmInventoryStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/confirmInventoryStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createInventoryItemsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createInventoryItemsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createInventoryLevelsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createInventoryLevelsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createReservationsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createReservationsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteInventoryItemStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteInventoryItemStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteReservationsByLineItemsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteReservationsByLineItemsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteReservationsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteReservationsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "reserveInventoryStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/reserveInventoryStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateInventoryItemsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateInventoryItemsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateInventoryLevelsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateInventoryLevelsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateReservationsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateReservationsStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/inventory/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+inventory", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Inventory Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "inventoryItem", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/inventoryItem", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "reservation", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/reservation", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/inventory/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "inventory-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Inventory Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/inventory_next/IInventoryService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/adjustInventory", + "title": "adjustInventory", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/confirmInventory", + "title": "confirmInventory", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/createInventoryItems", + "title": "createInventoryItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/createInventoryLevels", + "title": "createInventoryLevels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/createReservationItems", + "title": "createReservationItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/deleteInventoryItemLevelByLocationId", + "title": "deleteInventoryItemLevelByLocationId", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/deleteInventoryItems", + "title": "deleteInventoryItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/deleteInventoryLevel", + "title": "deleteInventoryLevel", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/deleteInventoryLevels", + "title": "deleteInventoryLevels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/deleteReservationItemByLocationId", + "title": "deleteReservationItemByLocationId", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/deleteReservationItems", + "title": "deleteReservationItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/deleteReservationItemsByLineItem", + "title": "deleteReservationItemsByLineItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/listAndCountInventoryItems", + "title": "listAndCountInventoryItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/listAndCountInventoryLevels", + "title": "listAndCountInventoryLevels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/listAndCountReservationItems", + "title": "listAndCountReservationItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/listInventoryItems", + "title": "listInventoryItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/listInventoryLevels", + "title": "listInventoryLevels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/listReservationItems", + "title": "listReservationItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/restoreInventoryItems", + "title": "restoreInventoryItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/restoreInventoryLevels", + "title": "restoreInventoryLevels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/restoreReservationItems", + "title": "restoreReservationItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/restoreReservationItemsByLineItem", + "title": "restoreReservationItemsByLineItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/retrieveAvailableQuantity", + "title": "retrieveAvailableQuantity", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/retrieveInventoryItem", + "title": "retrieveInventoryItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/retrieveInventoryLevel", + "title": "retrieveInventoryLevel", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/retrieveInventoryLevelByItemAndLocation", + "title": "retrieveInventoryLevelByItemAndLocation", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/retrieveReservationItem", + "title": "retrieveReservationItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/retrieveReservedQuantity", + "title": "retrieveReservedQuantity", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/retrieveStockedQuantity", + "title": "retrieveStockedQuantity", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/softDeleteInventoryItems", + "title": "softDeleteInventoryItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/softDeleteInventoryLevels", + "title": "softDeleteInventoryLevels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/softDeleteReservationItems", + "title": "softDeleteReservationItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/updateInventoryItems", + "title": "updateInventoryItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/updateInventoryLevels", + "title": "updateInventoryLevels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/updateReservationItems", + "title": "updateReservationItems", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "inventory-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Inventory Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "autogenerate_path": "/references/inventory_next_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/models/InventoryItem", + "title": "InventoryItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/models/InventoryLevel", + "title": "InventoryLevel", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/inventory-next/models/ReservationItem", + "title": "ReservationItem", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "order", + "title": "Order Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/concepts", + "title": "Order Concepts", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/promotion-adjustments", + "title": "Promotions Adjustments", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/tax-lines", + "title": "Tax Lines", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/transactions", + "title": "Transactions", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/order-versioning", + "title": "Order Versioning", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/return", + "title": "Return", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/exchange", + "title": "Exchange", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/claim", + "title": "Claim", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/edit", + "title": "Order Edit", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/order-change", + "title": "Order Change", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/links-to-other-modules", + "title": "Links to Other Modules", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Guides", + "autogenerate_tags": "storefront+order,-jsSdk", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to integrate the Order Module's features into your storefront.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Checkout Step 5: Complete Cart", + "path": "https://docs.medusajs.com/resources/storefront-development/checkout/complete-cart", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Implement Express Checkout with Medusa", + "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+order", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Order features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Edit Order Items", + "path": "https://docs.medusajs.com/user-guide/orders/edit", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Order Claims", + "path": "https://docs.medusajs.com/user-guide/orders/claims", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Order Details", + "path": "https://docs.medusajs.com/user-guide/orders/manage", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Order Exchanges", + "path": "https://docs.medusajs.com/user-guide/orders/exchanges", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Order Fulfillments", + "path": "https://docs.medusajs.com/user-guide/orders/fulfillments", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Order Payments", + "path": "https://docs.medusajs.com/user-guide/orders/payments", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Order Returns", + "path": "https://docs.medusajs.com/user-guide/orders/returns", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Return Reasons", + "path": "https://docs.medusajs.com/user-guide/settings/return-reasons", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Orders Overview", + "path": "https://docs.medusajs.com/user-guide/orders", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "description": "Find references for tools and resources related to the Order Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+order", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "acceptOrderTransferWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/acceptOrderTransferWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addOrderLineItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrderLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "archiveOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/archiveOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "beginClaimOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/beginClaimOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "beginExchangeOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/beginExchangeOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "beginOrderEditOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/beginOrderEditOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "beginReceiveReturnWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/beginReceiveReturnWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "beginReturnOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/beginReturnOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelBeginOrderClaimWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelBeginOrderClaimWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelBeginOrderEditWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelBeginOrderEditWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelBeginOrderExchangeWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelBeginOrderExchangeWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderChangeWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderChangeWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderClaimWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderClaimWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderExchangeWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderExchangeWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderFulfillmentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderTransferRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderTransferRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelReturnReceiveWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelReturnReceiveWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelReturnRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelReturnRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelReturnWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelReturnWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "capturePaymentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/capturePaymentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "completeCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/completeCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "completeOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/completeOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmClaimRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmClaimRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmExchangeRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmExchangeRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmOrderEditRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmOrderEditRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmReturnReceiveWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmReturnReceiveWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmReturnRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmReturnRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createAndCompleteReturnOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createAndCompleteReturnOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createClaimShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createClaimShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createExchangeShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createExchangeShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderChangeWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderChangeWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderEditShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderEditShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderFulfillmentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderFulfillmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderShipmentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderShipmentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createReturnReasonsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createReturnReasonsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createReturnShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createReturnShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "declineOrderChangeWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/declineOrderChangeWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "declineOrderTransferRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/declineOrderTransferRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteOrderChangeActionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteOrderChangeActionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteOrderChangeWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteOrderChangeWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteReturnReasonsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteReturnReasonsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "dismissItemReturnRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/dismissItemReturnRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "markPaymentCollectionAsPaid", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/markPaymentCollectionAsPaid", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderClaimAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderClaimItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderClaimRequestItemReturnWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimRequestItemReturnWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderEditAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderEditUpdateItemQuantityWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditUpdateItemQuantityWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderExchangeAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderExchangeRequestItemReturnWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeRequestItemReturnWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "processPaymentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/processPaymentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "receiveItemReturnRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/receiveItemReturnRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refundPaymentsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refundPaymentsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refundPaymentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refundPaymentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeAddItemClaimActionWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeAddItemClaimActionWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeClaimShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeClaimShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeExchangeShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeExchangeShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeItemClaimActionWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeItemClaimActionWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeItemExchangeActionWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeItemExchangeActionWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeItemOrderEditActionWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeItemOrderEditActionWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeItemReceiveReturnActionWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeItemReceiveReturnActionWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeItemReturnActionWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeItemReturnActionWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeOrderEditShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeOrderEditShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeReturnShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeReturnShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "requestItemReturnWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/requestItemReturnWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "requestOrderEditRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/requestOrderEditRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "requestOrderTransferWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/requestOrderTransferWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateClaimAddItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateClaimAddItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateClaimItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateClaimItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateClaimShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateClaimShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateExchangeAddItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateExchangeAddItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateExchangeShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateExchangeShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderChangeActionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderChangeActionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderChangesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderChangesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderEditAddItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderEditAddItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderEditItemQuantityWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderEditItemQuantityWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderEditShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderEditShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderTaxLinesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderTaxLinesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateReceiveItemReturnRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateReceiveItemReturnRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateRequestItemReturnWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateRequestItemReturnWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateReturnReasonsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateReturnReasonsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateReturnShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateReturnShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateReturnWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateReturnWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+order", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addOrderTransactionStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/addOrderTransactionStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "archiveOrdersStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/archiveOrdersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderChangeStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelOrderChangeStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderClaimStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelOrderClaimStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderExchangeStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelOrderExchangeStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderFulfillmentStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelOrderFulfillmentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderReturnStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelOrderReturnStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrdersStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelOrdersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "completeOrdersStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/completeOrdersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCompleteReturnStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCompleteReturnStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderChangeStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrderChangeStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderClaimItemsFromActionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrderClaimItemsFromActionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderClaimsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrderClaimsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderExchangeItemsFromActionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrderExchangeItemsFromActionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderExchangesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrderExchangesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderLineItemsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrderLineItemsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrdersStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrdersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createReturnReasonsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createReturnReasonsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createReturnsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createReturnsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "declineOrderChangeStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/declineOrderChangeStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteClaimsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteClaimsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteExchangesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteExchangesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteOrderChangeActionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteOrderChangeActionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteOrderChangesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteOrderChangesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteOrderShippingMethods", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteOrderShippingMethods", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteReturnReasonStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteReturnReasonStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteReturnsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteReturnsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "previewOrderChangeStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/previewOrderChangeStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "registerOrderChangesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/registerOrderChangesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "registerOrderFulfillmentStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/registerOrderFulfillmentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "registerOrderShipmentStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/registerOrderShipmentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "setOrderTaxLinesForItemsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/setOrderTaxLinesForItemsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderChangeActionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateOrderChangeActionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderChangesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateOrderChangesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderShippingMethodsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateOrderShippingMethodsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrdersStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateOrdersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateReturnReasonsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateReturnReasonsStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Store", + "autogenerate_tags": "jsSdk+storefront+order", + "description": "The following methods or properties are used to send requests to Store API Routes related to the Order Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "order", + "path": "https://docs.medusajs.com/resources/references/js-sdk/store/order", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+order", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Order Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "claim", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/claim", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "draftOrder", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/draftOrder", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "exchange", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/exchange", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "order", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/order", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderEdit", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/orderEdit", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refundReason", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/refundReason", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "return", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/return", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "returnReason", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/returnReason", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/events", + "title": "Events Reference", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/order/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "order-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Order Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/order/IOrderModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/addOrderAction", + "title": "addOrderAction", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/addOrderTransactions", + "title": "addOrderTransactions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/applyPendingOrderActions", + "title": "applyPendingOrderActions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/archive", + "title": "archive", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/cancel", + "title": "cancel", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/cancelClaim", + "title": "cancelClaim", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/cancelExchange", + "title": "cancelExchange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/cancelFulfillment", + "title": "cancelFulfillment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/cancelOrderChange", + "title": "cancelOrderChange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/cancelReturn", + "title": "cancelReturn", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/completeOrder", + "title": "completeOrder", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/confirmOrderChange", + "title": "confirmOrderChange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createClaim", + "title": "createClaim", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createExchange", + "title": "createExchange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrderAddresses", + "title": "createOrderAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrderChange", + "title": "createOrderChange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrderClaimItems", + "title": "createOrderClaimItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrderClaims", + "title": "createOrderClaims", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrderCreditLines", + "title": "createOrderCreditLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrderExchangeItems", + "title": "createOrderExchangeItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrderExchanges", + "title": "createOrderExchanges", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrderLineItemAdjustments", + "title": "createOrderLineItemAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrderLineItemTaxLines", + "title": "createOrderLineItemTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrderLineItems", + "title": "createOrderLineItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrderShippingMethodAdjustments", + "title": "createOrderShippingMethodAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrderShippingMethodTaxLines", + "title": "createOrderShippingMethodTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrderShippingMethods", + "title": "createOrderShippingMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createOrders", + "title": "createOrders", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createReturn", + "title": "createReturn", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createReturnItems", + "title": "createReturnItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createReturnReasons", + "title": "createReturnReasons", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/createReturns", + "title": "createReturns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/declineOrderChange", + "title": "declineOrderChange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderAddresses", + "title": "deleteOrderAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderChangeActions", + "title": "deleteOrderChangeActions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderChanges", + "title": "deleteOrderChanges", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderClaimItemImages", + "title": "deleteOrderClaimItemImages", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderClaimItems", + "title": "deleteOrderClaimItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderClaims", + "title": "deleteOrderClaims", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderExchangeItems", + "title": "deleteOrderExchangeItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderExchanges", + "title": "deleteOrderExchanges", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderLineItemAdjustments", + "title": "deleteOrderLineItemAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderLineItemTaxLines", + "title": "deleteOrderLineItemTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderLineItems", + "title": "deleteOrderLineItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderShippingMethodAdjustments", + "title": "deleteOrderShippingMethodAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderShippingMethodTaxLines", + "title": "deleteOrderShippingMethodTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderShippingMethods", + "title": "deleteOrderShippingMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrderTransactions", + "title": "deleteOrderTransactions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteOrders", + "title": "deleteOrders", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteReturnItems", + "title": "deleteReturnItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteReturnReasons", + "title": "deleteReturnReasons", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/deleteReturns", + "title": "deleteReturns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listAndCountOrderClaims", + "title": "listAndCountOrderClaims", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listAndCountOrderExchanges", + "title": "listAndCountOrderExchanges", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listAndCountOrders", + "title": "listAndCountOrders", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listAndCountReturns", + "title": "listAndCountReturns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listOrderAddresses", + "title": "listOrderAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listOrderChangeActions", + "title": "listOrderChangeActions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listOrderChanges", + "title": "listOrderChanges", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listOrderClaims", + "title": "listOrderClaims", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listOrderExchanges", + "title": "listOrderExchanges", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listOrderLineItemAdjustments", + "title": "listOrderLineItemAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listOrderLineItemTaxLines", + "title": "listOrderLineItemTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listOrderLineItems", + "title": "listOrderLineItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listOrderShippingMethodAdjustments", + "title": "listOrderShippingMethodAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listOrderShippingMethodTaxLines", + "title": "listOrderShippingMethodTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listOrderShippingMethods", + "title": "listOrderShippingMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listOrderTransactions", + "title": "listOrderTransactions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listOrders", + "title": "listOrders", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listReturnReasons", + "title": "listReturnReasons", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/listReturns", + "title": "listReturns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/previewOrderChange", + "title": "previewOrderChange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/receiveReturn", + "title": "receiveReturn", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/registerDelivery", + "title": "registerDelivery", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/registerFulfillment", + "title": "registerFulfillment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/registerOrderChange", + "title": "registerOrderChange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/registerShipment", + "title": "registerShipment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreOrderAddresses", + "title": "restoreOrderAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreOrderChangeActions", + "title": "restoreOrderChangeActions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreOrderChanges", + "title": "restoreOrderChanges", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreOrderClaims", + "title": "restoreOrderClaims", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreOrderExchanges", + "title": "restoreOrderExchanges", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreOrderLineItemAdjustments", + "title": "restoreOrderLineItemAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreOrderLineItemTaxLines", + "title": "restoreOrderLineItemTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreOrderLineItems", + "title": "restoreOrderLineItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreOrderShippingMethodAdjustments", + "title": "restoreOrderShippingMethodAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreOrderShippingMethodTaxLines", + "title": "restoreOrderShippingMethodTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreOrderShippingMethods", + "title": "restoreOrderShippingMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreOrderTransactions", + "title": "restoreOrderTransactions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreOrders", + "title": "restoreOrders", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreReturnReasons", + "title": "restoreReturnReasons", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/restoreReturns", + "title": "restoreReturns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/retrieveOrder", + "title": "retrieveOrder", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/retrieveOrderChange", + "title": "retrieveOrderChange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/retrieveOrderChangeAction", + "title": "retrieveOrderChangeAction", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/retrieveOrderClaim", + "title": "retrieveOrderClaim", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/retrieveOrderExchange", + "title": "retrieveOrderExchange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/retrieveOrderLineItem", + "title": "retrieveOrderLineItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/retrieveReturn", + "title": "retrieveReturn", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/retrieveReturnReason", + "title": "retrieveReturnReason", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/revertLastVersion", + "title": "revertLastVersion", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/setOrderLineItemAdjustments", + "title": "setOrderLineItemAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/setOrderLineItemTaxLines", + "title": "setOrderLineItemTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/setOrderShippingMethodAdjustments", + "title": "setOrderShippingMethodAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/setOrderShippingMethodTaxLines", + "title": "setOrderShippingMethodTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteOrderAddresses", + "title": "softDeleteOrderAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteOrderChangeActions", + "title": "softDeleteOrderChangeActions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteOrderChanges", + "title": "softDeleteOrderChanges", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteOrderClaims", + "title": "softDeleteOrderClaims", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteOrderExchanges", + "title": "softDeleteOrderExchanges", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteOrderLineItemAdjustments", + "title": "softDeleteOrderLineItemAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteOrderLineItemTaxLines", + "title": "softDeleteOrderLineItemTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteOrderLineItems", + "title": "softDeleteOrderLineItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteOrderShippingMethodAdjustments", + "title": "softDeleteOrderShippingMethodAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteOrderShippingMethodTaxLines", + "title": "softDeleteOrderShippingMethodTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteOrderShippingMethods", + "title": "softDeleteOrderShippingMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteOrderTransactions", + "title": "softDeleteOrderTransactions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteOrders", + "title": "softDeleteOrders", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteReturnReasons", + "title": "softDeleteReturnReasons", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/softDeleteReturns", + "title": "softDeleteReturns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/undoLastChange", + "title": "undoLastChange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/updateOrderAddresses", + "title": "updateOrderAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/updateOrderChangeActions", + "title": "updateOrderChangeActions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/updateOrderChanges", + "title": "updateOrderChanges", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/updateOrderClaims", + "title": "updateOrderClaims", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/updateOrderExchanges", + "title": "updateOrderExchanges", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/updateOrderItem", + "title": "updateOrderItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/updateOrderLineItems", + "title": "updateOrderLineItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/updateOrderShippingMethods", + "title": "updateOrderShippingMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/updateOrders", + "title": "updateOrders", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/updateReturnReasons", + "title": "updateReturnReasons", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/updateReturns", + "title": "updateReturns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/upsertOrderLineItemAdjustments", + "title": "upsertOrderLineItemAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/upsertOrderLineItemTaxLines", + "title": "upsertOrderLineItemTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/upsertOrderShippingMethodAdjustments", + "title": "upsertOrderShippingMethodAdjustments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/upsertOrderShippingMethodTaxLines", + "title": "upsertOrderShippingMethodTaxLines", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "order-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Order Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "hasTitleStyling": true, + "autogenerate_path": "/references/order_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/Order", + "title": "Order", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderAddress", + "title": "OrderAddress", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderChange", + "title": "OrderChange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderChangeAction", + "title": "OrderChangeAction", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderClaim", + "title": "OrderClaim", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderClaimItem", + "title": "OrderClaimItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderClaimItemImage", + "title": "OrderClaimItemImage", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderCreditLine", + "title": "OrderCreditLine", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderExchange", + "title": "OrderExchange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderExchangeItem", + "title": "OrderExchangeItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderItem", + "title": "OrderItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderLineItem", + "title": "OrderLineItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderLineItemAdjustment", + "title": "OrderLineItemAdjustment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderLineItemTaxLine", + "title": "OrderLineItemTaxLine", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderShipping", + "title": "OrderShipping", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderShippingMethod", + "title": "OrderShippingMethod", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderShippingMethodAdjustment", + "title": "OrderShippingMethodAdjustment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderShippingMethodTaxLine", + "title": "OrderShippingMethodTaxLine", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderSummary", + "title": "OrderSummary", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/OrderTransaction", + "title": "OrderTransaction", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/Return", + "title": "Return", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/ReturnItem", + "title": "ReturnItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/order/models/ReturnReason", + "title": "ReturnReason", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "payment", + "title": "Payment Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment", + "title": "Overview", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment/module-options", + "title": "Module Options", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment/payment-collection", + "title": "Payment Collections", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment/payment-session", + "title": "Payment Session", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment/payment", + "title": "Payment", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment/payment-provider", + "title": "Payment Provider Module", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment/account-holder", + "title": "Account Holder", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment/webhook-events", + "title": "Webhook Events", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment/links-to-other-modules", + "title": "Links to Other Modules", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Server Guides", + "autogenerate_tags": "server+payment", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to use the Payment Module in your customizations on the Medusa application server.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment/payment-flow", + "title": "Accept Payment Flow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/provider", + "title": "Create Payment Provider", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Payment Provider", + "path": "https://docs.medusajs.com/resources/references/payment/provider", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Guides", + "autogenerate_tags": "storefront+payment,-jsSdk", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to integrate the Payment Module's features into your storefront.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Checkout Step 4: Choose Payment Provider", + "path": "https://docs.medusajs.com/resources/storefront-development/checkout/payment", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Checkout Step 5: Complete Cart", + "path": "https://docs.medusajs.com/resources/storefront-development/checkout/complete-cart", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Customize the Stripe Integration in the Next.js Starter", + "path": "https://docs.medusajs.com/resources/nextjs-starter/guides/customize-stripe", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Implement Express Checkout with Medusa", + "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Payment with Stripe in React Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/checkout/payment/stripe", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+payment", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Payment features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Order Payments", + "path": "https://docs.medusajs.com/user-guide/orders/payments", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Providers", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment/payment-provider/stripe", + "title": "Stripe", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "description": "Find references for tools and resources related to the Payment Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+payment", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addShippingMethodToCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addShippingMethodToCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addToCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addToCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "capturePaymentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/capturePaymentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "completeCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/completeCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmClaimRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmClaimRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmExchangeRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmExchangeRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmOrderEditRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmOrderEditRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "confirmReturnRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmReturnRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderPaymentCollectionWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderPaymentCollectionWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrUpdateOrderPaymentCollectionWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrUpdateOrderPaymentCollectionWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPaymentCollectionForCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPaymentCollectionForCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPaymentSessionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPaymentSessionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createRefundReasonsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createRefundReasonsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createRegionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createRegionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteLineItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deletePaymentSessionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deletePaymentSessionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteRefundReasonsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteRefundReasonsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "markPaymentCollectionAsPaid", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/markPaymentCollectionAsPaid", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "processPaymentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/processPaymentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refreshCartItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refreshPaymentCollectionForCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshPaymentCollectionForCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refundPaymentsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refundPaymentsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refundPaymentWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refundPaymentWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "requestOrderEditRequestWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/requestOrderEditRequestWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "transferCartCustomerWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/transferCartCustomerWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateLineItemInCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateLineItemInCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateRefundReasonsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateRefundReasonsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateRegionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateRegionsWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+payment", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "authorizePaymentSessionStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/authorizePaymentSessionStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "cancelPaymentStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelPaymentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "capturePaymentStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/capturePaymentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPaymentAccountHolderStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPaymentAccountHolderStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPaymentCollectionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPaymentCollectionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPaymentSessionStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPaymentSessionStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createRefundReasonStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createRefundReasonStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deletePaymentSessionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deletePaymentSessionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteRefundReasonsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteRefundReasonsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refundPaymentsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/refundPaymentsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refundPaymentStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/refundPaymentStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "setRegionsPaymentProvidersStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/setRegionsPaymentProvidersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePaymentCollectionStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePaymentCollectionStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateRefundReasonsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateRefundReasonsStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Store", + "autogenerate_tags": "jsSdk+storefront+payment", + "description": "The following methods or properties are used to send requests to Store API Routes related to the Payment Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "payment", + "path": "https://docs.medusajs.com/resources/references/js-sdk/store/payment", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+payment", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Payment Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "payment", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/payment", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "paymentCollection", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/paymentCollection", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment/events", + "title": "Events Reference", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "payment-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Payment Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/payment/IPaymentModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/authorizePaymentSession", + "title": "authorizePaymentSession", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/cancelPayment", + "title": "cancelPayment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/capturePayment", + "title": "capturePayment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/completePaymentCollections", + "title": "completePaymentCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/createAccountHolder", + "title": "createAccountHolder", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/createPaymentCollections", + "title": "createPaymentCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/createPaymentMethods", + "title": "createPaymentMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/createPaymentSession", + "title": "createPaymentSession", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/createRefundReasons", + "title": "createRefundReasons", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/deleteAccountHolder", + "title": "deleteAccountHolder", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/deleteCaptures", + "title": "deleteCaptures", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/deletePaymentCollections", + "title": "deletePaymentCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/deletePaymentSession", + "title": "deletePaymentSession", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/deleteRefundReasons", + "title": "deleteRefundReasons", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/deleteRefunds", + "title": "deleteRefunds", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/getWebhookActionAndData", + "title": "getWebhookActionAndData", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/listAndCountPaymentCollections", + "title": "listAndCountPaymentCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/listAndCountPaymentMethods", + "title": "listAndCountPaymentMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/listAndCountPaymentProviders", + "title": "listAndCountPaymentProviders", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/listCaptures", + "title": "listCaptures", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/listPaymentCollections", + "title": "listPaymentCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/listPaymentMethods", + "title": "listPaymentMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/listPaymentProviders", + "title": "listPaymentProviders", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/listPaymentSessions", + "title": "listPaymentSessions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/listPayments", + "title": "listPayments", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/listRefundReasons", + "title": "listRefundReasons", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/listRefunds", + "title": "listRefunds", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/refundPayment", + "title": "refundPayment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/restorePaymentCollections", + "title": "restorePaymentCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/restoreRefundReasons", + "title": "restoreRefundReasons", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/retrievePaymentCollection", + "title": "retrievePaymentCollection", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/retrievePaymentSession", + "title": "retrievePaymentSession", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/softDeletePaymentCollections", + "title": "softDeletePaymentCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/softDeleteRefundReasons", + "title": "softDeleteRefundReasons", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/updateAccountHolder", + "title": "updateAccountHolder", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/updatePayment", + "title": "updatePayment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/updatePaymentCollections", + "title": "updatePaymentCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/updatePaymentSession", + "title": "updatePaymentSession", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/updateRefundReasons", + "title": "updateRefundReasons", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/upsertPaymentCollections", + "title": "upsertPaymentCollections", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "payment-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Payment Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "autogenerate_path": "/references/payment_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/models/AccountHolder", + "title": "AccountHolder", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/models/Capture", + "title": "Capture", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/models/Payment", + "title": "Payment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/models/PaymentCollection", + "title": "PaymentCollection", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/models/PaymentProvider", + "title": "PaymentProvider", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/models/PaymentSession", + "title": "PaymentSession", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/models/Refund", + "title": "Refund", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/payment/models/RefundReason", + "title": "RefundReason", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "pricing", + "title": "Pricing Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/pricing", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/pricing/concepts", + "title": "Pricing Concepts", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/pricing/price-rules", + "title": "Price Rules", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/pricing/price-calculation", + "title": "Prices Calculation", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/pricing/tax-inclusive-pricing", + "title": "Tax-Inclusive Pricing", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/pricing/links-to-other-modules", + "title": "Links to Other Modules", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Server Guides", + "autogenerate_tags": "server+pricing", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to use the Pricing Module in your customizations on the Medusa application server.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Get Variant Price with Taxes", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price-with-taxes", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Get Variant Prices", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Implement Custom Line Item Pricing in Medusa", + "path": "https://docs.medusajs.com/resources/examples/guides/custom-item-price", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Guides", + "autogenerate_tags": "storefront+pricing,-jsSdk", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to integrate the Pricing Module's features into your storefront.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Example: Show Price with Taxes", + "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/tax-price", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Example: Show Sale Price", + "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/sale-price", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Example: Show Variant's Price", + "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/show-price", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Retrieve Product Variant's Prices in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/price", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+pricing", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Pricing features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create a Price List", + "path": "https://docs.medusajs.com/user-guide/price-lists/create", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Price Lists", + "path": "https://docs.medusajs.com/user-guide/price-lists/manage", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Price Lists Overview", + "path": "https://docs.medusajs.com/user-guide/price-lists", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "description": "Find references for tools and resources related to the Pricing Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/pricing/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+pricing", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchPriceListPricesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchPriceListPricesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchProductVariantsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPriceListPricesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPriceListPricesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPriceListsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPriceListsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPricePreferencesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPricePreferencesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductVariantsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createRegionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createRegionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createShippingOptionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createShippingOptionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createStoresWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createStoresWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deletePriceListsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deletePriceListsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deletePricePreferencesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deletePricePreferencesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removePriceListPricesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removePriceListPricesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePriceListPricesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updatePriceListPricesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePriceListsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updatePriceListsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePricePreferencesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updatePricePreferencesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductVariantsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateRegionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateRegionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateShippingOptionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateShippingOptionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateStoresWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateStoresWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "upsertVariantPricesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/upsertVariantPricesWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+pricing", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPriceListPricesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPriceListPricesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPriceListsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPriceListsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPricePreferencesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPricePreferencesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPriceSetsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPriceSetsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createShippingOptionsPriceSetsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createShippingOptionsPriceSetsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deletePriceListsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deletePriceListsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deletePricePreferencesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deletePricePreferencesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removePriceListPricesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/removePriceListPricesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "setShippingOptionsPricesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/setShippingOptionsPricesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePriceListPricesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePriceListPricesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePriceListsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePriceListsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePricePreferencesAsArrayStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePricePreferencesAsArrayStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePricePreferencesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePricePreferencesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePriceSetsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePriceSetsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "validatePriceListsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validatePriceListsStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/pricing/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+pricing", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Pricing Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "priceList", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/priceList", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "pricePreference", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/pricePreference", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/pricing/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "pricing-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Pricing Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/pricing/IPricingModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/addPriceListPrices", + "title": "addPriceListPrices", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/addPrices", + "title": "addPrices", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/calculatePrices", + "title": "calculatePrices", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/createPriceLists", + "title": "createPriceLists", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/createPricePreferences", + "title": "createPricePreferences", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/createPriceRules", + "title": "createPriceRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/createPriceSets", + "title": "createPriceSets", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/deletePriceListRules", + "title": "deletePriceListRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/deletePriceLists", + "title": "deletePriceLists", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/deletePricePreferences", + "title": "deletePricePreferences", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/deletePriceRules", + "title": "deletePriceRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/deletePriceSets", + "title": "deletePriceSets", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/listAndCountPriceListRules", + "title": "listAndCountPriceListRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/listAndCountPriceLists", + "title": "listAndCountPriceLists", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/listAndCountPriceRules", + "title": "listAndCountPriceRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/listAndCountPriceSets", + "title": "listAndCountPriceSets", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/listAndCountPrices", + "title": "listAndCountPrices", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/listPriceListRules", + "title": "listPriceListRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/listPriceLists", + "title": "listPriceLists", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/listPricePreferences", + "title": "listPricePreferences", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/listPriceRules", + "title": "listPriceRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/listPriceSets", + "title": "listPriceSets", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/listPrices", + "title": "listPrices", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/removePriceListRules", + "title": "removePriceListRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/removePrices", + "title": "removePrices", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/restorePriceLists", + "title": "restorePriceLists", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/restorePricePreferences", + "title": "restorePricePreferences", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/restorePrices", + "title": "restorePrices", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/retrievePriceList", + "title": "retrievePriceList", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/retrievePriceListRule", + "title": "retrievePriceListRule", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/retrievePricePreference", + "title": "retrievePricePreference", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/retrievePriceRule", + "title": "retrievePriceRule", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/retrievePriceSet", + "title": "retrievePriceSet", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/setPriceListRules", + "title": "setPriceListRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/softDeletePriceLists", + "title": "softDeletePriceLists", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/softDeletePricePreferences", + "title": "softDeletePricePreferences", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/softDeletePrices", + "title": "softDeletePrices", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/updatePriceListPrices", + "title": "updatePriceListPrices", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/updatePriceLists", + "title": "updatePriceLists", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/updatePricePreferences", + "title": "updatePricePreferences", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/updatePriceRules", + "title": "updatePriceRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/updatePriceSets", + "title": "updatePriceSets", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/upsertPricePreferences", + "title": "upsertPricePreferences", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/upsertPriceSets", + "title": "upsertPriceSets", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "pricing-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Pricing Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "hasTitleStyling": true, + "autogenerate_path": "/references/pricing_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/models/Price", + "title": "Price", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/models/PriceList", + "title": "PriceList", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/models/PriceListRule", + "title": "PriceListRule", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/models/PricePreference", + "title": "PricePreference", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/models/PriceRule", + "title": "PriceRule", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/pricing/models/PriceSet", + "title": "PriceSet", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "product", + "title": "Product Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/product", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "autogenerate_tags": "concept+product", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/product/variant-inventory", + "title": "Variant Inventory", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/product/selling-products", + "title": "Selling Use Cases", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/product/links-to-other-modules", + "title": "Links to Other Modules", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Inventory Kits", + "path": "https://docs.medusajs.com/resources/commerce-modules/inventory/inventory-kit", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Server Guides", + "autogenerate_tags": "server+product", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to use the Product Module in your customizations on the Medusa application server.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Build Wishlist Plugin", + "path": "https://docs.medusajs.com/resources/plugins/guides/wishlist", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/product/extend", + "title": "Extend Module", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Extend Product", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/extend", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/product/guides/price-with-taxes", + "title": "Get Variant Price with Taxes", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Get Variant Price with Taxes", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price-with-taxes", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/product/guides/price", + "title": "Get Variant Prices", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Get Variant Prices", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Guides", + "autogenerate_tags": "storefront+product,-jsSdk", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to integrate the Product Module's features into your storefront.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Example: Show Price with Taxes", + "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/tax-price", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Example: Show Sale Price", + "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/sale-price", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Example: Show Variant's Price", + "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/show-price", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Implement Express Checkout with Medusa", + "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "List Product Categories in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/categories/list", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "List Product Collections in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/collections/list", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "List Products in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/list", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Retrieve a Category in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/categories/retrieve", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Retrieve a Category's Products in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/categories/products", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Retrieve a Collection in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/collections/retrieve", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Retrieve a Collection's Products in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/collections/products", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Retrieve a Product in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/retrieve", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Retrieve Nested Categories in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/categories/nested-categories", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Retrieve Product Variant's Inventory in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/inventory", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Retrieve Product Variant's Prices in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/price", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Select Product Variants in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/products/variants", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+product", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Product features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Bundle Product", + "path": "https://docs.medusajs.com/user-guide/products/create/bundle", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Multi-Part Product", + "path": "https://docs.medusajs.com/user-guide/products/create/multi-part", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Product", + "path": "https://docs.medusajs.com/user-guide/products/create", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Edit Product", + "path": "https://docs.medusajs.com/user-guide/products/edit", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Export Products", + "path": "https://docs.medusajs.com/user-guide/products/export", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Import Products", + "path": "https://docs.medusajs.com/user-guide/products/import", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Product Categories", + "path": "https://docs.medusajs.com/user-guide/products/categories", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Product Collections", + "path": "https://docs.medusajs.com/user-guide/products/collections", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Product Tags", + "path": "https://docs.medusajs.com/user-guide/settings/product-tags", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Product Types", + "path": "https://docs.medusajs.com/user-guide/settings/product-types", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Product Variants", + "path": "https://docs.medusajs.com/user-guide/products/variants", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Products Overview", + "path": "https://docs.medusajs.com/user-guide/products", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "description": "Find references for tools and resources related to the Product Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/product/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+product", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchLinkProductsToCategoryWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchLinkProductsToCategoryWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchLinkProductsToCollectionWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchLinkProductsToCollectionWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchProductVariantsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCollectionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCollectionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductCategoriesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductCategoriesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductOptionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductOptionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductTagsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductTagsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductTypesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductTypesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductVariantsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCollectionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteCollectionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductCategoriesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductCategoriesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductOptionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductOptionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductTagsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductTagsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductTypesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductTypesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductVariantsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductVariantsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "importProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/importProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCollectionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCollectionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductCategoriesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductCategoriesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductOptionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductOptionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductTagsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductTagsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductTypesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductTypesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductVariantsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductVariantsWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+product", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchLinkProductsToCategoryStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/batchLinkProductsToCategoryStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchLinkProductsToCollectionStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/batchLinkProductsToCollectionStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCollectionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCollectionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductCategoriesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createProductCategoriesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductOptionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createProductOptionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createProductsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductTagsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createProductTagsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductTypesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createProductTypesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createProductVariantsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createProductVariantsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCollectionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteCollectionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductCategoriesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteProductCategoriesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductOptionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteProductOptionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteProductsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductTagsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteProductTagsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductTypesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteProductTypesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteProductVariantsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteProductVariantsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "getProductsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/getProductsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "groupProductsForBatchStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/groupProductsForBatchStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "parseProductCsvStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/parseProductCsvStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCollectionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCollectionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductCategoriesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateProductCategoriesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductOptionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateProductOptionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateProductsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductTagsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateProductTagsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductTypesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateProductTypesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateProductVariantsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateProductVariantsStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/product/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Store", + "autogenerate_tags": "jsSdk+storefront+product", + "description": "The following methods or properties are used to send requests to Store API Routes related to the Product Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "category", + "path": "https://docs.medusajs.com/resources/references/js-sdk/store/category", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "collection", + "path": "https://docs.medusajs.com/resources/references/js-sdk/store/collection", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "product", + "path": "https://docs.medusajs.com/resources/references/js-sdk/store/product", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+product", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Product Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "product", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/product", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "productCategory", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/productCategory", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "productCollection", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/productCollection", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "productTag", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/productTag", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "productType", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/productType", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "productVariant", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/productVariant", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/product/events", + "title": "Events Reference", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/product/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "product-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Product Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/product/IProductModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/createProductCategories", + "title": "createProductCategories", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/createProductCollections", + "title": "createProductCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/createProductOptionValues", + "title": "createProductOptionValues", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/createProductOptions", + "title": "createProductOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/createProductTags", + "title": "createProductTags", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/createProductTypes", + "title": "createProductTypes", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/createProductVariants", + "title": "createProductVariants", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/createProducts", + "title": "createProducts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/deleteProductCategories", + "title": "deleteProductCategories", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/deleteProductCollections", + "title": "deleteProductCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/deleteProductOptionValues", + "title": "deleteProductOptionValues", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/deleteProductOptions", + "title": "deleteProductOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/deleteProductTags", + "title": "deleteProductTags", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/deleteProductTypes", + "title": "deleteProductTypes", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/deleteProductVariants", + "title": "deleteProductVariants", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/deleteProducts", + "title": "deleteProducts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listAndCountProductCategories", + "title": "listAndCountProductCategories", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listAndCountProductCollections", + "title": "listAndCountProductCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listAndCountProductOptionValues", + "title": "listAndCountProductOptionValues", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listAndCountProductOptions", + "title": "listAndCountProductOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listAndCountProductTags", + "title": "listAndCountProductTags", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listAndCountProductTypes", + "title": "listAndCountProductTypes", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listAndCountProductVariants", + "title": "listAndCountProductVariants", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listAndCountProducts", + "title": "listAndCountProducts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listProductCategories", + "title": "listProductCategories", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listProductCollections", + "title": "listProductCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listProductOptionValues", + "title": "listProductOptionValues", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listProductOptions", + "title": "listProductOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listProductTags", + "title": "listProductTags", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listProductTypes", + "title": "listProductTypes", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listProductVariants", + "title": "listProductVariants", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/listProducts", + "title": "listProducts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/restoreProductCategories", + "title": "restoreProductCategories", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/restoreProductCollections", + "title": "restoreProductCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/restoreProductOptionValues", + "title": "restoreProductOptionValues", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/restoreProductOptions", + "title": "restoreProductOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/restoreProductTags", + "title": "restoreProductTags", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/restoreProductTypes", + "title": "restoreProductTypes", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/restoreProductVariants", + "title": "restoreProductVariants", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/restoreProducts", + "title": "restoreProducts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/retrieveProduct", + "title": "retrieveProduct", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/retrieveProductCategory", + "title": "retrieveProductCategory", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/retrieveProductCollection", + "title": "retrieveProductCollection", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/retrieveProductOption", + "title": "retrieveProductOption", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/retrieveProductTag", + "title": "retrieveProductTag", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/retrieveProductType", + "title": "retrieveProductType", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/retrieveProductVariant", + "title": "retrieveProductVariant", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/softDeleteProductCategories", + "title": "softDeleteProductCategories", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/softDeleteProductCollections", + "title": "softDeleteProductCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/softDeleteProductOptionValues", + "title": "softDeleteProductOptionValues", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/softDeleteProductOptions", + "title": "softDeleteProductOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/softDeleteProductTags", + "title": "softDeleteProductTags", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/softDeleteProductTypes", + "title": "softDeleteProductTypes", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/softDeleteProductVariants", + "title": "softDeleteProductVariants", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/softDeleteProducts", + "title": "softDeleteProducts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/updateProductCategories", + "title": "updateProductCategories", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/updateProductCollections", + "title": "updateProductCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/updateProductOptionValues", + "title": "updateProductOptionValues", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/updateProductOptions", + "title": "updateProductOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/updateProductTags", + "title": "updateProductTags", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/updateProductTypes", + "title": "updateProductTypes", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/updateProductVariants", + "title": "updateProductVariants", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/updateProducts", + "title": "updateProducts", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/upsertProductCategories", + "title": "upsertProductCategories", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/upsertProductCollections", + "title": "upsertProductCollections", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/upsertProductOptions", + "title": "upsertProductOptions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/upsertProductTags", + "title": "upsertProductTags", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/upsertProductTypes", + "title": "upsertProductTypes", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/upsertProductVariants", + "title": "upsertProductVariants", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/upsertProducts", + "title": "upsertProducts", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "product-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Product Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "hasTitleStyling": true, + "autogenerate_path": "/references/product_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/models/Product", + "title": "Product", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/models/ProductCategory", + "title": "ProductCategory", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/models/ProductCollection", + "title": "ProductCollection", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/models/ProductImage", + "title": "ProductImage", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/models/ProductOption", + "title": "ProductOption", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/models/ProductOptionValue", + "title": "ProductOptionValue", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/models/ProductTag", + "title": "ProductTag", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/models/ProductType", + "title": "ProductType", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/product/models/ProductVariant", + "title": "ProductVariant", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "promotion", + "title": "Promotion Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/promotion", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/promotion/concepts", + "title": "Promotion", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/promotion/application-method", + "title": "Application Method", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/promotion/campaign", + "title": "Campaign", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/promotion/actions", + "title": "Promotion Actions", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/promotion/links-to-other-modules", + "title": "Links to Modules", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Server Guides", + "autogenerate_tags": "server+promotion", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to use the Promotion Module in your customizations on the Medusa application server.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/promotion/extend", + "title": "Extend Module", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Extend Promotion", + "path": "https://docs.medusajs.com/resources/commerce-modules/promotion/extend", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+promotion", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Promotion features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create a Promotion", + "path": "https://docs.medusajs.com/user-guide/promotions/create", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Campaigns", + "path": "https://docs.medusajs.com/user-guide/promotions/campaigns", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Promotions", + "path": "https://docs.medusajs.com/user-guide/promotions/manage", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Promotions Overview", + "path": "https://docs.medusajs.com/user-guide/promotions", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "description": "Find references for tools and resources related to the Promotion Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/promotion/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+promotion", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addOrRemoveCampaignPromotionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrRemoveCampaignPromotionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addShippingMethodToCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addShippingMethodToCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addToCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addToCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "batchPromotionRulesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchPromotionRulesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCampaignsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCampaignsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPromotionRulesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPromotionRulesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPromotionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPromotionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCampaignsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteCampaignsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteLineItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deletePromotionRulesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deletePromotionRulesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deletePromotionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deletePromotionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refreshCartItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "transferCartCustomerWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/transferCartCustomerWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCampaignsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCampaignsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartPromotionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartPromotionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateLineItemInCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateLineItemInCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePromotionRulesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updatePromotionRulesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePromotionsStatusWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updatePromotionsStatusWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePromotionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updatePromotionsWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+promotion", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addCampaignPromotionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/addCampaignPromotionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addRulesToPromotionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/addRulesToPromotionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCampaignsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCampaignsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createPromotionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPromotionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteCampaignsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteCampaignsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deletePromotionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deletePromotionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "getActionsToComputeFromPromotionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/getActionsToComputeFromPromotionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "getPromotionCodesToApply", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/getPromotionCodesToApply", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "prepareAdjustmentsFromPromotionActionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/prepareAdjustmentsFromPromotionActionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeCampaignPromotionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/removeCampaignPromotionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeRulesFromPromotionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/removeRulesFromPromotionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCampaignsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCampaignsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartPromotionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCartPromotionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePromotionRulesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePromotionRulesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updatePromotionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePromotionsStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/promotion/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+promotion", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Promotion Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "campaign", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/campaign", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "promotion", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/promotion", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/promotion/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "promotion-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Promotion Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "hasTitleStyling": true, + "autogenerate_path": "/references/promotion/IPromotionModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/addPromotionBuyRules", + "title": "addPromotionBuyRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/addPromotionRules", + "title": "addPromotionRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/addPromotionTargetRules", + "title": "addPromotionTargetRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/addPromotionsToCampaign", + "title": "addPromotionsToCampaign", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/computeActions", + "title": "computeActions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/createCampaigns", + "title": "createCampaigns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/createPromotions", + "title": "createPromotions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/deleteCampaigns", + "title": "deleteCampaigns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/deletePromotions", + "title": "deletePromotions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/listAndCountCampaigns", + "title": "listAndCountCampaigns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/listAndCountPromotions", + "title": "listAndCountPromotions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/listCampaigns", + "title": "listCampaigns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/listPromotionRules", + "title": "listPromotionRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/listPromotions", + "title": "listPromotions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/registerUsage", + "title": "registerUsage", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/removePromotionBuyRules", + "title": "removePromotionBuyRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/removePromotionRules", + "title": "removePromotionRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/removePromotionTargetRules", + "title": "removePromotionTargetRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/removePromotionsFromCampaign", + "title": "removePromotionsFromCampaign", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/restoreCampaigns", + "title": "restoreCampaigns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/restorePromotions", + "title": "restorePromotions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/retrieveCampaign", + "title": "retrieveCampaign", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/retrievePromotion", + "title": "retrievePromotion", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/revertUsage", + "title": "revertUsage", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/softDeleteCampaigns", + "title": "softDeleteCampaigns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/softDeletePromotions", + "title": "softDeletePromotions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/updateCampaigns", + "title": "updateCampaigns", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/updatePromotionRules", + "title": "updatePromotionRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/updatePromotions", + "title": "updatePromotions", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "promotion-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Promotion Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "hasTitleStyling": true, + "autogenerate_path": "/references/promotion_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/models/ApplicationMethod", + "title": "ApplicationMethod", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/models/Campaign", + "title": "Campaign", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/models/CampaignBudget", + "title": "CampaignBudget", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/models/Promotion", + "title": "Promotion", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/models/PromotionRule", + "title": "PromotionRule", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/promotion/models/PromotionRuleValue", + "title": "PromotionRuleValue", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "region", + "title": "Region Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/region", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/region/links-to-other-modules", + "title": "Links to Modules", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Guides", + "autogenerate_tags": "storefront+region,-jsSdk", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to integrate the Region Module's features into your storefront.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Implement Express Checkout with Medusa", + "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "List Regions in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/regions/list", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Region Context in Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/regions/context", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Store and Retrieve Region", + "path": "https://docs.medusajs.com/resources/storefront-development/regions/store-retrieve-region", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+region", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Region features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Regions", + "path": "https://docs.medusajs.com/user-guide/settings/regions", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "description": "Find references for tools and resources related to the Region Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/region/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+region", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addOrderLineItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrderLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createRegionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createRegionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createShippingOptionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createShippingOptionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteRegionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteRegionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "exportProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/exportProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "importProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/importProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderClaimAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderEditAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderExchangeAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateRegionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateRegionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateShippingOptionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateShippingOptionsWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+region", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createRegionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createRegionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteRegionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteRegionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "findOneOrAnyRegionStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/findOneOrAnyRegionStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "generateProductCsvStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/generateProductCsvStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "parseProductCsvStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/parseProductCsvStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateRegionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateRegionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "validateShippingOptionPricesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateShippingOptionPricesStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/region/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Store", + "autogenerate_tags": "jsSdk+storefront+region", + "description": "The following methods or properties are used to send requests to Store API Routes related to the Region Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "region", + "path": "https://docs.medusajs.com/resources/references/js-sdk/store/region", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+region", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Region Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "region", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/region", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/region/events", + "title": "Events Reference", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/region/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "region-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Region Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/region/IRegionModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/createRegions", + "title": "createRegions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/deleteRegions", + "title": "deleteRegions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/listAndCountCountries", + "title": "listAndCountCountries", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/listAndCountRegions", + "title": "listAndCountRegions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/listCountries", + "title": "listCountries", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/listRegions", + "title": "listRegions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/restoreRegions", + "title": "restoreRegions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/retrieveCountry", + "title": "retrieveCountry", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/retrieveRegion", + "title": "retrieveRegion", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/softDeleteRegions", + "title": "softDeleteRegions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/updateRegions", + "title": "updateRegions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/upsertRegions", + "title": "upsertRegions", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "region-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Region Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "autogenerate_path": "/references/region_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/models/Country", + "title": "Country", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/region/models/Region", + "title": "Region", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "sales-channel", + "title": "Sales Channel Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/sales-channel", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "autogenerate_tags": "concept+salesChannel", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/sales-channel/publishable-api-keys", + "title": "Publishable API Keys", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/sales-channel/links-to-other-modules", + "title": "Links to Modules", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Product Variant Inventory", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/variant-inventory", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Guides", + "autogenerate_tags": "storefront+salesChannel,-jsSdk", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to integrate the Sales Channel Module's features into your storefront.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Use a Publishable API Key in the Storefront", + "path": "https://docs.medusajs.com/resources/storefront-development/publishable-api-keys", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+salesChannel", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Sales Channel features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Sales Channels", + "path": "https://docs.medusajs.com/user-guide/settings/sales-channels", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "description": "Find references for tools and resources related to the Sales Channel Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/sales-channel/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+salesChannel", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addOrderLineItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrderLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createDefaultsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createDefaultsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createSalesChannelsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createSalesChannelsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteSalesChannelsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteSalesChannelsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "importProductsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/importProductsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "linkSalesChannelsToApiKeyWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/linkSalesChannelsToApiKeyWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderClaimAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderEditAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderExchangeAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateSalesChannelsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateSalesChannelsWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+salesChannel", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createDefaultSalesChannelStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createDefaultSalesChannelStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createSalesChannelsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createSalesChannelsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteSalesChannelsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteSalesChannelsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "findSalesChannelStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/findSalesChannelStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "parseProductCsvStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/parseProductCsvStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateSalesChannelsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateSalesChannelsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "validateSalesChannelsExistStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateSalesChannelsExistStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/sales-channel/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+salesChannel", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Sales Channel Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "salesChannel", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/salesChannel", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/sales-channel/events", + "title": "Events Reference", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/sales-channel/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "sales-channel-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Sales Channel Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/sales-channel", + "title": "Reference Overview", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/sales_channel/ISalesChannelModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/sales-channel/createSalesChannels", + "title": "createSalesChannels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/sales-channel/deleteSalesChannels", + "title": "deleteSalesChannels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/sales-channel/listAndCountSalesChannels", + "title": "listAndCountSalesChannels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/sales-channel/listSalesChannels", + "title": "listSalesChannels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/sales-channel/restoreSalesChannels", + "title": "restoreSalesChannels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/sales-channel/retrieveSalesChannel", + "title": "retrieveSalesChannel", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/sales-channel/softDeleteSalesChannels", + "title": "softDeleteSalesChannels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/sales-channel/updateSalesChannels", + "title": "updateSalesChannels", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/sales-channel/upsertSalesChannels", + "title": "upsertSalesChannels", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "sales-channel-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Sales Channel Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/sales-channel/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "autogenerate_path": "/references/sales_channel_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/sales-channel/models/SalesChannel", + "title": "SalesChannel", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "stock-location", + "title": "Stock Location Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/stock-location", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "autogenerate_tags": "concept+stockLocation", + "autogenerate_as_ref": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/stock-location/concepts", + "title": "Stock Location Concepts", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/stock-location/links-to-other-modules", + "title": "Links to Modules", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Inventory Kits", + "path": "https://docs.medusajs.com/resources/commerce-modules/inventory/inventory-kit", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Product Variant Inventory", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/variant-inventory", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+stockLocation", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Stock Location features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Locations & Shipping Overview", + "path": "https://docs.medusajs.com/user-guide/settings/locations-and-shipping", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Locations", + "path": "https://docs.medusajs.com/user-guide/settings/locations-and-shipping/locations", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "description": "Find references for tools and resources related to the Stock Location Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/stock-location/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+stockLocation", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createStockLocationsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createStockLocationsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteStockLocationsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteStockLocationsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateStockLocationsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateStockLocationsWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+stockLocation", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createStockLocations", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createStockLocations", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteStockLocationsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteStockLocationsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateStockLocationsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateStockLocationsStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/stock-location/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+stockLocation", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Stock Location Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "stockLocation", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/stockLocation", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/stock-location/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "stock-location-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Stock Location Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/stock_location_next/IStockLocationService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/createStockLocations", + "title": "createStockLocations", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/deleteStockLocationAddresses", + "title": "deleteStockLocationAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/deleteStockLocations", + "title": "deleteStockLocations", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/listAndCountStockLocations", + "title": "listAndCountStockLocations", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/listStockLocationAddresses", + "title": "listStockLocationAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/listStockLocations", + "title": "listStockLocations", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/restoreStockLocations", + "title": "restoreStockLocations", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/retrieveStockLocation", + "title": "retrieveStockLocation", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/softDeleteStockLocations", + "title": "softDeleteStockLocations", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/updateStockLocations", + "title": "updateStockLocations", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/upsertStockLocationAddresses", + "title": "upsertStockLocationAddresses", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/upsertStockLocations", + "title": "upsertStockLocations", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "stock-location-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Stock Location Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "autogenerate_path": "/references/stock_location_next_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/models/StockLocation", + "title": "StockLocation", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/stock-location-next/models/StockLocationAddress", + "title": "StockLocationAddress", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "store", + "title": "Store Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/store", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/store/links-to-other-modules", + "title": "Link to Modules", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+store", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Store features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Store", + "path": "https://docs.medusajs.com/user-guide/settings/store", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "description": "Find references for tools and resources related to the Store Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/store/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+store", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addOrderLineItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrderLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createDefaultsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createDefaultsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createStoresWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createStoresWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteStoresWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteStoresWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderClaimAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderEditAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderExchangeAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateStoresWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateStoresWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+store", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createDefaultStoreStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createDefaultStoreStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createStoresStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createStoresStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteStoresStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteStoresStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "findOneOrAnyRegionStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/findOneOrAnyRegionStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "findSalesChannelStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/findSalesChannelStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateStoresStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateStoresStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/store/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+store", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Store Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "store", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/store", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/store/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "store-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Store Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/store", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/store/IStoreModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/store/createStores", + "title": "createStores", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/store/deleteStores", + "title": "deleteStores", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/store/listAndCountStores", + "title": "listAndCountStores", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/store/listStores", + "title": "listStores", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/store/restoreStores", + "title": "restoreStores", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/store/retrieveStore", + "title": "retrieveStore", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/store/softDeleteStores", + "title": "softDeleteStores", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/store/updateStores", + "title": "updateStores", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/store/upsertStores", + "title": "upsertStores", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "store-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Store Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/store/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "autogenerate_path": "/references/store_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/store/models/Store", + "title": "Store", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/store/models/StoreCurrency", + "title": "StoreCurrency", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "tax", + "title": "Tax Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/tax", + "title": "Overview", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/tax/module-options", + "title": "Module Options", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Concepts", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/tax/tax-region", + "title": "Tax Region", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/tax/tax-rates-and-rules", + "title": "Tax Rates and Rules", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/tax/tax-calculation-with-provider", + "title": "Tax Calculation and Providers", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Server Guides", + "autogenerate_tags": "server+tax", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to use the Tax Module in your customizations on the Medusa application server.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Create Tax Provider", + "path": "https://docs.medusajs.com/resources/references/tax/provider", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Get Variant Price with Taxes", + "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price-with-taxes", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/provider", + "title": "Tax Provider Reference", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Storefront Guides", + "autogenerate_tags": "storefront+tax,-jsSdk", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to integrate the Tax Module's features into your storefront.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Example: Show Price with Taxes", + "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/tax-price", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+tax", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage Tax features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Tax Regions", + "path": "https://docs.medusajs.com/user-guide/settings/tax-regions", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "description": "Find references for tools and resources related to the Tax Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/tax/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+tax", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addShippingMethodToCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addShippingMethodToCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "addToCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addToCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createClaimShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createClaimShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createExchangeShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createExchangeShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderEditShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderEditShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createOrderWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createReturnShippingMethodWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createReturnShippingMethodWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createTaxRateRulesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createTaxRateRulesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createTaxRatesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createTaxRatesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createTaxRegionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createTaxRegionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteLineItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteLineItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteTaxRateRulesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteTaxRateRulesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteTaxRatesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteTaxRatesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteTaxRegionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteTaxRegionsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderClaimAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderEditAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "orderExchangeAddNewItemWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refreshCartItemsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartItemsWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "setTaxRateRulesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/setTaxRateRulesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "transferCartCustomerWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/transferCartCustomerWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateLineItemInCartWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateLineItemInCartWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateOrderTaxLinesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderTaxLinesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateTaxLinesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateTaxLinesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateTaxRatesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateTaxRatesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateTaxRegionsWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateTaxRegionsWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+tax", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createTaxRateRulesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createTaxRateRulesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createTaxRatesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createTaxRatesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createTaxRegionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createTaxRegionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteTaxRateRulesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteTaxRateRulesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteTaxRatesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteTaxRatesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteTaxRegionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteTaxRegionsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "getItemTaxLinesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/getItemTaxLinesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "listTaxRateRuleIdsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/listTaxRateRuleIdsStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateTaxRatesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateTaxRatesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateTaxRegionsStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateTaxRegionsStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/tax/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+tax", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the Tax Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "taxRate", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/taxRate", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "taxRegion", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/taxRegion", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/tax/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "tax-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "Tax Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/tax/ITaxModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/createTaxRateRules", + "title": "createTaxRateRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/createTaxRates", + "title": "createTaxRates", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/createTaxRegions", + "title": "createTaxRegions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/deleteTaxRateRules", + "title": "deleteTaxRateRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/deleteTaxRates", + "title": "deleteTaxRates", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/deleteTaxRegions", + "title": "deleteTaxRegions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/getTaxLines", + "title": "getTaxLines", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/listAndCountTaxRates", + "title": "listAndCountTaxRates", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/listTaxRateRules", + "title": "listTaxRateRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/listTaxRates", + "title": "listTaxRates", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/listTaxRegions", + "title": "listTaxRegions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/restoreTaxRateRules", + "title": "restoreTaxRateRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/restoreTaxRates", + "title": "restoreTaxRates", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/restoreTaxRegions", + "title": "restoreTaxRegions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/retrieveTaxRate", + "title": "retrieveTaxRate", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/softDeleteTaxRateRules", + "title": "softDeleteTaxRateRules", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/softDeleteTaxRates", + "title": "softDeleteTaxRates", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/softDeleteTaxRegions", + "title": "softDeleteTaxRegions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/updateTaxRates", + "title": "updateTaxRates", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/updateTaxRegions", + "title": "updateTaxRegions", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/upsertTaxRates", + "title": "upsertTaxRates", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "tax-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "Tax Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "autogenerate_path": "/references/tax_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/models/TaxProvider", + "title": "TaxProvider", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/models/TaxRate", + "title": "TaxRate", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/models/TaxRateRule", + "title": "TaxRateRule", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/tax/models/TaxRegion", + "title": "TaxRegion", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "user", + "title": "User Module", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/user", + "title": "Overview", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/user/module-options", + "title": "Module Options", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Server Guides", + "autogenerate_tags": "server+user", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to use the User Module in your customizations on the Medusa application server.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/user/user-creation-flows", + "title": "User Creation Flows", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin User Guides", + "autogenerate_tags": "userGuide+user", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "description": "Learn how to utilize and manage User features in the Medusa Admin dashboard.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Invites", + "path": "https://docs.medusajs.com/user-guide/settings/users/invites", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Profile", + "path": "https://docs.medusajs.com/user-guide/settings/profile", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Manage Users", + "path": "https://docs.medusajs.com/user-guide/settings/users", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "Reset Password", + "path": "https://docs.medusajs.com/user-guide/reset-password", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "description": "Find references for tools and resources related to the User Module, such as data models, methods, and more. These are useful for your customizations.", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/user/workflows", + "title": "Workflows", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflows", + "autogenerate_tags": "workflow+user", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "acceptInviteWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/acceptInviteWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createInvitesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createInvitesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createUserAccountWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createUserAccountWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createUsersWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createUsersWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteInvitesWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteInvitesWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteUsersWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteUsersWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refreshInviteTokensWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshInviteTokensWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "removeUserAccountWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeUserAccountWorkflow", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateUsersWorkflow", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateUsersWorkflow", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_tags": "step+user", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createInviteStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createInviteStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "createUsersStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createUsersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteInvitesStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteInvitesStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "deleteUsersStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteUsersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "refreshInviteTokensStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/refreshInviteTokensStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "updateUsersStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateUsersStep", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "validateTokenStep", + "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateTokenStep", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/user/js-sdk", + "title": "JS SDK", + "hideChildren": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Admin", + "autogenerate_tags": "jsSdk+admin+user", + "description": "The following methods or properties are used to send requests to Admin API Routes related to the User Module.", + "autogenerate_as_ref": true, + "sort_sidebar": "alphabetize", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "invite", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/invite", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "ref", + "title": "user", + "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/user", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/user/events", + "title": "Events Reference", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/user/admin-widget-zones", + "title": "Admin Widget Zones", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "user-service-reference", + "title": "Main Service Reference", + "childSidebarTitle": "User Module's Main Service Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/references/user/IUserModuleService/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/createInvites", + "title": "createInvites", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/createUsers", + "title": "createUsers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/deleteInvites", + "title": "deleteInvites", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/deleteUsers", + "title": "deleteUsers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/listAndCountInvites", + "title": "listAndCountInvites", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/listAndCountUsers", + "title": "listAndCountUsers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/listInvites", + "title": "listInvites", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/listUsers", + "title": "listUsers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/refreshInviteTokens", + "title": "refreshInviteTokens", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/restoreInvites", + "title": "restoreInvites", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/restoreUsers", + "title": "restoreUsers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/retrieveInvite", + "title": "retrieveInvite", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/retrieveUser", + "title": "retrieveUser", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/softDeleteInvites", + "title": "softDeleteInvites", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/softDeleteUsers", + "title": "softDeleteUsers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/updateInvites", + "title": "updateInvites", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/updateUsers", + "title": "updateUsers", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/validateInviteToken", + "title": "validateInviteToken", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "user-models-reference", + "title": "Data Models Reference", + "childSidebarTitle": "User Module Data Models Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/models", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Data Models", + "hasTitleStyling": true, + "autogenerate_path": "/references/user_models/variables", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/models/Invite", + "title": "Invite", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/user/models/User", + "title": "User", + "description": "", + "children": [] + } + ] + } + ] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "architectural-modules", + "title": "Architectural Modules", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Cache Modules", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/cache", + "title": "Overview", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/cache/in-memory", + "title": "In-Memory", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/cache/redis", + "title": "Redis", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Guides", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/cache/create", + "title": "Create Cache Module", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Event Modules", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/event", + "title": "Overview", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/event/local", + "title": "Local", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/event/redis", + "title": "Redis", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Guides", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/event/create", + "title": "Create Event Module", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "File Module Providers", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/file", + "title": "Overview", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/file/local", + "title": "Local", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/file/s3", + "title": "AWS S3 (and Compatible APIs)", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Guides", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/file-provider-module", + "title": "Create File Provider", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Notification Module Providers", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/notification", + "title": "Overview", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/notification/local", + "title": "Local", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/notification/sendgrid", + "title": "SendGrid", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Guides", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/notification-provider-module", + "title": "Create Notification Provider", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/integrations/guides/resend", + "title": "Integrate Resend", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/notification/send-notification", + "title": "Send Notification", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Workflow Engine Modules", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/workflow-engine", + "title": "Overview", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/workflow-engine/in-memory", + "title": "In-Memory", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/workflow-engine/redis", + "title": "Redis", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "integrations", + "title": "Integrations", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/integrations", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Auth", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/auth-providers/google", + "title": "Google", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/auth/auth-providers/github", + "title": "GitHub", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "CMS", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/integrations/guides/sanity", + "title": "Sanity", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "File", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/file/s3", + "title": "AWS", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Fulfillment", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/integrations/guides/shipstation", + "title": "ShipStation", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Notification", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/architectural-modules/notification/sendgrid", + "title": "SendGrid", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/integrations/guides/resend", + "title": "Resend", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Payment", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/commerce-modules/payment/payment-provider/stripe", + "title": "Stripe", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "plugins", + "title": "Plugins", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Overview", + "path": "/plugins", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "storefront-development", + "title": "Storefront Development", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "General", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/tips", + "title": "Tips", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/publishable-api-keys", + "title": "Publishable API Key", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Examples", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/guides/express-checkout", + "title": "Express Checkout Storefront", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Regions", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/regions", + "title": "Overview", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/regions/list", + "title": "List Regions", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/regions/store-retrieve-region", + "title": "Store and Retrieve Regions", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/regions/context", + "title": "Region React Context", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Products", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/products/list", + "title": "List Products", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/products/retrieve", + "title": "Retrieve a Product", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/products/variants", + "title": "Select a Variant", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/products/price", + "title": "Retrieve Variant Prices", + "autogenerate_path": "storefront-development/products/price/examples", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/products/price/examples/show-price", + "title": "Example: Show Variant's Price", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/products/price/examples/sale-price", + "title": "Example: Show Sale Price", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/products/price/examples/tax-price", + "title": "Example: Show Price with Taxes", + "description": "", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/products/inventory", + "title": "Retrieve Variant Inventory", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Product Categories", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/products/categories/list", + "title": "List Categories", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/products/categories/retrieve", + "title": "Retrieve a Category", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/products/categories/products", + "title": "Retrieve a Category's Products", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/products/categories/nested-categories", + "title": "Retrieve Nested Categories", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Product Collections", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/products/collections/list", + "title": "List Collections", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/products/collections/retrieve", + "title": "Retrieve a Collection", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/products/collections/products", + "title": "Retrieve a Collection's Products", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Carts", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/cart/create", + "title": "Create Cart", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/cart/retrieve", + "title": "Retrieve Cart", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/cart/context", + "title": "Cart React Context", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/cart/update", + "title": "Update Cart", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/cart/manage-items", + "title": "Manage Line Items", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Checkout", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/checkout", + "title": "Overview", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/checkout/email", + "title": "1. Enter Email", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/checkout/address", + "title": "2. Set Address", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/checkout/shipping", + "title": "3. Choose Shipping Method", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/checkout/payment", + "title": "4. Choose Payment Provider", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/checkout/payment/stripe", + "title": "Example: Stripe", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/checkout/complete-cart", + "title": "5. Complete Cart", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Customers", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/customers/register", + "title": "Register Customer", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/customers/login", + "title": "Login Customer", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/customers/third-party-login", + "title": "Third-Party (Social) Login", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/customers/reset-password", + "title": "Reset Password", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/customers/retrieve", + "title": "Retrieve Customer", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/customers/context", + "title": "Customer React Context", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/customers/profile", + "title": "Edit Customer Profile", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/customers/addresses", + "title": "Manage Customer Addresses", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/storefront-development/customers/log-out", + "title": "Log-out Customer", + "children": [] + } + ] + } + ] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "SDKs and Tools", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/create-medusa-app", + "title": "create-medusa-app", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "medusa-cli", + "title": "Medusa CLI", + "childSidebarTitle": "Medusa CLI Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/medusa-cli", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Commands", + "autogenerate_path": "medusa-cli/commands", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/medusa-cli/commands/new", + "title": "new", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/medusa-cli/commands/develop", + "title": "develop", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/medusa-cli/commands/start", + "title": "start", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/medusa-cli/commands/user", + "title": "user", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/medusa-cli/commands/build", + "title": "build", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/medusa-cli/commands/db", + "title": "db", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/medusa-cli/commands/plugin", + "title": "plugin", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/medusa-cli/commands/exec", + "title": "exec", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/medusa-cli/commands/start-cluster", + "title": "start-cluster", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/medusa-cli/commands/telemtry", + "title": "telemetry", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "js-sdk", + "title": "JS SDK", + "childSidebarTitle": "JS SDK Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/js-sdk", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Auth", + "autogenerate_path": "/references/js_sdk/auth/Auth/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/auth/callback", + "title": "callback", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/auth/login", + "title": "login", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/auth/logout", + "title": "logout", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/auth/refresh", + "title": "refresh", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/auth/register", + "title": "register", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/auth/resetPassword", + "title": "resetPassword", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/auth/updateProvider", + "title": "updateProvider", + "description": "", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Store", + "autogenerate_path": "/references/js_sdk/store/Store/properties", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/store/cart", + "title": "cart", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/store/category", + "title": "category", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/store/collection", + "title": "collection", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/store/customer", + "title": "customer", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/store/fulfillment", + "title": "fulfillment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/store/order", + "title": "order", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/store/payment", + "title": "payment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/store/product", + "title": "product", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/store/region", + "title": "region", + "description": "", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin", + "autogenerate_path": "/references/js_sdk/admin/Admin/properties", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/apiKey", + "title": "apiKey", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/campaign", + "title": "campaign", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/claim", + "title": "claim", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/currency", + "title": "currency", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/customer", + "title": "customer", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/customerGroup", + "title": "customerGroup", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/draftOrder", + "title": "draftOrder", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/exchange", + "title": "exchange", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/fulfillment", + "title": "fulfillment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/fulfillmentProvider", + "title": "fulfillmentProvider", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/fulfillmentSet", + "title": "fulfillmentSet", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/inventoryItem", + "title": "inventoryItem", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/invite", + "title": "invite", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/notification", + "title": "notification", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/order", + "title": "order", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/orderEdit", + "title": "orderEdit", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/payment", + "title": "payment", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/paymentCollection", + "title": "paymentCollection", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/priceList", + "title": "priceList", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/pricePreference", + "title": "pricePreference", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/product", + "title": "product", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/productCategory", + "title": "productCategory", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/productCollection", + "title": "productCollection", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/productTag", + "title": "productTag", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/productType", + "title": "productType", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/productVariant", + "title": "productVariant", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/promotion", + "title": "promotion", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/refundReason", + "title": "refundReason", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/region", + "title": "region", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/reservation", + "title": "reservation", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/return", + "title": "return", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/returnReason", + "title": "returnReason", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/salesChannel", + "title": "salesChannel", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/shippingOption", + "title": "shippingOption", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/shippingProfile", + "title": "shippingProfile", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/stockLocation", + "title": "stockLocation", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/store", + "title": "store", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/taxRate", + "title": "taxRate", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/taxRegion", + "title": "taxRegion", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/upload", + "title": "upload", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/user", + "title": "user", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/js-sdk/admin/workflowExecution", + "title": "workflowExecution", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "nextjs-starter", + "title": "Next.js Starter Storefront", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/nextjs-starter", + "title": "Overview", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Payment", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/nextjs-starter/guides/customize-stripe", + "title": "Customize Stripe Integration", + "children": [] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "General", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "troubleshooting", + "title": "Troubleshooting", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/troubleshooting", + "title": "Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Installation", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/troubleshooting/create-medusa-app-errors", + "title": "Create Medusa App Errors", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/troubleshooting/errors-installing-cli", + "title": "Errors Installing CLI", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/troubleshooting/general-errors", + "title": "General Errors", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Medusa Application", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/troubleshooting/eaddrinuse", + "title": "EADDRINUSE Error", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/troubleshooting/database-errors", + "title": "Database Errors", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/troubleshooting/dist-imports", + "title": "Importing from /dist", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/troubleshooting/workflow-errors", + "title": "Workflow Errors", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/troubleshooting/test-errors", + "title": "Test Errors", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin Development", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/troubleshooting/medusa-admin/no-widget-route", + "title": "Widget or Route not Showing", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Upgrade", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/troubleshooting/errors-after-upgrading", + "title": "Errors After Upgrading", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Frontend", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/troubleshooting/cors-errors", + "title": "CORS Errors", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Integrations", + "hasTitleStyling": true, + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/troubleshooting/s3", + "title": "S3 Module Provider Errors", + "children": [] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Admin", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/admin-widget-injection-zones", + "title": "Admin Widget Injection Zones", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Lists", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/medusa-container-resources", + "title": "Container Dependencies", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/events-reference", + "title": "Events List", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "References", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "workflows-sdk-reference", + "title": "Workflows SDK", + "childSidebarTitle": "Workflows SDK Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/workflows", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Functions", + "autogenerate_path": "/references/workflows/functions", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/workflows/createHook", + "title": "createHook", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/workflows/createStep", + "title": "createStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/workflows/createWorkflow", + "title": "createWorkflow", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/workflows/parallelize", + "title": "parallelize", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/workflows/transform", + "title": "transform", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "dml-reference", + "title": "Data Model Language", + "childSidebarTitle": "Data Model Language Reference", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/define", + "title": "Define Method", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Property Types", + "autogenerate_path": "/references/dml/Property_Types/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-types/array", + "title": "array", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-types/bignumber", + "title": "bigNumber", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-types/boolean", + "title": "boolean", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-types/datetime", + "title": "dateTime", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-types/enum", + "title": "enum", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-types/float", + "title": "float", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-types/id", + "title": "id", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-types/json", + "title": "json", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-types/number", + "title": "number", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-types/text", + "title": "text", + "description": "", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Relationship Methods", + "autogenerate_path": "/references/dml/Relationship_Methods/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/relationship-methods/belongsto", + "title": "belongsTo", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/relationship-methods/hasmany", + "title": "hasMany", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/relationship-methods/hasone", + "title": "hasOne", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/relationship-methods/manytomany", + "title": "manyToMany", + "description": "", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Model Methods", + "autogenerate_path": "/references/dml/Model_Methods/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/model-methods/cascades", + "title": "cascades", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/model-methods/indexes", + "title": "indexes", + "description": "", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Property Configuration Methods", + "autogenerate_path": "/references/dml/Property_Configuration_Methods/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-configuration/computed", + "title": "computed", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-configuration/default", + "title": "default", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-configuration/index", + "title": "index", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-configuration/nullable", + "title": "nullable", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/data-model/property-configuration/unique", + "title": "unique", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "service-factory-reference", + "title": "Service Factory", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/service-factory-reference", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Methods", + "autogenerate_path": "/service-factory-reference/methods", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/service-factory-reference/methods/create", + "title": "create", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/service-factory-reference/methods/delete", + "title": "delete", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/service-factory-reference/methods/list", + "title": "list", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/service-factory-reference/methods/listAndCount", + "title": "listAndCount", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/service-factory-reference/methods/restore", + "title": "restore", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/service-factory-reference/methods/retrieve", + "title": "retrieve", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/service-factory-reference/methods/soft-delete", + "title": "softDelete", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/service-factory-reference/methods/update", + "title": "update", + "description": "", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Tips", + "autogenerate_path": "/service-factory-reference/tips", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/service-factory-reference/tips/filtering", + "title": "Filtering", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "helper-steps-reference", + "title": "Helper Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/helper-steps", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Steps", + "autogenerate_path": "/references/helper_steps/functions", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/helper-steps/createRemoteLinkStep", + "title": "createRemoteLinkStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/helper-steps/dismissRemoteLinkStep", + "title": "dismissRemoteLinkStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/helper-steps/emitEventStep", + "title": "emitEventStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/helper-steps/removeRemoteLinkStep", + "title": "removeRemoteLinkStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/helper-steps/updateRemoteLinksStep", + "title": "updateRemoteLinksStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/helper-steps/useQueryGraphStep", + "title": "useQueryGraphStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/helper-steps/useRemoteQueryStep", + "title": "useRemoteQueryStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/helper-steps/validatePresenceOfStep", + "title": "validatePresenceOfStep", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "core-flows", + "title": "Core Workflows", + "custom_autogenerate": "core-flows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "Overview", + "path": "/medusa-workflows-reference", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Api Key", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createApiKeysWorkflow", + "title": "createApiKeysWorkflow", + "description": "Create secret or publishable API keys.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteApiKeysWorkflow", + "title": "deleteApiKeysWorkflow", + "description": "Delete secret or publishable API keys.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/linkSalesChannelsToApiKeyWorkflow", + "title": "linkSalesChannelsToApiKeyWorkflow", + "description": "Manage the sales channels of a publishable API key.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/revokeApiKeysWorkflow", + "title": "revokeApiKeysWorkflow", + "description": "Revoke secret or publishable API keys.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateApiKeysWorkflow", + "title": "updateApiKeysWorkflow", + "description": "Update secret or publishable API keys.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createApiKeysStep", + "title": "createApiKeysStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteApiKeysStep", + "title": "deleteApiKeysStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/linkSalesChannelsToApiKeyStep", + "title": "linkSalesChannelsToApiKeyStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/revokeApiKeysStep", + "title": "revokeApiKeysStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateApiKeysStep", + "title": "updateApiKeysStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateSalesChannelsExistStep", + "title": "validateSalesChannelsExistStep", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Auth", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/generateResetPasswordTokenWorkflow", + "title": "generateResetPasswordTokenWorkflow", + "description": "Generate a reset password token for a user or customer.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/setAuthAppMetadataStep", + "title": "setAuthAppMetadataStep", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Cart", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/addShippingMethodToCartWorkflow", + "title": "addShippingMethodToCartWorkflow", + "description": "Add a shipping method to a cart.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/addToCartWorkflow", + "title": "addToCartWorkflow", + "description": "Add a line item to a cart.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/completeCartWorkflow", + "title": "completeCartWorkflow", + "description": "Complete a cart and place an order.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/confirmVariantInventoryWorkflow", + "title": "confirmVariantInventoryWorkflow", + "description": "Validate that a variant is in-stock before adding to the cart.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createCartCreditLinesWorkflow", + "title": "createCartCreditLinesWorkflow", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createCartWorkflow", + "title": "createCartWorkflow", + "description": "Create a cart specifying region, items, and more.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createPaymentCollectionForCartWorkflow", + "title": "createPaymentCollectionForCartWorkflow", + "description": "Create payment collection for cart.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteCartCreditLinesWorkflow", + "title": "deleteCartCreditLinesWorkflow", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/listShippingOptionsForCartWithPricingWorkflow", + "title": "listShippingOptionsForCartWithPricingWorkflow", + "description": "List a cart's shipping options with prices.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/listShippingOptionsForCartWorkflow", + "title": "listShippingOptionsForCartWorkflow", + "description": "List a cart's shipping options.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/refreshCartItemsWorkflow", + "title": "refreshCartItemsWorkflow", + "description": "Refresh a cart's details after an update.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/refreshCartShippingMethodsWorkflow", + "title": "refreshCartShippingMethodsWorkflow", + "description": "Refresh a cart's shipping methods after an update.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/refreshPaymentCollectionForCartWorkflow", + "title": "refreshPaymentCollectionForCartWorkflow", + "description": "Refresh a cart's payment collection details.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/transferCartCustomerWorkflow", + "title": "transferCartCustomerWorkflow", + "description": "Refresh a cart's payment collection details.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateCartPromotionsWorkflow", + "title": "updateCartPromotionsWorkflow", + "description": "Update a cart's applied promotions to add, replace, or remove them.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateCartWorkflow", + "title": "updateCartWorkflow", + "description": "Update a cart's details, such as region, address, and more.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateLineItemInCartWorkflow", + "title": "updateLineItemInCartWorkflow", + "description": "Update a cart's line item.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateTaxLinesWorkflow", + "title": "updateTaxLinesWorkflow", + "description": "Update a cart's tax lines.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/addShippingMethodToCartStep", + "title": "addShippingMethodToCartStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/confirmInventoryStep", + "title": "confirmInventoryStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createCartsStep", + "title": "createCartsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createLineItemAdjustmentsStep", + "title": "createLineItemAdjustmentsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createLineItemsStep", + "title": "createLineItemsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createPaymentCollectionsStep", + "title": "createPaymentCollectionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createShippingMethodAdjustmentsStep", + "title": "createShippingMethodAdjustmentsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/findOneOrAnyRegionStep", + "title": "findOneOrAnyRegionStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/findOrCreateCustomerStep", + "title": "findOrCreateCustomerStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/findSalesChannelStep", + "title": "findSalesChannelStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/getActionsToComputeFromPromotionsStep", + "title": "getActionsToComputeFromPromotionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/getLineItemActionsStep", + "title": "getLineItemActionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/getPromotionCodesToApply", + "title": "getPromotionCodesToApply", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/getVariantPriceSetsStep", + "title": "getVariantPriceSetsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/getVariantsStep", + "title": "getVariantsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/prepareAdjustmentsFromPromotionActionsStep", + "title": "prepareAdjustmentsFromPromotionActionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/removeLineItemAdjustmentsStep", + "title": "removeLineItemAdjustmentsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/removeShippingMethodAdjustmentsStep", + "title": "removeShippingMethodAdjustmentsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/removeShippingMethodFromCartStep", + "title": "removeShippingMethodFromCartStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/reserveInventoryStep", + "title": "reserveInventoryStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/retrieveCartStep", + "title": "retrieveCartStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/setTaxLinesForItemsStep", + "title": "setTaxLinesForItemsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateCartPromotionsStep", + "title": "updateCartPromotionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateCartsStep", + "title": "updateCartsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateLineItemsStep", + "title": "updateLineItemsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateShippingMethodsStep", + "title": "updateShippingMethodsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateAndReturnShippingMethodsDataStep", + "title": "validateAndReturnShippingMethodsDataStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateCartPaymentsStep", + "title": "validateCartPaymentsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateCartShippingOptionsPriceStep", + "title": "validateCartShippingOptionsPriceStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateCartShippingOptionsStep", + "title": "validateCartShippingOptionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateCartStep", + "title": "validateCartStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateLineItemPricesStep", + "title": "validateLineItemPricesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateShippingStep", + "title": "validateShippingStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateVariantPricesStep", + "title": "validateVariantPricesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/validateExistingPaymentCollectionStep", + "title": "validateExistingPaymentCollectionStep", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Common", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/batchLinksWorkflow", + "title": "batchLinksWorkflow", + "description": "Manage links between two records of linked data models.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createLinksWorkflow", + "title": "createLinksWorkflow", + "description": "Create links between two records of linked data models.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/dismissLinksWorkflow", + "title": "dismissLinksWorkflow", + "description": "Dismiss links between two records of linked data models.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateLinksWorkflow", + "title": "updateLinksWorkflow", + "description": "Update links between two records of linked data models.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createRemoteLinkStep", + "title": "createRemoteLinkStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/dismissRemoteLinkStep", + "title": "dismissRemoteLinkStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/emitEventStep", + "title": "emitEventStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/removeRemoteLinkStep", + "title": "removeRemoteLinkStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateRemoteLinksStep", + "title": "updateRemoteLinksStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/useQueryGraphStep", + "title": "useQueryGraphStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/useRemoteQueryStep", + "title": "useRemoteQueryStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validatePresenceOfStep", + "title": "validatePresenceOfStep", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Customer", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createCustomerAccountWorkflow", + "title": "createCustomerAccountWorkflow", + "description": "Create or register a customer account.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createCustomerAddressesWorkflow", + "title": "createCustomerAddressesWorkflow", + "description": "Create one or more customer addresses.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createCustomersWorkflow", + "title": "createCustomersWorkflow", + "description": "Create one or more customers.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteCustomerAddressesWorkflow", + "title": "deleteCustomerAddressesWorkflow", + "description": "Delete one or more customer addresses.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteCustomersWorkflow", + "title": "deleteCustomersWorkflow", + "description": "Delete one or more customers.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeCustomerAccountWorkflow", + "title": "removeCustomerAccountWorkflow", + "description": "Delete a customer account and its auth identity association.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateCustomerAddressesWorkflow", + "title": "updateCustomerAddressesWorkflow", + "description": "Update one or more customer addresses.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateCustomersWorkflow", + "title": "updateCustomersWorkflow", + "description": "Update one or more customers.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createCustomerAddressesStep", + "title": "createCustomerAddressesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createCustomersStep", + "title": "createCustomersStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteCustomerAddressesStep", + "title": "deleteCustomerAddressesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteCustomersStep", + "title": "deleteCustomersStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/maybeUnsetDefaultBillingAddressesStep", + "title": "maybeUnsetDefaultBillingAddressesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/maybeUnsetDefaultShippingAddressesStep", + "title": "maybeUnsetDefaultShippingAddressesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateCustomerAddressesStep", + "title": "updateCustomerAddressesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateCustomersStep", + "title": "updateCustomersStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateCustomerAccountCreation", + "title": "validateCustomerAccountCreation", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Customer Group", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createCustomerGroupsWorkflow", + "title": "createCustomerGroupsWorkflow", + "description": "Create one or more customer groups.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteCustomerGroupsWorkflow", + "title": "deleteCustomerGroupsWorkflow", + "description": "Delete one or more customer groups.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/linkCustomerGroupsToCustomerWorkflow", + "title": "linkCustomerGroupsToCustomerWorkflow", + "description": "Manage groups of a customer.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/linkCustomersToCustomerGroupWorkflow", + "title": "linkCustomersToCustomerGroupWorkflow", + "description": "Manage the customers of a customer group.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateCustomerGroupsWorkflow", + "title": "updateCustomerGroupsWorkflow", + "description": "Update one or more customer groups.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createCustomerGroupsStep", + "title": "createCustomerGroupsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteCustomerGroupStep", + "title": "deleteCustomerGroupStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/linkCustomerGroupsToCustomerStep", + "title": "linkCustomerGroupsToCustomerStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/linkCustomersToCustomerGroupStep", + "title": "linkCustomersToCustomerGroupStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateCustomerGroupsStep", + "title": "updateCustomerGroupsStep", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Defaults", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createDefaultsWorkflow", + "title": "createDefaultsWorkflow", + "description": "Create default data for a Medusa application.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createDefaultStoreStep", + "title": "createDefaultStoreStep", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "File", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteFilesWorkflow", + "title": "deleteFilesWorkflow", + "description": "Delete files from the database and storage.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/uploadFilesWorkflow", + "title": "uploadFilesWorkflow", + "description": "Upload files using the installed File Module Provider.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteFilesStep", + "title": "deleteFilesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/uploadFilesStep", + "title": "uploadFilesStep", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Fulfillment", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/batchShippingOptionRulesWorkflow", + "title": "batchShippingOptionRulesWorkflow", + "description": "Manage shipping option rules.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/calculateShippingOptionsPricesWorkflow", + "title": "calculateShippingOptionsPricesWorkflow", + "description": "Calculate shipping option prices in a cart.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelFulfillmentWorkflow", + "title": "cancelFulfillmentWorkflow", + "description": "Cancel a fulfillment.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createFulfillmentWorkflow", + "title": "createFulfillmentWorkflow", + "description": "Create a fulfillment.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createReturnFulfillmentWorkflow", + "title": "createReturnFulfillmentWorkflow", + "description": "Create a fulfillment for a return.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createServiceZonesWorkflow", + "title": "createServiceZonesWorkflow", + "description": "Create one or more service zones.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createShipmentWorkflow", + "title": "createShipmentWorkflow", + "description": "Create a shipment for a fulfillment.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createShippingOptionsWorkflow", + "title": "createShippingOptionsWorkflow", + "description": "Create shipping options.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createShippingProfilesWorkflow", + "title": "createShippingProfilesWorkflow", + "description": "Create one or more shipping profiles.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteFulfillmentSetsWorkflow", + "title": "deleteFulfillmentSetsWorkflow", + "description": "Delete one or more fulfillment sets.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteServiceZonesWorkflow", + "title": "deleteServiceZonesWorkflow", + "description": "Delete one or more service zones.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteShippingOptionsWorkflow", + "title": "deleteShippingOptionsWorkflow", + "description": "Delete one or more shipping options.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/markFulfillmentAsDeliveredWorkflow", + "title": "markFulfillmentAsDeliveredWorkflow", + "description": "Mark a fulfillment as delivered.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateFulfillmentWorkflow", + "title": "updateFulfillmentWorkflow", + "description": "Update a fulfillment.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateServiceZonesWorkflow", + "title": "updateServiceZonesWorkflow", + "description": "Update one or more service zones.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateShippingOptionsWorkflow", + "title": "updateShippingOptionsWorkflow", + "description": "Update one or more shipping options.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateShippingProfilesWorkflow", + "title": "updateShippingProfilesWorkflow", + "description": "Update one or more shipping profiles.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/buildPriceSet", + "title": "buildPriceSet", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/calculateShippingOptionsPricesStep", + "title": "calculateShippingOptionsPricesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/cancelFulfillmentStep", + "title": "cancelFulfillmentStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createFulfillmentSets", + "title": "createFulfillmentSets", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createFulfillmentStep", + "title": "createFulfillmentStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createReturnFulfillmentStep", + "title": "createReturnFulfillmentStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createServiceZonesStep", + "title": "createServiceZonesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createShippingOptionRulesStep", + "title": "createShippingOptionRulesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createShippingOptionsPriceSetsStep", + "title": "createShippingOptionsPriceSetsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createShippingProfilesStep", + "title": "createShippingProfilesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteFulfillmentSetsStep", + "title": "deleteFulfillmentSetsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteServiceZonesStep", + "title": "deleteServiceZonesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteShippingOptionRulesStep", + "title": "deleteShippingOptionRulesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteShippingOptionsStep", + "title": "deleteShippingOptionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/setShippingOptionsPricesStep", + "title": "setShippingOptionsPricesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateFulfillmentStep", + "title": "updateFulfillmentStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateServiceZonesStep", + "title": "updateServiceZonesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateShippingOptionRulesStep", + "title": "updateShippingOptionRulesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateShippingProfilesStep", + "title": "updateShippingProfilesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/upsertShippingOptionsStep", + "title": "upsertShippingOptionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateShipmentStep", + "title": "validateShipmentStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateShippingOptionPricesStep", + "title": "validateShippingOptionPricesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/validateFulfillmentDeliverabilityStep", + "title": "validateFulfillmentDeliverabilityStep", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Inventory", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/batchInventoryItemLevelsWorkflow", + "title": "batchInventoryItemLevelsWorkflow", + "description": "Manage inventory levels in bulk.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/bulkCreateDeleteLevelsWorkflow", + "title": "bulkCreateDeleteLevelsWorkflow", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createInventoryItemsWorkflow", + "title": "createInventoryItemsWorkflow", + "description": "Create one or more inventory items.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createInventoryLevelsWorkflow", + "title": "createInventoryLevelsWorkflow", + "description": "Create one or more inventory levels.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteInventoryItemWorkflow", + "title": "deleteInventoryItemWorkflow", + "description": "Delete one or more inventory items.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteInventoryLevelsWorkflow", + "title": "deleteInventoryLevelsWorkflow", + "description": "Delete one or more inventory levels.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateInventoryItemsWorkflow", + "title": "updateInventoryItemsWorkflow", + "description": "Update one or more inventory items.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateInventoryLevelsWorkflow", + "title": "updateInventoryLevelsWorkflow", + "description": "Update one or more inventory levels.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/adjustInventoryLevelsStep", + "title": "adjustInventoryLevelsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/attachInventoryItemToVariants", + "title": "attachInventoryItemToVariants", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createInventoryItemsStep", + "title": "createInventoryItemsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createInventoryLevelsStep", + "title": "createInventoryLevelsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteInventoryItemStep", + "title": "deleteInventoryItemStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteInventoryLevelsStep", + "title": "deleteInventoryLevelsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateInventoryItemsStep", + "title": "updateInventoryItemsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateInventoryLevelsStep", + "title": "updateInventoryLevelsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateInventoryDeleteStep", + "title": "validateInventoryDeleteStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateInventoryItemsForCreate", + "title": "validateInventoryItemsForCreate", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateInventoryLocationsStep", + "title": "validateInventoryLocationsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/validateInventoryLevelsDelete", + "title": "validateInventoryLevelsDelete", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Invite", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/acceptInviteWorkflow", + "title": "acceptInviteWorkflow", + "description": "Accept invite and create user.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createInvitesWorkflow", + "title": "createInvitesWorkflow", + "description": "Create one or more user invites.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteInvitesWorkflow", + "title": "deleteInvitesWorkflow", + "description": "Delete one or more user invites.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/refreshInviteTokensWorkflow", + "title": "refreshInviteTokensWorkflow", + "description": "Refresh user invite tokens.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createInviteStep", + "title": "createInviteStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteInvitesStep", + "title": "deleteInvitesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/refreshInviteTokensStep", + "title": "refreshInviteTokensStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateTokenStep", + "title": "validateTokenStep", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Line Item", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteLineItemsWorkflow", + "title": "deleteLineItemsWorkflow", + "description": "Delete line items from a cart.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteLineItemsStep", + "title": "deleteLineItemsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/listLineItemsStep", + "title": "listLineItemsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateLineItemsStepWithSelector", + "title": "updateLineItemsStepWithSelector", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Notification", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/notifyOnFailureStep", + "title": "notifyOnFailureStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/sendNotificationsStep", + "title": "sendNotificationsStep", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Order", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/acceptOrderTransferWorkflow", + "title": "acceptOrderTransferWorkflow", + "description": "Accept an order transfer request.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/addOrderLineItemsWorkflow", + "title": "addOrderLineItemsWorkflow", + "description": "Add line items to an order.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/archiveOrderWorkflow", + "title": "archiveOrderWorkflow", + "description": "Archive one or more orders.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/beginClaimOrderWorkflow", + "title": "beginClaimOrderWorkflow", + "description": "Create an order claim in requested state.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/beginExchangeOrderWorkflow", + "title": "beginExchangeOrderWorkflow", + "description": "Request an order exchange.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/beginOrderEditOrderWorkflow", + "title": "beginOrderEditOrderWorkflow", + "description": "Create an order edit request.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/beginReceiveReturnWorkflow", + "title": "beginReceiveReturnWorkflow", + "description": "Request a return receival.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/beginReturnOrderWorkflow", + "title": "beginReturnOrderWorkflow", + "description": "Create a return for an order.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelBeginOrderClaimWorkflow", + "title": "cancelBeginOrderClaimWorkflow", + "description": "Cancel a requested order claim.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelBeginOrderEditWorkflow", + "title": "cancelBeginOrderEditWorkflow", + "description": "Cancel a requested order edit.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelBeginOrderExchangeWorkflow", + "title": "cancelBeginOrderExchangeWorkflow", + "description": "Cancel a requested order exchange.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelOrderChangeWorkflow", + "title": "cancelOrderChangeWorkflow", + "description": "Cancel an order change.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelOrderClaimWorkflow", + "title": "cancelOrderClaimWorkflow", + "description": "Cancel a confirmed order claim.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelOrderExchangeWorkflow", + "title": "cancelOrderExchangeWorkflow", + "description": "Cancel an exchange for an order.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelOrderFulfillmentWorkflow", + "title": "cancelOrderFulfillmentWorkflow", + "description": "Cancel an order's fulfillment.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelOrderTransferRequestWorkflow", + "title": "cancelOrderTransferRequestWorkflow", + "description": "Cancel an order transfer request.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelOrderWorkflow", + "title": "cancelOrderWorkflow", + "description": "Cancel an order.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelReturnReceiveWorkflow", + "title": "cancelReturnReceiveWorkflow", + "description": "Cancel a return receival.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelReturnRequestWorkflow", + "title": "cancelReturnRequestWorkflow", + "description": "Cancel a requested return.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelReturnWorkflow", + "title": "cancelReturnWorkflow", + "description": "Cancel a return.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/completeOrderWorkflow", + "title": "completeOrderWorkflow", + "description": "Complete one or more orders.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/confirmClaimRequestWorkflow", + "title": "confirmClaimRequestWorkflow", + "description": "Confirm a requested claim.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/confirmExchangeRequestWorkflow", + "title": "confirmExchangeRequestWorkflow", + "description": "Confirm an exchange request.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/confirmOrderEditRequestWorkflow", + "title": "confirmOrderEditRequestWorkflow", + "description": "Confirm an order edit request.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/confirmReturnReceiveWorkflow", + "title": "confirmReturnReceiveWorkflow", + "description": "Confirm a return receival request.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/confirmReturnRequestWorkflow", + "title": "confirmReturnRequestWorkflow", + "description": "Confirm a return request.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createAndCompleteReturnOrderWorkflow", + "title": "createAndCompleteReturnOrderWorkflow", + "description": "Create and complete a return for an order.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createClaimShippingMethodWorkflow", + "title": "createClaimShippingMethodWorkflow", + "description": "Create an inbound or outbound shipping method for a claim.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createExchangeShippingMethodWorkflow", + "title": "createExchangeShippingMethodWorkflow", + "description": "Create an inbound or outbound shipping method for an exchange.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createOrUpdateOrderPaymentCollectionWorkflow", + "title": "createOrUpdateOrderPaymentCollectionWorkflow", + "description": "Create or update payment collection for an order.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createOrderChangeActionsWorkflow", + "title": "createOrderChangeActionsWorkflow", + "description": "Create an order change action.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createOrderChangeWorkflow", + "title": "createOrderChangeWorkflow", + "description": "Create an order change.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createOrderEditShippingMethodWorkflow", + "title": "createOrderEditShippingMethodWorkflow", + "description": "Create a shipping method for an order edit.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createOrderFulfillmentWorkflow", + "title": "createOrderFulfillmentWorkflow", + "description": "Creates a fulfillment for an order.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createOrderPaymentCollectionWorkflow", + "title": "createOrderPaymentCollectionWorkflow", + "description": "Create a payment collection for an order.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createOrderShipmentWorkflow", + "title": "createOrderShipmentWorkflow", + "description": "Creates a shipment for an order.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createOrderWorkflow", + "title": "createOrderWorkflow", + "description": "Create an order.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createOrdersWorkflow", + "title": "createOrdersWorkflow", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createReturnShippingMethodWorkflow", + "title": "createReturnShippingMethodWorkflow", + "description": "Create a shipping method for a return.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/declineOrderChangeWorkflow", + "title": "declineOrderChangeWorkflow", + "description": "Decline an order change.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/declineOrderTransferRequestWorkflow", + "title": "declineOrderTransferRequestWorkflow", + "description": "Decline a requested order transfer.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteOrderChangeActionsWorkflow", + "title": "deleteOrderChangeActionsWorkflow", + "description": "Delete one or more order change actions.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteOrderChangeWorkflow", + "title": "deleteOrderChangeWorkflow", + "description": "Delete one or more order changes.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/dismissItemReturnRequestWorkflow", + "title": "dismissItemReturnRequestWorkflow", + "description": "Dismiss items from a return request.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/getOrderDetailWorkflow", + "title": "getOrderDetailWorkflow", + "description": "Retrieve an order's details.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/getOrdersListWorkflow", + "title": "getOrdersListWorkflow", + "description": "Retrieve a list of orders.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/markOrderFulfillmentAsDeliveredWorkflow", + "title": "markOrderFulfillmentAsDeliveredWorkflow", + "description": "Mark a fulfillment in an order as delivered.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/orderClaimAddNewItemWorkflow", + "title": "orderClaimAddNewItemWorkflow", + "description": "Add outbound or new items to a claim.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/orderClaimItemWorkflow", + "title": "orderClaimItemWorkflow", + "description": "Add order items to a claim as claim items.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/orderClaimRequestItemReturnWorkflow", + "title": "orderClaimRequestItemReturnWorkflow", + "description": "Request one or more items to be returned as part of a claim.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/orderEditAddNewItemWorkflow", + "title": "orderEditAddNewItemWorkflow", + "description": "Add new items to an order edit.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/orderEditUpdateItemQuantityWorkflow", + "title": "orderEditUpdateItemQuantityWorkflow", + "description": "Update the quantity of an existing order item in the order's edit.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/orderExchangeAddNewItemWorkflow", + "title": "orderExchangeAddNewItemWorkflow", + "description": "Add new or outbound items to an exchange.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/orderExchangeRequestItemReturnWorkflow", + "title": "orderExchangeRequestItemReturnWorkflow", + "description": "Add inbound items to be returned as part of the exchange.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/receiveAndCompleteReturnOrderWorkflow", + "title": "receiveAndCompleteReturnOrderWorkflow", + "description": "Receive and complete a return.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/receiveItemReturnRequestWorkflow", + "title": "receiveItemReturnRequestWorkflow", + "description": "Mark return items as received.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeAddItemClaimActionWorkflow", + "title": "removeAddItemClaimActionWorkflow", + "description": "Remove outbound (new) items from a claim.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeClaimShippingMethodWorkflow", + "title": "removeClaimShippingMethodWorkflow", + "description": "Remove an inbound or outbound shipping method from a claim.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeExchangeShippingMethodWorkflow", + "title": "removeExchangeShippingMethodWorkflow", + "description": "Remove an inbound or outbound shipping method from an exchange.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeItemClaimActionWorkflow", + "title": "removeItemClaimActionWorkflow", + "description": "Remove order items from a claim.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeItemExchangeActionWorkflow", + "title": "removeItemExchangeActionWorkflow", + "description": "Remove an outbound or new item from an exchange.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeItemOrderEditActionWorkflow", + "title": "removeItemOrderEditActionWorkflow", + "description": "Remove an item that was added to an order edit.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeItemReceiveReturnActionWorkflow", + "title": "removeItemReceiveReturnActionWorkflow", + "description": "Remove an item from a return receival.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeItemReturnActionWorkflow", + "title": "removeItemReturnActionWorkflow", + "description": "Remove an item from a return.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeOrderEditShippingMethodWorkflow", + "title": "removeOrderEditShippingMethodWorkflow", + "description": "Remove a shipping method from an order edit.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeReturnShippingMethodWorkflow", + "title": "removeReturnShippingMethodWorkflow", + "description": "Remove a shipping method from a return.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/requestItemReturnWorkflow", + "title": "requestItemReturnWorkflow", + "description": "Add items to a return.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/requestOrderEditRequestWorkflow", + "title": "requestOrderEditRequestWorkflow", + "description": "Request an order edit.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/requestOrderTransferWorkflow", + "title": "requestOrderTransferWorkflow", + "description": "Request a transfer of an order to a customer.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateClaimAddItemWorkflow", + "title": "updateClaimAddItemWorkflow", + "description": "Update a claim's new or outbound item.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateClaimItemWorkflow", + "title": "updateClaimItemWorkflow", + "description": "Update a claim item, added to the claim from an order item.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateClaimShippingMethodWorkflow", + "title": "updateClaimShippingMethodWorkflow", + "description": "Update an inbound or outbound shipping method of a claim.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateExchangeAddItemWorkflow", + "title": "updateExchangeAddItemWorkflow", + "description": "Update an outbound or new item in an exchange.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateExchangeShippingMethodWorkflow", + "title": "updateExchangeShippingMethodWorkflow", + "description": "Update an exchange's inbound or outbound shipping method.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateOrderChangeActionsWorkflow", + "title": "updateOrderChangeActionsWorkflow", + "description": "Update one or more order change actions.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateOrderChangesWorkflow", + "title": "updateOrderChangesWorkflow", + "description": "Update one or more order changes.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateOrderEditAddItemWorkflow", + "title": "updateOrderEditAddItemWorkflow", + "description": "Update a new item in an order edit.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateOrderEditItemQuantityWorkflow", + "title": "updateOrderEditItemQuantityWorkflow", + "description": "Update an existing order item previously added to an order edit.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateOrderEditShippingMethodWorkflow", + "title": "updateOrderEditShippingMethodWorkflow", + "description": "Update a shipping method of an order edit.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateOrderTaxLinesWorkflow", + "title": "updateOrderTaxLinesWorkflow", + "description": "Update the tax lines of items and shipping methods in an order.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateOrderWorkflow", + "title": "updateOrderWorkflow", + "description": "Update an order's details.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateReceiveItemReturnRequestWorkflow", + "title": "updateReceiveItemReturnRequestWorkflow", + "description": "Update an item in a return receival request.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateRequestItemReturnWorkflow", + "title": "updateRequestItemReturnWorkflow", + "description": "Update a requested item in a return.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateReturnShippingMethodWorkflow", + "title": "updateReturnShippingMethodWorkflow", + "description": "Update the shipping method of a return.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateReturnWorkflow", + "title": "updateReturnWorkflow", + "description": "Update a return's details.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/addOrderTransactionStep", + "title": "addOrderTransactionStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/archiveOrdersStep", + "title": "archiveOrdersStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/cancelOrderChangeStep", + "title": "cancelOrderChangeStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/cancelOrderClaimStep", + "title": "cancelOrderClaimStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/cancelOrderExchangeStep", + "title": "cancelOrderExchangeStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/cancelOrderFulfillmentStep", + "title": "cancelOrderFulfillmentStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/cancelOrderReturnStep", + "title": "cancelOrderReturnStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/cancelOrdersStep", + "title": "cancelOrdersStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/completeOrdersStep", + "title": "completeOrdersStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createCompleteReturnStep", + "title": "createCompleteReturnStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createOrderChangeStep", + "title": "createOrderChangeStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createOrderClaimItemsFromActionsStep", + "title": "createOrderClaimItemsFromActionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createOrderClaimsStep", + "title": "createOrderClaimsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createOrderExchangeItemsFromActionsStep", + "title": "createOrderExchangeItemsFromActionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createOrderExchangesStep", + "title": "createOrderExchangesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createOrderLineItemsStep", + "title": "createOrderLineItemsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createOrdersStep", + "title": "createOrdersStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createReturnsStep", + "title": "createReturnsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/declineOrderChangeStep", + "title": "declineOrderChangeStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteClaimsStep", + "title": "deleteClaimsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteExchangesStep", + "title": "deleteExchangesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteOrderChangeActionsStep", + "title": "deleteOrderChangeActionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteOrderChangesStep", + "title": "deleteOrderChangesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteOrderLineItems", + "title": "deleteOrderLineItems", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteOrderShippingMethods", + "title": "deleteOrderShippingMethods", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteReturnsStep", + "title": "deleteReturnsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/previewOrderChangeStep", + "title": "previewOrderChangeStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/registerOrderChangesStep", + "title": "registerOrderChangesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/registerOrderFulfillmentStep", + "title": "registerOrderFulfillmentStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/registerOrderShipmentStep", + "title": "registerOrderShipmentStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/setOrderTaxLinesForItemsStep", + "title": "setOrderTaxLinesForItemsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateOrderChangeActionsStep", + "title": "updateOrderChangeActionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateOrderChangesStep", + "title": "updateOrderChangesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateOrderShippingMethodsStep", + "title": "updateOrderShippingMethodsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateOrdersStep", + "title": "updateOrdersStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateReturnItemsStep", + "title": "updateReturnItemsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateReturnsStep", + "title": "updateReturnsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/acceptOrderTransferValidationStep", + "title": "acceptOrderTransferValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/beginClaimOrderValidationStep", + "title": "beginClaimOrderValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/beginOrderEditValidationStep", + "title": "beginOrderEditValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/beginOrderExchangeValidationStep", + "title": "beginOrderExchangeValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/beginReceiveReturnValidationStep", + "title": "beginReceiveReturnValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/beginReturnOrderValidationStep", + "title": "beginReturnOrderValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelBeginOrderClaimValidationStep", + "title": "cancelBeginOrderClaimValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelBeginOrderEditValidationStep", + "title": "cancelBeginOrderEditValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelBeginOrderExchangeValidationStep", + "title": "cancelBeginOrderExchangeValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelClaimValidateOrderStep", + "title": "cancelClaimValidateOrderStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelExchangeValidateOrder", + "title": "cancelExchangeValidateOrder", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelOrderFulfillmentValidateOrder", + "title": "cancelOrderFulfillmentValidateOrder", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelReceiveReturnValidationStep", + "title": "cancelReceiveReturnValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelRequestReturnValidationStep", + "title": "cancelRequestReturnValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelReturnValidateOrder", + "title": "cancelReturnValidateOrder", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelTransferOrderRequestValidationStep", + "title": "cancelTransferOrderRequestValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/cancelValidateOrder", + "title": "cancelValidateOrder", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/confirmClaimRequestValidationStep", + "title": "confirmClaimRequestValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/confirmExchangeRequestValidationStep", + "title": "confirmExchangeRequestValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/confirmOrderEditRequestValidationStep", + "title": "confirmOrderEditRequestValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/confirmReceiveReturnValidationStep", + "title": "confirmReceiveReturnValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/confirmReturnRequestValidationStep", + "title": "confirmReturnRequestValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createClaimShippingMethodValidationStep", + "title": "createClaimShippingMethodValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createCompleteReturnValidationStep", + "title": "createCompleteReturnValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createExchangeShippingMethodValidationStep", + "title": "createExchangeShippingMethodValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createFulfillmentValidateOrder", + "title": "createFulfillmentValidateOrder", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createOrderEditShippingMethodValidationStep", + "title": "createOrderEditShippingMethodValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createReturnShippingMethodValidationStep", + "title": "createReturnShippingMethodValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createShipmentValidateOrder", + "title": "createShipmentValidateOrder", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/declineTransferOrderRequestValidationStep", + "title": "declineTransferOrderRequestValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteOrderPaymentCollections", + "title": "deleteOrderPaymentCollections", + "description": "Delete a payment collection of an order.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/dismissItemReturnRequestValidationStep", + "title": "dismissItemReturnRequestValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/exchangeAddNewItemValidationStep", + "title": "exchangeAddNewItemValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/exchangeRequestItemReturnValidationStep", + "title": "exchangeRequestItemReturnValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/markPaymentCollectionAsPaid", + "title": "markPaymentCollectionAsPaid", + "description": "Mark a payment collection for an order as paid.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/orderClaimAddNewItemValidationStep", + "title": "orderClaimAddNewItemValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/orderClaimItemValidationStep", + "title": "orderClaimItemValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/orderClaimRequestItemReturnValidationStep", + "title": "orderClaimRequestItemReturnValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/orderEditAddNewItemValidationStep", + "title": "orderEditAddNewItemValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/orderEditUpdateItemQuantityValidationStep", + "title": "orderEditUpdateItemQuantityValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/orderFulfillmentDeliverablilityValidationStep", + "title": "orderFulfillmentDeliverablilityValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/receiveCompleteReturnValidationStep", + "title": "receiveCompleteReturnValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/receiveItemReturnRequestValidationStep", + "title": "receiveItemReturnRequestValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeClaimAddItemActionValidationStep", + "title": "removeClaimAddItemActionValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeClaimItemActionValidationStep", + "title": "removeClaimItemActionValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeClaimShippingMethodValidationStep", + "title": "removeClaimShippingMethodValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeExchangeItemActionValidationStep", + "title": "removeExchangeItemActionValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeExchangeShippingMethodValidationStep", + "title": "removeExchangeShippingMethodValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeItemReceiveReturnActionValidationStep", + "title": "removeItemReceiveReturnActionValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeOrderEditItemActionValidationStep", + "title": "removeOrderEditItemActionValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeOrderEditShippingMethodValidationStep", + "title": "removeOrderEditShippingMethodValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeReturnItemActionValidationStep", + "title": "removeReturnItemActionValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeReturnShippingMethodValidationStep", + "title": "removeReturnShippingMethodValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/requestItemReturnValidationStep", + "title": "requestItemReturnValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/requestOrderEditRequestValidationStep", + "title": "requestOrderEditRequestValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/requestOrderTransferValidationStep", + "title": "requestOrderTransferValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/throwUnlessPaymentCollectionNotPaid", + "title": "throwUnlessPaymentCollectionNotPaid", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/throwUnlessStatusIsNotPaid", + "title": "throwUnlessStatusIsNotPaid", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateClaimAddItemValidationStep", + "title": "updateClaimAddItemValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateClaimItemValidationStep", + "title": "updateClaimItemValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateClaimShippingMethodValidationStep", + "title": "updateClaimShippingMethodValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateExchangeAddItemValidationStep", + "title": "updateExchangeAddItemValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateExchangeShippingMethodValidationStep", + "title": "updateExchangeShippingMethodValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateOrderEditAddItemValidationStep", + "title": "updateOrderEditAddItemValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateOrderEditItemQuantityValidationStep", + "title": "updateOrderEditItemQuantityValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateOrderEditShippingMethodValidationStep", + "title": "updateOrderEditShippingMethodValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateOrderValidationStep", + "title": "updateOrderValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateReceiveItemReturnRequestValidationStep", + "title": "updateReceiveItemReturnRequestValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateRequestItemReturnValidationStep", + "title": "updateRequestItemReturnValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateReturnShippingMethodValidationStep", + "title": "updateReturnShippingMethodValidationStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateReturnValidationStep", + "title": "updateReturnValidationStep", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Payment", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/capturePaymentWorkflow", + "title": "capturePaymentWorkflow", + "description": "Capture a payment.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/processPaymentWorkflow", + "title": "processPaymentWorkflow", + "description": "Process a payment based on a webhook event.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/refundPaymentWorkflow", + "title": "refundPaymentWorkflow", + "description": "Refund a payment.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/refundPaymentsWorkflow", + "title": "refundPaymentsWorkflow", + "description": "Refund one or more payments.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/authorizePaymentSessionStep", + "title": "authorizePaymentSessionStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/cancelPaymentStep", + "title": "cancelPaymentStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/capturePaymentStep", + "title": "capturePaymentStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/refundPaymentStep", + "title": "refundPaymentStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/refundPaymentsStep", + "title": "refundPaymentsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/validatePaymentsRefundStep", + "title": "validatePaymentsRefundStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/validateRefundStep", + "title": "validateRefundStep", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Payment Collection", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createPaymentSessionsWorkflow", + "title": "createPaymentSessionsWorkflow", + "description": "Create payment sessions.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createRefundReasonsWorkflow", + "title": "createRefundReasonsWorkflow", + "description": "Create refund reasons.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deletePaymentSessionsWorkflow", + "title": "deletePaymentSessionsWorkflow", + "description": "Delete payment sessions.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteRefundReasonsWorkflow", + "title": "deleteRefundReasonsWorkflow", + "description": "Delete refund reasons.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateRefundReasonsWorkflow", + "title": "updateRefundReasonsWorkflow", + "description": "Update refund reasons.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createPaymentAccountHolderStep", + "title": "createPaymentAccountHolderStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createPaymentSessionStep", + "title": "createPaymentSessionStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createRefundReasonStep", + "title": "createRefundReasonStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deletePaymentSessionsStep", + "title": "deletePaymentSessionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteRefundReasonsStep", + "title": "deleteRefundReasonsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updatePaymentCollectionStep", + "title": "updatePaymentCollectionStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateRefundReasonsStep", + "title": "updateRefundReasonsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateDeletedPaymentSessionsStep", + "title": "validateDeletedPaymentSessionsStep", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Price List", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/batchPriceListPricesWorkflow", + "title": "batchPriceListPricesWorkflow", + "description": "Manage a price list's prices.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createPriceListPricesWorkflow", + "title": "createPriceListPricesWorkflow", + "description": "Create prices in price lists.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createPriceListsWorkflow", + "title": "createPriceListsWorkflow", + "description": "Create one or more price lists.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deletePriceListsWorkflow", + "title": "deletePriceListsWorkflow", + "description": "Delete one or more price lists.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removePriceListPricesWorkflow", + "title": "removePriceListPricesWorkflow", + "description": "Remove prices in price lists.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updatePriceListPricesWorkflow", + "title": "updatePriceListPricesWorkflow", + "description": "Update price lists' prices.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updatePriceListsWorkflow", + "title": "updatePriceListsWorkflow", + "description": "Update one or more price lists.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createPriceListPricesStep", + "title": "createPriceListPricesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createPriceListsStep", + "title": "createPriceListsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deletePriceListsStep", + "title": "deletePriceListsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/getExistingPriceListsPriceIdsStep", + "title": "getExistingPriceListsPriceIdsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/removePriceListPricesStep", + "title": "removePriceListPricesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updatePriceListPricesStep", + "title": "updatePriceListPricesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updatePriceListsStep", + "title": "updatePriceListsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validatePriceListsStep", + "title": "validatePriceListsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/validateVariantPriceLinksStep", + "title": "validateVariantPriceLinksStep", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Pricing", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createPricePreferencesWorkflow", + "title": "createPricePreferencesWorkflow", + "description": "Create one or more price preferences.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deletePricePreferencesWorkflow", + "title": "deletePricePreferencesWorkflow", + "description": "Delete one or more price preferences.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updatePricePreferencesWorkflow", + "title": "updatePricePreferencesWorkflow", + "description": "Update one or more price preferences.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createPricePreferencesStep", + "title": "createPricePreferencesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createPriceSetsStep", + "title": "createPriceSetsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deletePricePreferencesStep", + "title": "deletePricePreferencesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updatePricePreferencesAsArrayStep", + "title": "updatePricePreferencesAsArrayStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updatePricePreferencesStep", + "title": "updatePricePreferencesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updatePriceSetsStep", + "title": "updatePriceSetsStep", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Product", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/batchLinkProductsToCategoryWorkflow", + "title": "batchLinkProductsToCategoryWorkflow", + "description": "Manage the links between a collection and products.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/batchLinkProductsToCollectionWorkflow", + "title": "batchLinkProductsToCollectionWorkflow", + "description": "Manage the links between a collection and products.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/batchProductVariantsWorkflow", + "title": "batchProductVariantsWorkflow", + "description": "Create, update, and delete product variants.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/batchProductsWorkflow", + "title": "batchProductsWorkflow", + "description": "Manage products in bulk.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createCollectionsWorkflow", + "title": "createCollectionsWorkflow", + "description": "Create one or more product collections.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createProductOptionsWorkflow", + "title": "createProductOptionsWorkflow", + "description": "Create one or more product options.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createProductTagsWorkflow", + "title": "createProductTagsWorkflow", + "description": "Create one or more product tags.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createProductTypesWorkflow", + "title": "createProductTypesWorkflow", + "description": "Create one or more product types.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createProductVariantsWorkflow", + "title": "createProductVariantsWorkflow", + "description": "Create one or more product variants.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createProductsWorkflow", + "title": "createProductsWorkflow", + "description": "Create one or more products with options and variants.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteCollectionsWorkflow", + "title": "deleteCollectionsWorkflow", + "description": "Delete one or more product collection.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteProductOptionsWorkflow", + "title": "deleteProductOptionsWorkflow", + "description": "Delete one or more product option.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteProductTagsWorkflow", + "title": "deleteProductTagsWorkflow", + "description": "Delete one or more product tags.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteProductTypesWorkflow", + "title": "deleteProductTypesWorkflow", + "description": "Delete one or more product types.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteProductVariantsWorkflow", + "title": "deleteProductVariantsWorkflow", + "description": "Delete one or more product variants.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteProductsWorkflow", + "title": "deleteProductsWorkflow", + "description": "Delete one or more products.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/exportProductsWorkflow", + "title": "exportProductsWorkflow", + "description": "Export products with filtering capabilities.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/importProductsWorkflow", + "title": "importProductsWorkflow", + "description": "Import products from a CSV file.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateCollectionsWorkflow", + "title": "updateCollectionsWorkflow", + "description": "Update one or more product collections.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateProductOptionsWorkflow", + "title": "updateProductOptionsWorkflow", + "description": "Update one or more product options.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateProductTagsWorkflow", + "title": "updateProductTagsWorkflow", + "description": "Update one or more product tags.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateProductTypesWorkflow", + "title": "updateProductTypesWorkflow", + "description": "Update one or more product types.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateProductVariantsWorkflow", + "title": "updateProductVariantsWorkflow", + "description": "Update one or more product variants.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateProductsWorkflow", + "title": "updateProductsWorkflow", + "description": "Update one or more products with options and variants.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/upsertVariantPricesWorkflow", + "title": "upsertVariantPricesWorkflow", + "description": "Create, update, or remove variants' prices.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/batchLinkProductsToCategoryStep", + "title": "batchLinkProductsToCategoryStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/batchLinkProductsToCollectionStep", + "title": "batchLinkProductsToCollectionStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createCollectionsStep", + "title": "createCollectionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createProductOptionsStep", + "title": "createProductOptionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createProductTagsStep", + "title": "createProductTagsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createProductTypesStep", + "title": "createProductTypesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createProductVariantsStep", + "title": "createProductVariantsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createProductsStep", + "title": "createProductsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createVariantPricingLinkStep", + "title": "createVariantPricingLinkStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteCollectionsStep", + "title": "deleteCollectionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteProductOptionsStep", + "title": "deleteProductOptionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteProductTagsStep", + "title": "deleteProductTagsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteProductTypesStep", + "title": "deleteProductTypesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteProductVariantsStep", + "title": "deleteProductVariantsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteProductsStep", + "title": "deleteProductsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/generateProductCsvStep", + "title": "generateProductCsvStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/getAllProductsStep", + "title": "getAllProductsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/getProductsStep", + "title": "getProductsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/getVariantAvailabilityStep", + "title": "getVariantAvailabilityStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/groupProductsForBatchStep", + "title": "groupProductsForBatchStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/parseProductCsvStep", + "title": "parseProductCsvStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateCollectionsStep", + "title": "updateCollectionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateProductOptionsStep", + "title": "updateProductOptionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateProductTagsStep", + "title": "updateProductTagsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateProductTypesStep", + "title": "updateProductTypesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateProductVariantsStep", + "title": "updateProductVariantsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateProductsStep", + "title": "updateProductsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/waitConfirmationProductImportStep", + "title": "waitConfirmationProductImportStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/validateProductInputStep", + "title": "validateProductInputStep", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Product Category", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createProductCategoriesWorkflow", + "title": "createProductCategoriesWorkflow", + "description": "Create product categories.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteProductCategoriesWorkflow", + "title": "deleteProductCategoriesWorkflow", + "description": "Delete product categories.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateProductCategoriesWorkflow", + "title": "updateProductCategoriesWorkflow", + "description": "Update product categories.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createProductCategoriesStep", + "title": "createProductCategoriesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteProductCategoriesStep", + "title": "deleteProductCategoriesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateProductCategoriesStep", + "title": "updateProductCategoriesStep", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Promotion", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/addOrRemoveCampaignPromotionsWorkflow", + "title": "addOrRemoveCampaignPromotionsWorkflow", + "description": "Manage the promotions of a campaign.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/batchPromotionRulesWorkflow", + "title": "batchPromotionRulesWorkflow", + "description": "Manage the rules of a promotion.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createCampaignsWorkflow", + "title": "createCampaignsWorkflow", + "description": "Create one or more campaigns.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createPromotionRulesWorkflow", + "title": "createPromotionRulesWorkflow", + "description": "Create one or more promotion rules.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createPromotionsWorkflow", + "title": "createPromotionsWorkflow", + "description": "Create one or more promotions.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteCampaignsWorkflow", + "title": "deleteCampaignsWorkflow", + "description": "Delete one or more campaigns.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deletePromotionRulesWorkflow", + "title": "deletePromotionRulesWorkflow", + "description": "Delete one or more promotion rules.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deletePromotionsWorkflow", + "title": "deletePromotionsWorkflow", + "description": "Delete one or more promotions.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateCampaignsWorkflow", + "title": "updateCampaignsWorkflow", + "description": "Update one or more campaigns.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updatePromotionRulesWorkflow", + "title": "updatePromotionRulesWorkflow", + "description": "Update one or more promotion rules.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updatePromotionsStatusWorkflow", + "title": "updatePromotionsStatusWorkflow", + "description": "Update the status of one or more promotions.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updatePromotionsWorkflow", + "title": "updatePromotionsWorkflow", + "description": "Update one or more promotions.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/addCampaignPromotionsStep", + "title": "addCampaignPromotionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/addRulesToPromotionsStep", + "title": "addRulesToPromotionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createCampaignsStep", + "title": "createCampaignsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createPromotionsStep", + "title": "createPromotionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteCampaignsStep", + "title": "deleteCampaignsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deletePromotionsStep", + "title": "deletePromotionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/removeCampaignPromotionsStep", + "title": "removeCampaignPromotionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/removeRulesFromPromotionsStep", + "title": "removeRulesFromPromotionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateCampaignsStep", + "title": "updateCampaignsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updatePromotionRulesStep", + "title": "updatePromotionRulesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updatePromotionsStep", + "title": "updatePromotionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updatePromotionsValidationStep", + "title": "updatePromotionsValidationStep", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Region", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createRegionsWorkflow", + "title": "createRegionsWorkflow", + "description": "Create one or more regions.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteRegionsWorkflow", + "title": "deleteRegionsWorkflow", + "description": "Delete one or more regions.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateRegionsWorkflow", + "title": "updateRegionsWorkflow", + "description": "Update regions.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createRegionsStep", + "title": "createRegionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteRegionsStep", + "title": "deleteRegionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/setRegionsPaymentProvidersStep", + "title": "setRegionsPaymentProvidersStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateRegionsStep", + "title": "updateRegionsStep", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Reservation", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createReservationsWorkflow", + "title": "createReservationsWorkflow", + "description": "Create one or more reservations.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteReservationsByLineItemsWorkflow", + "title": "deleteReservationsByLineItemsWorkflow", + "description": "Delete reservations by their associated line items.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteReservationsWorkflow", + "title": "deleteReservationsWorkflow", + "description": "Delete one or more reservations.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateReservationsWorkflow", + "title": "updateReservationsWorkflow", + "description": "Update one or more reservations.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createReservationsStep", + "title": "createReservationsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteReservationsByLineItemsStep", + "title": "deleteReservationsByLineItemsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteReservationsStep", + "title": "deleteReservationsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateReservationsStep", + "title": "updateReservationsStep", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Return Reason", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createReturnReasonsWorkflow", + "title": "createReturnReasonsWorkflow", + "description": "Create return reasons.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteReturnReasonsWorkflow", + "title": "deleteReturnReasonsWorkflow", + "description": "Delete return reasons.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateReturnReasonsWorkflow", + "title": "updateReturnReasonsWorkflow", + "description": "Update return reasons.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createReturnReasonsStep", + "title": "createReturnReasonsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteReturnReasonStep", + "title": "deleteReturnReasonStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateReturnReasonsStep", + "title": "updateReturnReasonsStep", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Sales Channel", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createSalesChannelsWorkflow", + "title": "createSalesChannelsWorkflow", + "description": "Create sales channels.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteSalesChannelsWorkflow", + "title": "deleteSalesChannelsWorkflow", + "description": "Delete sales channels.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/linkProductsToSalesChannelWorkflow", + "title": "linkProductsToSalesChannelWorkflow", + "description": "Manage the products available in a sales channel.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateSalesChannelsWorkflow", + "title": "updateSalesChannelsWorkflow", + "description": "Update sales channels.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/associateLocationsWithSalesChannelsStep", + "title": "associateLocationsWithSalesChannelsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/associateProductsWithSalesChannelsStep", + "title": "associateProductsWithSalesChannelsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/canDeleteSalesChannelsOrThrowStep", + "title": "canDeleteSalesChannelsOrThrowStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createDefaultSalesChannelStep", + "title": "createDefaultSalesChannelStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createSalesChannelsStep", + "title": "createSalesChannelsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteSalesChannelsStep", + "title": "deleteSalesChannelsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/detachLocationsFromSalesChannelsStep", + "title": "detachLocationsFromSalesChannelsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/detachProductsFromSalesChannelsStep", + "title": "detachProductsFromSalesChannelsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateSalesChannelsStep", + "title": "updateSalesChannelsStep", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Shipping Options", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/listShippingOptionsForContextStep", + "title": "listShippingOptionsForContextStep", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Shipping Profile", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteShippingProfileWorkflow", + "title": "deleteShippingProfileWorkflow", + "description": "Delete shipping profiles.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteShippingProfilesStep", + "title": "deleteShippingProfilesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/validateStepShippingProfileDelete", + "title": "validateStepShippingProfileDelete", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Stock Location", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createLocationFulfillmentSetWorkflow", + "title": "createLocationFulfillmentSetWorkflow", + "description": "Add fulfillment set to a stock location.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createStockLocationsWorkflow", + "title": "createStockLocationsWorkflow", + "description": "Create one or more stock locations.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteStockLocationsWorkflow", + "title": "deleteStockLocationsWorkflow", + "description": "Delete one or more stock locations.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/linkSalesChannelsToStockLocationWorkflow", + "title": "linkSalesChannelsToStockLocationWorkflow", + "description": "Manage the sales channels of a stock location.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateStockLocationsWorkflow", + "title": "updateStockLocationsWorkflow", + "description": "Update stock locations.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createStockLocations", + "title": "createStockLocations", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteStockLocationsStep", + "title": "deleteStockLocationsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateStockLocationsStep", + "title": "updateStockLocationsStep", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Store", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createStoresWorkflow", + "title": "createStoresWorkflow", + "description": "Create one or more stores.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteStoresWorkflow", + "title": "deleteStoresWorkflow", + "description": "Delete one or more stores.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateStoresWorkflow", + "title": "updateStoresWorkflow", + "description": "Update stores.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createStoresStep", + "title": "createStoresStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteStoresStep", + "title": "deleteStoresStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateStoresStep", + "title": "updateStoresStep", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Tax", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createTaxRateRulesWorkflow", + "title": "createTaxRateRulesWorkflow", + "description": "Create one or more tax rules for rates.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createTaxRatesWorkflow", + "title": "createTaxRatesWorkflow", + "description": "Create one or more tax rates.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createTaxRegionsWorkflow", + "title": "createTaxRegionsWorkflow", + "description": "Create one or more tax regions.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteTaxRateRulesWorkflow", + "title": "deleteTaxRateRulesWorkflow", + "description": "Delete one or more tax rate rules.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteTaxRatesWorkflow", + "title": "deleteTaxRatesWorkflow", + "description": "Delete one or more tax rates.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteTaxRegionsWorkflow", + "title": "deleteTaxRegionsWorkflow", + "description": "Delete one or more tax regions.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/setTaxRateRulesWorkflow", + "title": "setTaxRateRulesWorkflow", + "description": "Set the rules of tax rates.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateTaxRatesWorkflow", + "title": "updateTaxRatesWorkflow", + "description": "Update tax rates.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateTaxRegionsWorkflow", + "title": "updateTaxRegionsWorkflow", + "description": "Update one or more tax regions.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createTaxRateRulesStep", + "title": "createTaxRateRulesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createTaxRatesStep", + "title": "createTaxRatesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createTaxRegionsStep", + "title": "createTaxRegionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteTaxRateRulesStep", + "title": "deleteTaxRateRulesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteTaxRatesStep", + "title": "deleteTaxRatesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteTaxRegionsStep", + "title": "deleteTaxRegionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/getItemTaxLinesStep", + "title": "getItemTaxLinesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/listTaxRateIdsStep", + "title": "listTaxRateIdsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/listTaxRateRuleIdsStep", + "title": "listTaxRateRuleIdsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateTaxRatesStep", + "title": "updateTaxRatesStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateTaxRegionsStep", + "title": "updateTaxRegionsStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/maybeListTaxRateRuleIdsStep", + "title": "maybeListTaxRateRuleIdsStep", + "description": "", + "children": [] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "User", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Workflows", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createUserAccountWorkflow", + "title": "createUserAccountWorkflow", + "description": "Create a user account and attach an auth identity.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/createUsersWorkflow", + "title": "createUsersWorkflow", + "description": "Create one or more users.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/deleteUsersWorkflow", + "title": "deleteUsersWorkflow", + "description": "Delete one or more users.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/removeUserAccountWorkflow", + "title": "removeUserAccountWorkflow", + "description": "Delete a user and remove the association to its auth identity.", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/updateUsersWorkflow", + "title": "updateUsersWorkflow", + "description": "Update one or more users.", + "children": [] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sub-category", + "title": "Steps", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/createUsersStep", + "title": "createUsersStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/deleteUsersStep", + "title": "deleteUsersStep", + "description": "", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/references/medusa-workflows/steps/updateUsersStep", + "title": "updateUsersStep", + "description": "", + "children": [] + } + ] + } + ] + } + ] + }, + { + "loaded": true, + "isPathHref": true, + "type": "sidebar", + "sidebar_id": "test-tools-reference", + "title": "Testing Framework", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "path": "/test-tools-reference", + "title": "Reference Overview", + "children": [] + }, + { + "type": "separator" + }, + { + "loaded": true, + "isPathHref": true, + "type": "category", + "title": "Functions", + "children": [ + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "medusaIntegrationTestRunner", + "path": "/test-tools-reference/medusaIntegrationTestRunner", + "children": [] + }, + { + "loaded": true, + "isPathHref": true, + "type": "link", + "title": "moduleIntegrationTestRunner", + "path": "/test-tools-reference/moduleIntegrationTestRunner", + "children": [] + } + ] + } + ] + } + ] + } + ] +} + +export default generatedgeneratedResourcesSidebarSidebar \ No newline at end of file diff --git a/www/apps/resources/generated/sidebar.mjs b/www/apps/resources/generated/sidebar.mjs deleted file mode 100644 index 451e2be53d..0000000000 --- a/www/apps/resources/generated/sidebar.mjs +++ /dev/null @@ -1,25861 +0,0 @@ -export const generatedSidebars = [ - { - "sidebar_id": "resources", - "title": "Development Resources", - "items": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "examples", - "title": "Examples", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "path": "/recipes", - "title": "Recipes", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "path": "/plugins", - "title": "Plugins", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "path": "/integrations", - "title": "Integrations", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Storefront Examples", - "autogenerate_tags": "example+storefront", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Implement Express Checkout with Medusa", - "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", - "children": [] - } - ] - } - ] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules", - "title": "Commerce Modules", - "hideChildren": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "api-key", - "title": "API Key Module", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/api-key", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/api-key/concepts", - "title": "API Key Concepts", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/api-key/links-to-other-modules", - "title": "Link to Modules", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Server Guides", - "autogenerate_tags": "server+auth", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to use the API Key Module in your customizations on the Medusa application server.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create Actor Type", - "path": "https://docs.medusajs.com/resources/commerce-modules/auth/create-actor-type", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create Auth Provider", - "path": "https://docs.medusajs.com/resources/references/auth/provider", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Storefront Guides", - "autogenerate_tags": "storefront+apiKey,-jsSdk", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to integrate the API Key Module's features into your storefront.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Use a Publishable API Key in the Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/publishable-api-keys", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+apiKey", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to utilize and manage API Key features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Publishable API Keys", - "path": "https://docs.medusajs.com/user-guide/settings/developer/publishable-api-keys", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Secret API Keys", - "path": "https://docs.medusajs.com/user-guide/settings/developer/secret-api-keys", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "description": "Find references for tools and resources related to the API Key Module, such as data models, methods, and more. These are useful for your customizations.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/api-key/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+apiKey", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createApiKeysWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createApiKeysWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteApiKeysWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteApiKeysWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "revokeApiKeysWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/revokeApiKeysWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateApiKeysWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateApiKeysWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+apiKey", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createApiKeysStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createApiKeysStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteApiKeysStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteApiKeysStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "revokeApiKeysStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/revokeApiKeysStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateApiKeysStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateApiKeysStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/api-key/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+apiKey", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the API Key Module.", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "apiKey", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/apiKey", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/api-key/admin-widget-zones", - "title": "Admin Widget Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "api-key-service-reference", - "title": "Main Service Reference", - "childSidebarTitle": "API Key Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/api-key", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "hasTitleStyling": true, - "autogenerate_path": "/references/api_key/IApiKeyModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/api-key/authenticate", - "title": "authenticate", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/api-key/createApiKeys", - "title": "createApiKeys", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/api-key/deleteApiKeys", - "title": "deleteApiKeys", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/api-key/listAndCountApiKeys", - "title": "listAndCountApiKeys", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/api-key/listApiKeys", - "title": "listApiKeys", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/api-key/retrieveApiKey", - "title": "retrieveApiKey", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/api-key/revoke", - "title": "revoke", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/api-key/updateApiKeys", - "title": "updateApiKeys", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/api-key/upsertApiKeys", - "title": "upsertApiKeys", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "api-key-models-reference", - "title": "Data Models Reference", - "childSidebarTitle": "API Key Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/api-key/models", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "hasTitleStyling": true, - "autogenerate_path": "/references/api_key_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/api-key/models/ApiKey", - "title": "ApiKey", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "auth", - "title": "Auth Module", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/auth", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/auth/module-options", - "title": "Module Options", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/auth/auth-identity-and-actor-types", - "title": "Identity and Actor Types", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/auth/auth-providers", - "title": "Auth Providers", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/auth/auth-flows", - "title": "Auth Flow with Module", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/auth/authentication-route", - "title": "Auth Flow with Routes", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Server Guides", - "autogenerate_tags": "server+auth", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to use the Auth Module in your customizations on the Medusa application server.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create Actor Type", - "path": "https://docs.medusajs.com/resources/commerce-modules/auth/create-actor-type", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/auth/create-actor-type", - "title": "Create an Actor Type", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create Auth Provider", - "path": "https://docs.medusajs.com/resources/references/auth/provider", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/provider", - "title": "Create Auth Provider Module", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/auth/reset-password", - "title": "Handle Password Reset Event", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Storefront Guides", - "autogenerate_tags": "storefront+auth,-jsSdk", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to integrate the Auth Module's features into your storefront.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Log-out Customer in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/log-out", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Login Customer in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/login", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Register Customer in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/register", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Reset Customer Password in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/reset-password", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Retrieve Logged-In Customer in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/retrieve", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Third-Party or Social Login in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/third-party-login", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+auth", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to utilize and manage Auth features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Reset Password", - "path": "https://docs.medusajs.com/user-guide/reset-password", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Providers", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/auth/auth-providers/emailpass", - "title": "Emailpass Provider", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/auth/auth-providers/google", - "title": "Google Provider", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/auth/auth-providers/github", - "title": "GitHub Provider", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "description": "Find references for tools and resources related to the Auth Module, such as data models, methods, and more. These are useful for your customizations.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/auth/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+auth", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "acceptInviteWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/acceptInviteWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCustomerAccountWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCustomerAccountWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createUserAccountWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createUserAccountWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeCustomerAccountWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeCustomerAccountWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeUserAccountWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeUserAccountWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+auth", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "setAuthAppMetadataStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/setAuthAppMetadataStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/auth/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "autogenerate_tags": "jsSdk+auth", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "callback", - "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/callback", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "login", - "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/login", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "logout", - "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/logout", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refresh", - "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/refresh", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "register", - "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/register", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "resetPassword", - "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/resetPassword", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProvider", - "path": "https://docs.medusajs.com/resources/references/js-sdk/auth/updateProvider", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/auth/events", - "title": "Events Reference", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/auth/admin-widget-zones", - "title": "Admin Widget Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "auth-service-reference", - "title": "Main Service Reference", - "childSidebarTitle": "Auth Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/auth/IAuthModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/authenticate", - "title": "authenticate", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/createAuthIdentities", - "title": "createAuthIdentities", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/createProviderIdentities", - "title": "createProviderIdentities", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/deleteAuthIdentities", - "title": "deleteAuthIdentities", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/deleteProviderIdentities", - "title": "deleteProviderIdentities", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/listAndCountAuthIdentities", - "title": "listAndCountAuthIdentities", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/listAuthIdentities", - "title": "listAuthIdentities", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/listProviderIdentities", - "title": "listProviderIdentities", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/register", - "title": "register", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/retrieveAuthIdentity", - "title": "retrieveAuthIdentity", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/retrieveProviderIdentity", - "title": "retrieveProviderIdentity", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/updateAuthIdentities", - "title": "updateAuthIdentities", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/updateProvider", - "title": "updateProvider", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/updateProviderIdentities", - "title": "updateProviderIdentities", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/validateCallback", - "title": "validateCallback", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "auth-models-reference", - "title": "Data Models Reference", - "childSidebarTitle": "Auth Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/models", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "autogenerate_path": "/references/auth_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/models/AuthIdentity", - "title": "AuthIdentity", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/auth/models/ProviderIdentity", - "title": "ProviderIdentity", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "cart", - "title": "Cart Module", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/cart", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/cart/concepts", - "title": "Cart Concepts", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/cart/promotions", - "title": "Promotion Adjustments", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/cart/tax-lines", - "title": "Tax Lines", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/cart/links-to-other-modules", - "title": "Links to Other Modules", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Server Guides", - "autogenerate_tags": "server+cart", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to use the Cart Module in your customizations on the Medusa application server.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Extend Cart", - "path": "https://docs.medusajs.com/resources/commerce-modules/cart/extend", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/cart/extend", - "title": "Extend Module", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Implement Custom Line Item Pricing in Medusa", - "path": "https://docs.medusajs.com/resources/examples/guides/custom-item-price", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Storefront Guides", - "autogenerate_tags": "storefront+cart,-jsSdk", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to integrate the Cart Module's features into your storefront.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Checkout Step 1: Enter Email", - "path": "https://docs.medusajs.com/resources/storefront-development/checkout/email", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Checkout Step 2: Set Address", - "path": "https://docs.medusajs.com/resources/storefront-development/checkout/address", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Checkout Step 3: Choose Shipping Method", - "path": "https://docs.medusajs.com/resources/storefront-development/checkout/shipping", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Checkout Step 4: Choose Payment Provider", - "path": "https://docs.medusajs.com/resources/storefront-development/checkout/payment", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Checkout Step 5: Complete Cart", - "path": "https://docs.medusajs.com/resources/storefront-development/checkout/complete-cart", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create Cart Context in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/cart/context", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create Cart in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/cart/create", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Implement Express Checkout with Medusa", - "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Cart's Items in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/cart/manage-items", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Payment with Stripe in React Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/checkout/payment/stripe", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Retrieve Cart in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/cart/retrieve", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Update Cart in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/cart/update", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "description": "Find references for tools and resources related to the Cart Module, such as data models, methods, and more. These are useful for your customizations.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/cart/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+cart", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addShippingMethodToCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addShippingMethodToCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addToCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addToCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "completeCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/completeCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteLineItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refreshCartItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refreshCartShippingMethodsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartShippingMethodsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "transferCartCustomerWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/transferCartCustomerWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartPromotionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartPromotionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateLineItemInCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateLineItemInCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateTaxLinesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateTaxLinesWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+cart", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addShippingMethodToCartStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/addShippingMethodToCartStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCartsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCartsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createLineItemAdjustmentsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createLineItemAdjustmentsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createLineItemsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createLineItemsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createShippingMethodAdjustmentsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createShippingMethodAdjustmentsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteLineItemsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteLineItemsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "getLineItemActionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/getLineItemActionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeLineItemAdjustmentsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/removeLineItemAdjustmentsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeShippingMethodAdjustmentsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/removeShippingMethodAdjustmentsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeShippingMethodFromCartStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/removeShippingMethodFromCartStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "setTaxLinesForItemsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/setTaxLinesForItemsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCartsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateLineItemsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateLineItemsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateLineItemsStepWithSelector", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateLineItemsStepWithSelector", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateShippingMethodsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateShippingMethodsStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/cart/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Store", - "autogenerate_tags": "jsSdk+storefront+cart", - "description": "The following methods or properties are used to send requests to Store API Routes related to the Cart Module.", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cart", - "path": "https://docs.medusajs.com/resources/references/js-sdk/store/cart", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/cart/events", - "title": "Events Reference", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "cart-service-reference", - "title": "Main Service Reference", - "childSidebarTitle": "Cart Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/cart/ICartModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/addLineItemAdjustments", - "title": "addLineItemAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/addLineItemTaxLines", - "title": "addLineItemTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/addLineItems", - "title": "addLineItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/addShippingMethodAdjustments", - "title": "addShippingMethodAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/addShippingMethodTaxLines", - "title": "addShippingMethodTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/addShippingMethods", - "title": "addShippingMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/createAddresses", - "title": "createAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/createCarts", - "title": "createCarts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/deleteAddresses", - "title": "deleteAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/deleteCarts", - "title": "deleteCarts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/deleteLineItemAdjustments", - "title": "deleteLineItemAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/deleteLineItemTaxLines", - "title": "deleteLineItemTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/deleteLineItems", - "title": "deleteLineItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/deleteShippingMethodAdjustments", - "title": "deleteShippingMethodAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/deleteShippingMethodTaxLines", - "title": "deleteShippingMethodTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/deleteShippingMethods", - "title": "deleteShippingMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/listAddresses", - "title": "listAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/listAndCountCarts", - "title": "listAndCountCarts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/listCarts", - "title": "listCarts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/listLineItemAdjustments", - "title": "listLineItemAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/listLineItemTaxLines", - "title": "listLineItemTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/listLineItems", - "title": "listLineItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/listShippingMethodAdjustments", - "title": "listShippingMethodAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/listShippingMethodTaxLines", - "title": "listShippingMethodTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/listShippingMethods", - "title": "listShippingMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/restoreAddresses", - "title": "restoreAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/restoreCarts", - "title": "restoreCarts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/restoreLineItemAdjustments", - "title": "restoreLineItemAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/restoreLineItemTaxLines", - "title": "restoreLineItemTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/restoreLineItems", - "title": "restoreLineItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/restoreShippingMethodAdjustments", - "title": "restoreShippingMethodAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/restoreShippingMethodTaxLines", - "title": "restoreShippingMethodTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/restoreShippingMethods", - "title": "restoreShippingMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/retrieveCart", - "title": "retrieveCart", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/retrieveLineItem", - "title": "retrieveLineItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/setLineItemAdjustments", - "title": "setLineItemAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/setLineItemTaxLines", - "title": "setLineItemTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/setShippingMethodAdjustments", - "title": "setShippingMethodAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/setShippingMethodTaxLines", - "title": "setShippingMethodTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/softDeleteAddresses", - "title": "softDeleteAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/softDeleteCarts", - "title": "softDeleteCarts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/softDeleteLineItemAdjustments", - "title": "softDeleteLineItemAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/softDeleteLineItemTaxLines", - "title": "softDeleteLineItemTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/softDeleteLineItems", - "title": "softDeleteLineItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/softDeleteShippingMethodAdjustments", - "title": "softDeleteShippingMethodAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/softDeleteShippingMethodTaxLines", - "title": "softDeleteShippingMethodTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/softDeleteShippingMethods", - "title": "softDeleteShippingMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/updateAddresses", - "title": "updateAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/updateCarts", - "title": "updateCarts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/updateLineItems", - "title": "updateLineItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/updateShippingMethods", - "title": "updateShippingMethods", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "cart-models-reference", - "title": "Data Models Reference", - "childSidebarTitle": "Cart Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/models", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "autogenerate_path": "/references/cart_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/models/Address", - "title": "Address", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/models/Cart", - "title": "Cart", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/models/CreditLine", - "title": "CreditLine", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/models/LineItem", - "title": "LineItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/models/LineItemAdjustment", - "title": "LineItemAdjustment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/models/LineItemTaxLine", - "title": "LineItemTaxLine", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/models/ShippingMethod", - "title": "ShippingMethod", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/models/ShippingMethodAdjustment", - "title": "ShippingMethodAdjustment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/cart/models/ShippingMethodTaxLine", - "title": "ShippingMethodTaxLine", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "currency", - "title": "Currency Module", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/currency", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Concepts", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/currency/links-to-other-modules", - "title": "Link to Modules", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+currency", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to utilize and manage Currency features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Store", - "path": "https://docs.medusajs.com/user-guide/settings/store", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "References", - "description": "Find references for tools and resources related to the Currency Module, such as data models, methods, and more. These are useful for your customizations.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/currency/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+currency", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Currency Module.", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "currency", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/currency", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "currency-service-reference", - "title": "Main Service Reference", - "childSidebarTitle": "Currency Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/currency", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/currency/ICurrencyModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/currency/listAndCountCurrencies", - "title": "listAndCountCurrencies", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/currency/listCurrencies", - "title": "listCurrencies", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/currency/retrieveCurrency", - "title": "retrieveCurrency", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "currency-models-reference", - "title": "Data Models Reference", - "childSidebarTitle": "Currency Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/currency/models", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "autogenerate_path": "/references/currency_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/currency/models/Currency", - "title": "Currency", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "customer", - "title": "Customer Module", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/customer", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/customer/customer-accounts", - "title": "Customer Accounts", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/customer/links-to-other-modules", - "title": "Link to Modules", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Server Guides", - "autogenerate_tags": "server+customer", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to use the Customer Module in your customizations on the Medusa application server.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Extend Customer", - "path": "https://docs.medusajs.com/resources/commerce-modules/customer/extend", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/customer/extend", - "title": "Extend Module", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Storefront Guides", - "autogenerate_tags": "storefront+customer,-jsSdk", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to integrate the Customer Module's features into your storefront.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Customer Context in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/context", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Edit Customer Profile in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/profile", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Log-out Customer in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/log-out", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Login Customer in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/login", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Customer Addresses in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/addresses", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Register Customer in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/register", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Reset Customer Password in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/reset-password", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Retrieve Logged-In Customer in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/retrieve", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Third-Party or Social Login in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/customers/third-party-login", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+customer", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to utilize and manage Customer features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Customers Overview", - "path": "https://docs.medusajs.com/user-guide/customers", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Customer Groups", - "path": "https://docs.medusajs.com/user-guide/customers/groups", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Customers", - "path": "https://docs.medusajs.com/user-guide/customers/manage", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "description": "Find references for tools and resources related to the Customer Module, such as data models, methods, and more. These are useful for your customizations.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/customer/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+customer", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addOrderLineItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrderLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCustomerAccountWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCustomerAccountWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCustomerAddressesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCustomerAddressesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCustomerGroupsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCustomerGroupsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCustomersWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCustomersWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCustomerAddressesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteCustomerAddressesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCustomerGroupsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteCustomerGroupsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCustomersWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteCustomersWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "linkCustomerGroupsToCustomerWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/linkCustomerGroupsToCustomerWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "linkCustomersToCustomerGroupWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/linkCustomersToCustomerGroupWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderClaimAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderEditAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderExchangeAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeCustomerAccountWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeCustomerAccountWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCustomerAddressesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCustomerAddressesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCustomerGroupsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCustomerGroupsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCustomersWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCustomersWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+customer", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCustomerAddressesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCustomerAddressesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCustomerGroupsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCustomerGroupsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCustomersStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCustomersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCustomerAddressesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteCustomerAddressesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCustomerGroupStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteCustomerGroupStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCustomersStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteCustomersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "findOrCreateCustomerStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/findOrCreateCustomerStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "linkCustomerGroupsToCustomerStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/linkCustomerGroupsToCustomerStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "linkCustomersToCustomerGroupStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/linkCustomersToCustomerGroupStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "maybeUnsetDefaultBillingAddressesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/maybeUnsetDefaultBillingAddressesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "maybeUnsetDefaultShippingAddressesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/maybeUnsetDefaultShippingAddressesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCustomerAddressesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCustomerAddressesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCustomerGroupsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCustomerGroupsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCustomersStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCustomersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "validateCustomerAccountCreation", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateCustomerAccountCreation", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/customer/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Store", - "autogenerate_tags": "jsSdk+storefront+customer", - "description": "The following methods or properties are used to send requests to Store API Routes related to the Customer Module.", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "customer", - "path": "https://docs.medusajs.com/resources/references/js-sdk/store/customer", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+customer", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Customer Module.", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "customer", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/customer", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "customerGroup", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/customerGroup", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/customer/events", - "title": "Events Reference", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/customer/admin-widget-zones", - "title": "Admin Widget Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "customer-service-reference", - "title": "Main Service Reference", - "childSidebarTitle": "Customer Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/customer/ICustomerModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/addCustomerToGroup", - "title": "addCustomerToGroup", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/createCustomerAddresses", - "title": "createCustomerAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/createCustomerGroups", - "title": "createCustomerGroups", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/createCustomers", - "title": "createCustomers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/deleteCustomerAddresses", - "title": "deleteCustomerAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/deleteCustomerGroups", - "title": "deleteCustomerGroups", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/deleteCustomers", - "title": "deleteCustomers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/listAndCountCustomerAddresses", - "title": "listAndCountCustomerAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/listAndCountCustomerGroups", - "title": "listAndCountCustomerGroups", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/listAndCountCustomers", - "title": "listAndCountCustomers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/listCustomerAddresses", - "title": "listCustomerAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/listCustomerGroupCustomers", - "title": "listCustomerGroupCustomers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/listCustomerGroups", - "title": "listCustomerGroups", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/listCustomers", - "title": "listCustomers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/removeCustomerFromGroup", - "title": "removeCustomerFromGroup", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/restoreCustomerGroups", - "title": "restoreCustomerGroups", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/restoreCustomers", - "title": "restoreCustomers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/retrieveCustomer", - "title": "retrieveCustomer", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/retrieveCustomerGroup", - "title": "retrieveCustomerGroup", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/softDeleteCustomerGroups", - "title": "softDeleteCustomerGroups", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/softDeleteCustomers", - "title": "softDeleteCustomers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/updateCustomerAddresses", - "title": "updateCustomerAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/updateCustomerGroups", - "title": "updateCustomerGroups", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/updateCustomers", - "title": "updateCustomers", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "customer-models-reference", - "title": "Data Models Reference", - "childSidebarTitle": "Customer Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/models", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "autogenerate_path": "/references/customer_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/models/Customer", - "title": "Customer", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/models/CustomerAddress", - "title": "CustomerAddress", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/models/CustomerGroup", - "title": "CustomerGroup", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/customer/models/CustomerGroupCustomer", - "title": "CustomerGroupCustomer", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "fulfillment", - "title": "Fulfillment Module", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/fulfillment", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/fulfillment/module-options", - "title": "Module Options", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "autogenerate_tags": "concept+fulfillment", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/fulfillment/concepts", - "title": "Fulfillment Concepts", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/fulfillment/fulfillment-provider", - "title": "Fulfillment Provider", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/fulfillment/shipping-option", - "title": "Shipping Option", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/fulfillment/item-fulfillment", - "title": "Item Fulfillment", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/fulfillment/links-to-other-modules", - "title": "Links to Other Modules", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Product Shipping Requirement", - "path": "https://docs.medusajs.com/resources/commerce-modules/product/selling-products", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Server Guides", - "autogenerate_tags": "server+fulfillment", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to use the Fulfillment Module in your customizations on the Medusa application server.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create Fulfillment Provider", - "path": "https://docs.medusajs.com/resources/references/fulfillment/provider", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/provider", - "title": "Create Fulfillment Provider Module", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "path": "/integrations/guides/shipstation", - "title": "Integrate ShipStation", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Storefront Guides", - "autogenerate_tags": "storefront+fulfillment,-jsSdk", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to integrate the Fulfillment Module's features into your storefront.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Checkout Step 3: Choose Shipping Method", - "path": "https://docs.medusajs.com/resources/storefront-development/checkout/shipping", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Implement Express Checkout with Medusa", - "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+fulfillment", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to utilize and manage Fulfillment features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Locations & Shipping Overview", - "path": "https://docs.medusajs.com/user-guide/settings/locations-and-shipping", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Order Fulfillments", - "path": "https://docs.medusajs.com/user-guide/orders/fulfillments", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Shipping Profiles", - "path": "https://docs.medusajs.com/user-guide/settings/locations-and-shipping/shipping-profiles", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "description": "Find references for tools and resources related to the Fulfillment Module, such as data models, methods, and more. These are useful for your customizations.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/fulfillment/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+fulfillment", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addShippingMethodToCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addShippingMethodToCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addToCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addToCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchShippingOptionRulesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchShippingOptionRulesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "calculateShippingOptionsPricesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/calculateShippingOptionsPricesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelFulfillmentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderFulfillmentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmClaimRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmClaimRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmExchangeRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmExchangeRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmReturnRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmReturnRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createAndCompleteReturnOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createAndCompleteReturnOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createFulfillmentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createLocationFulfillmentSetWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createLocationFulfillmentSetWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderFulfillmentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderShipmentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderShipmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createReturnFulfillmentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createReturnFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createServiceZonesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createServiceZonesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createShipmentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createShipmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createShippingOptionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createShippingOptionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createShippingProfilesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createShippingProfilesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteFulfillmentSetsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteFulfillmentSetsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteLineItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteServiceZonesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteServiceZonesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteShippingOptionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteShippingOptionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteShippingProfileWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteShippingProfileWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "importProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/importProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "listShippingOptionsForCartWithPricingWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/listShippingOptionsForCartWithPricingWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "markFulfillmentAsDeliveredWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/markFulfillmentAsDeliveredWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "markOrderFulfillmentAsDeliveredWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/markOrderFulfillmentAsDeliveredWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refreshCartItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refreshCartShippingMethodsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartShippingMethodsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "transferCartCustomerWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/transferCartCustomerWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateFulfillmentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateLineItemInCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateLineItemInCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateServiceZonesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateServiceZonesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateShippingOptionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateShippingOptionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateShippingProfilesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateShippingProfilesWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+fulfillment", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "calculateShippingOptionsPricesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/calculateShippingOptionsPricesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelFulfillmentStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelFulfillmentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createFulfillmentSets", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createFulfillmentSets", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createFulfillmentStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createFulfillmentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createReturnFulfillmentStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createReturnFulfillmentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createServiceZonesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createServiceZonesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createShippingOptionRulesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createShippingOptionRulesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createShippingProfilesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createShippingProfilesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteFulfillmentSetsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteFulfillmentSetsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteServiceZonesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteServiceZonesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteShippingOptionRulesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteShippingOptionRulesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteShippingOptionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteShippingOptionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteShippingProfilesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteShippingProfilesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "parseProductCsvStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/parseProductCsvStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateFulfillmentStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateFulfillmentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateServiceZonesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateServiceZonesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateShippingOptionRulesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateShippingOptionRulesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateShippingProfilesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateShippingProfilesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "upsertShippingOptionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/upsertShippingOptionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "validateAndReturnShippingMethodsDataStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateAndReturnShippingMethodsDataStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "validateCartShippingOptionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateCartShippingOptionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "validateShipmentStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateShipmentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "validateShippingOptionPricesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateShippingOptionPricesStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/fulfillment/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Store", - "autogenerate_tags": "jsSdk+storefront+fulfillment", - "description": "The following methods or properties are used to send requests to Store API Routes related to the Fulfillment Module.", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "fulfillment", - "path": "https://docs.medusajs.com/resources/references/js-sdk/store/fulfillment", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+fulfillment", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Fulfillment Module.", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "fulfillment", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/fulfillment", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "fulfillmentProvider", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/fulfillmentProvider", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "fulfillmentSet", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/fulfillmentSet", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "shippingOption", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/shippingOption", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "shippingProfile", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/shippingProfile", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/fulfillment/events", - "title": "Events Reference", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/fulfillment/admin-widget-zones", - "title": "Admin Widget Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "fulfillment-service-reference", - "title": "Main Service Reference", - "childSidebarTitle": "Fulfillment Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/fulfillment/IFulfillmentModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/calculateShippingOptionsPrices", - "title": "calculateShippingOptionsPrices", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/cancelFulfillment", - "title": "cancelFulfillment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/createFulfillment", - "title": "createFulfillment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/createFulfillmentSets", - "title": "createFulfillmentSets", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/createGeoZones", - "title": "createGeoZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/createReturnFulfillment", - "title": "createReturnFulfillment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/createServiceZones", - "title": "createServiceZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/createShippingOptionRules", - "title": "createShippingOptionRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/createShippingOptions", - "title": "createShippingOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/createShippingProfiles", - "title": "createShippingProfiles", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/deleteFulfillment", - "title": "deleteFulfillment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/deleteFulfillmentSets", - "title": "deleteFulfillmentSets", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/deleteGeoZones", - "title": "deleteGeoZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/deleteServiceZones", - "title": "deleteServiceZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/deleteShippingOptionRules", - "title": "deleteShippingOptionRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/deleteShippingOptionTypes", - "title": "deleteShippingOptionTypes", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/deleteShippingOptions", - "title": "deleteShippingOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/deleteShippingProfiles", - "title": "deleteShippingProfiles", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listAndCountFulfillmentSets", - "title": "listAndCountFulfillmentSets", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listAndCountFulfillments", - "title": "listAndCountFulfillments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listAndCountGeoZones", - "title": "listAndCountGeoZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listAndCountServiceZones", - "title": "listAndCountServiceZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listAndCountShippingOptionRules", - "title": "listAndCountShippingOptionRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listAndCountShippingOptionTypes", - "title": "listAndCountShippingOptionTypes", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listAndCountShippingOptions", - "title": "listAndCountShippingOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listAndCountShippingProfiles", - "title": "listAndCountShippingProfiles", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listFulfillmentProviders", - "title": "listFulfillmentProviders", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listFulfillmentSets", - "title": "listFulfillmentSets", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listFulfillments", - "title": "listFulfillments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listGeoZones", - "title": "listGeoZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listServiceZones", - "title": "listServiceZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listShippingOptionRules", - "title": "listShippingOptionRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listShippingOptionTypes", - "title": "listShippingOptionTypes", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listShippingOptions", - "title": "listShippingOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listShippingOptionsForContext", - "title": "listShippingOptionsForContext", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/listShippingProfiles", - "title": "listShippingProfiles", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/restoreFulfillmentSets", - "title": "restoreFulfillmentSets", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/restoreGeoZones", - "title": "restoreGeoZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/restoreServiceZones", - "title": "restoreServiceZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/restoreShippingOptions", - "title": "restoreShippingOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/restoreShippingProfiles", - "title": "restoreShippingProfiles", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/retrieveFulfillment", - "title": "retrieveFulfillment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/retrieveFulfillmentOptions", - "title": "retrieveFulfillmentOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/retrieveFulfillmentSet", - "title": "retrieveFulfillmentSet", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/retrieveGeoZone", - "title": "retrieveGeoZone", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/retrieveServiceZone", - "title": "retrieveServiceZone", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/retrieveShippingOption", - "title": "retrieveShippingOption", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/retrieveShippingOptionRule", - "title": "retrieveShippingOptionRule", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/retrieveShippingOptionType", - "title": "retrieveShippingOptionType", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/retrieveShippingProfile", - "title": "retrieveShippingProfile", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/softDeleteFulfillmentSets", - "title": "softDeleteFulfillmentSets", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/softDeleteGeoZones", - "title": "softDeleteGeoZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/softDeleteServiceZones", - "title": "softDeleteServiceZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/softDeleteShippingOptions", - "title": "softDeleteShippingOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/softDeleteShippingProfiles", - "title": "softDeleteShippingProfiles", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/updateFulfillment", - "title": "updateFulfillment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/updateFulfillmentSets", - "title": "updateFulfillmentSets", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/updateGeoZones", - "title": "updateGeoZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/updateServiceZones", - "title": "updateServiceZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/updateShippingOptionRules", - "title": "updateShippingOptionRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/updateShippingOptions", - "title": "updateShippingOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/updateShippingProfiles", - "title": "updateShippingProfiles", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/upsertServiceZones", - "title": "upsertServiceZones", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/upsertShippingOptions", - "title": "upsertShippingOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/upsertShippingProfiles", - "title": "upsertShippingProfiles", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/validateFulfillmentData", - "title": "validateFulfillmentData", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/validateFulfillmentOption", - "title": "validateFulfillmentOption", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/validateShippingOption", - "title": "validateShippingOption", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/validateShippingOptionsForPriceCalculation", - "title": "validateShippingOptionsForPriceCalculation", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "fulfillment-models-reference", - "title": "Data Models Reference", - "childSidebarTitle": "Fulfillment Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/models", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "hasTitleStyling": true, - "autogenerate_path": "/references/fulfillment_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/models/Fulfillment", - "title": "Fulfillment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/models/FulfillmentAddress", - "title": "FulfillmentAddress", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/models/FulfillmentItem", - "title": "FulfillmentItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/models/FulfillmentLabel", - "title": "FulfillmentLabel", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/models/FulfillmentProvider", - "title": "FulfillmentProvider", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/models/FulfillmentSet", - "title": "FulfillmentSet", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/models/GeoZone", - "title": "GeoZone", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/models/ServiceZone", - "title": "ServiceZone", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/models/ShippingOption", - "title": "ShippingOption", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/models/ShippingOptionRule", - "title": "ShippingOptionRule", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/models/ShippingOptionType", - "title": "ShippingOptionType", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/fulfillment/models/ShippingProfile", - "title": "ShippingProfile", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "inventory", - "title": "Inventory Module", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/inventory", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "autogenerate_tags": "concept+inventory", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/inventory/concepts", - "title": "Inventory Concepts", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/inventory/inventory-in-flows", - "title": "Inventory in Flows", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/inventory/inventory-kit", - "title": "Inventory Kit", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/inventory/links-to-other-modules", - "title": "Links to Modules", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Inventory Kits", - "path": "https://docs.medusajs.com/resources/commerce-modules/inventory/inventory-kit", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Product Variant Inventory", - "path": "https://docs.medusajs.com/resources/commerce-modules/product/variant-inventory", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Storefront Guides", - "autogenerate_tags": "storefront+inventory,-jsSdk", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to integrate the Inventory Module's features into your storefront.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Retrieve Product Variant's Inventory in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/inventory", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+inventory", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to utilize and manage Inventory features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Inventory Overview", - "path": "https://docs.medusajs.com/user-guide/inventory", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Inventory Items", - "path": "https://docs.medusajs.com/user-guide/inventory/inventory", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Reservations", - "path": "https://docs.medusajs.com/user-guide/inventory/reservations", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "description": "Find references for tools and resources related to the Inventory Module, such as data models, methods, and more. These are useful for your customizations.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/inventory/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+inventory", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addOrderLineItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrderLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addToCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addToCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchInventoryItemLevelsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchInventoryItemLevelsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchProductVariantsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "bulkCreateDeleteLevelsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/bulkCreateDeleteLevelsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderClaimWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderClaimWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderExchangeWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderExchangeWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderFulfillmentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "completeCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/completeCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmClaimRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmClaimRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmExchangeRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmExchangeRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmOrderEditRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmOrderEditRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmReturnReceiveWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmReturnReceiveWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmVariantInventoryWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmVariantInventoryWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createInventoryItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createInventoryItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createInventoryLevelsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createInventoryLevelsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderFulfillmentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductVariantsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createReservationsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createReservationsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteInventoryItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteInventoryItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductVariantsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteReservationsByLineItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteReservationsByLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteReservationsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteReservationsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderClaimAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderEditAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderExchangeAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateInventoryItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateInventoryItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateInventoryLevelsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateInventoryLevelsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateLineItemInCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateLineItemInCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateReservationsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateReservationsWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+inventory", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "adjustInventoryLevelsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/adjustInventoryLevelsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmInventoryStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/confirmInventoryStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createInventoryItemsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createInventoryItemsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createInventoryLevelsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createInventoryLevelsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createReservationsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createReservationsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteInventoryItemStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteInventoryItemStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteReservationsByLineItemsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteReservationsByLineItemsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteReservationsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteReservationsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "reserveInventoryStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/reserveInventoryStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateInventoryItemsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateInventoryItemsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateInventoryLevelsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateInventoryLevelsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateReservationsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateReservationsStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/inventory/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+inventory", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Inventory Module.", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "inventoryItem", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/inventoryItem", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "reservation", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/reservation", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/inventory/admin-widget-zones", - "title": "Admin Widget Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "inventory-service-reference", - "title": "Main Service Reference", - "childSidebarTitle": "Inventory Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/inventory_next/IInventoryService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/adjustInventory", - "title": "adjustInventory", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/confirmInventory", - "title": "confirmInventory", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/createInventoryItems", - "title": "createInventoryItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/createInventoryLevels", - "title": "createInventoryLevels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/createReservationItems", - "title": "createReservationItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/deleteInventoryItemLevelByLocationId", - "title": "deleteInventoryItemLevelByLocationId", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/deleteInventoryItems", - "title": "deleteInventoryItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/deleteInventoryLevel", - "title": "deleteInventoryLevel", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/deleteInventoryLevels", - "title": "deleteInventoryLevels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/deleteReservationItemByLocationId", - "title": "deleteReservationItemByLocationId", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/deleteReservationItems", - "title": "deleteReservationItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/deleteReservationItemsByLineItem", - "title": "deleteReservationItemsByLineItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/listAndCountInventoryItems", - "title": "listAndCountInventoryItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/listAndCountInventoryLevels", - "title": "listAndCountInventoryLevels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/listAndCountReservationItems", - "title": "listAndCountReservationItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/listInventoryItems", - "title": "listInventoryItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/listInventoryLevels", - "title": "listInventoryLevels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/listReservationItems", - "title": "listReservationItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/restoreInventoryItems", - "title": "restoreInventoryItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/restoreInventoryLevels", - "title": "restoreInventoryLevels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/restoreReservationItems", - "title": "restoreReservationItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/restoreReservationItemsByLineItem", - "title": "restoreReservationItemsByLineItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/retrieveAvailableQuantity", - "title": "retrieveAvailableQuantity", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/retrieveInventoryItem", - "title": "retrieveInventoryItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/retrieveInventoryLevel", - "title": "retrieveInventoryLevel", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/retrieveInventoryLevelByItemAndLocation", - "title": "retrieveInventoryLevelByItemAndLocation", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/retrieveReservationItem", - "title": "retrieveReservationItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/retrieveReservedQuantity", - "title": "retrieveReservedQuantity", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/retrieveStockedQuantity", - "title": "retrieveStockedQuantity", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/softDeleteInventoryItems", - "title": "softDeleteInventoryItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/softDeleteInventoryLevels", - "title": "softDeleteInventoryLevels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/softDeleteReservationItems", - "title": "softDeleteReservationItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/updateInventoryItems", - "title": "updateInventoryItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/updateInventoryLevels", - "title": "updateInventoryLevels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/updateReservationItems", - "title": "updateReservationItems", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "inventory-models-reference", - "title": "Data Models Reference", - "childSidebarTitle": "Inventory Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/models", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "autogenerate_path": "/references/inventory_next_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/models/InventoryItem", - "title": "InventoryItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/models/InventoryLevel", - "title": "InventoryLevel", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/inventory-next/models/ReservationItem", - "title": "ReservationItem", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "order", - "title": "Order Module", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/concepts", - "title": "Order Concepts", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/promotion-adjustments", - "title": "Promotions Adjustments", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/tax-lines", - "title": "Tax Lines", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/transactions", - "title": "Transactions", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/order-versioning", - "title": "Order Versioning", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/return", - "title": "Return", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/exchange", - "title": "Exchange", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/claim", - "title": "Claim", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/edit", - "title": "Order Edit", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/order-change", - "title": "Order Change", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/links-to-other-modules", - "title": "Links to Other Modules", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Storefront Guides", - "autogenerate_tags": "storefront+order,-jsSdk", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to integrate the Order Module's features into your storefront.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Checkout Step 5: Complete Cart", - "path": "https://docs.medusajs.com/resources/storefront-development/checkout/complete-cart", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Implement Express Checkout with Medusa", - "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+order", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to utilize and manage Order features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Edit Order Items", - "path": "https://docs.medusajs.com/user-guide/orders/edit", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Order Claims", - "path": "https://docs.medusajs.com/user-guide/orders/claims", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Order Details", - "path": "https://docs.medusajs.com/user-guide/orders/manage", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Order Exchanges", - "path": "https://docs.medusajs.com/user-guide/orders/exchanges", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Order Fulfillments", - "path": "https://docs.medusajs.com/user-guide/orders/fulfillments", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Order Payments", - "path": "https://docs.medusajs.com/user-guide/orders/payments", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Order Returns", - "path": "https://docs.medusajs.com/user-guide/orders/returns", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Return Reasons", - "path": "https://docs.medusajs.com/user-guide/settings/return-reasons", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Orders Overview", - "path": "https://docs.medusajs.com/user-guide/orders", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "description": "Find references for tools and resources related to the Order Module, such as data models, methods, and more. These are useful for your customizations.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+order", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "acceptOrderTransferWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/acceptOrderTransferWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addOrderLineItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrderLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "archiveOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/archiveOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "beginClaimOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/beginClaimOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "beginExchangeOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/beginExchangeOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "beginOrderEditOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/beginOrderEditOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "beginReceiveReturnWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/beginReceiveReturnWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "beginReturnOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/beginReturnOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelBeginOrderClaimWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelBeginOrderClaimWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelBeginOrderEditWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelBeginOrderEditWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelBeginOrderExchangeWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelBeginOrderExchangeWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderChangeWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderChangeWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderClaimWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderClaimWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderExchangeWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderExchangeWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderFulfillmentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderTransferRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderTransferRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelReturnReceiveWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelReturnReceiveWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelReturnRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelReturnRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelReturnWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelReturnWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "capturePaymentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/capturePaymentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "completeCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/completeCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "completeOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/completeOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmClaimRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmClaimRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmExchangeRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmExchangeRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmOrderEditRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmOrderEditRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmReturnReceiveWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmReturnReceiveWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmReturnRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmReturnRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createAndCompleteReturnOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createAndCompleteReturnOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createClaimShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createClaimShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createExchangeShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createExchangeShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderChangeWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderChangeWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderEditShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderEditShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderFulfillmentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderFulfillmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderShipmentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderShipmentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createReturnReasonsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createReturnReasonsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createReturnShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createReturnShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "declineOrderChangeWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/declineOrderChangeWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "declineOrderTransferRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/declineOrderTransferRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteOrderChangeActionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteOrderChangeActionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteOrderChangeWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteOrderChangeWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteReturnReasonsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteReturnReasonsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "dismissItemReturnRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/dismissItemReturnRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "markPaymentCollectionAsPaid", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/markPaymentCollectionAsPaid", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderClaimAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderClaimItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderClaimRequestItemReturnWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimRequestItemReturnWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderEditAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderEditUpdateItemQuantityWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditUpdateItemQuantityWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderExchangeAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderExchangeRequestItemReturnWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeRequestItemReturnWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "processPaymentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/processPaymentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "receiveItemReturnRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/receiveItemReturnRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refundPaymentsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refundPaymentsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refundPaymentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refundPaymentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeAddItemClaimActionWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeAddItemClaimActionWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeClaimShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeClaimShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeExchangeShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeExchangeShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeItemClaimActionWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeItemClaimActionWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeItemExchangeActionWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeItemExchangeActionWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeItemOrderEditActionWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeItemOrderEditActionWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeItemReceiveReturnActionWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeItemReceiveReturnActionWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeItemReturnActionWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeItemReturnActionWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeOrderEditShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeOrderEditShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeReturnShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeReturnShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "requestItemReturnWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/requestItemReturnWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "requestOrderEditRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/requestOrderEditRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "requestOrderTransferWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/requestOrderTransferWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateClaimAddItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateClaimAddItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateClaimItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateClaimItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateClaimShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateClaimShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateExchangeAddItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateExchangeAddItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateExchangeShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateExchangeShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderChangeActionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderChangeActionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderChangesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderChangesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderEditAddItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderEditAddItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderEditItemQuantityWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderEditItemQuantityWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderEditShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderEditShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderTaxLinesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderTaxLinesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateReceiveItemReturnRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateReceiveItemReturnRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateRequestItemReturnWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateRequestItemReturnWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateReturnReasonsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateReturnReasonsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateReturnShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateReturnShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateReturnWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateReturnWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+order", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addOrderTransactionStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/addOrderTransactionStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "archiveOrdersStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/archiveOrdersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderChangeStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelOrderChangeStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderClaimStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelOrderClaimStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderExchangeStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelOrderExchangeStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderFulfillmentStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelOrderFulfillmentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderReturnStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelOrderReturnStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrdersStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelOrdersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "completeOrdersStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/completeOrdersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCompleteReturnStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCompleteReturnStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderChangeStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrderChangeStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderClaimItemsFromActionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrderClaimItemsFromActionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderClaimsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrderClaimsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderExchangeItemsFromActionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrderExchangeItemsFromActionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderExchangesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrderExchangesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderLineItemsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrderLineItemsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrdersStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createOrdersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createReturnReasonsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createReturnReasonsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createReturnsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createReturnsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "declineOrderChangeStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/declineOrderChangeStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteClaimsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteClaimsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteExchangesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteExchangesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteOrderChangeActionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteOrderChangeActionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteOrderChangesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteOrderChangesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteOrderShippingMethods", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteOrderShippingMethods", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteReturnReasonStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteReturnReasonStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteReturnsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteReturnsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "previewOrderChangeStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/previewOrderChangeStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "registerOrderChangesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/registerOrderChangesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "registerOrderFulfillmentStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/registerOrderFulfillmentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "registerOrderShipmentStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/registerOrderShipmentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "setOrderTaxLinesForItemsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/setOrderTaxLinesForItemsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderChangeActionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateOrderChangeActionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderChangesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateOrderChangesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderShippingMethodsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateOrderShippingMethodsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrdersStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateOrdersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateReturnReasonsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateReturnReasonsStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Store", - "autogenerate_tags": "jsSdk+storefront+order", - "description": "The following methods or properties are used to send requests to Store API Routes related to the Order Module.", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "order", - "path": "https://docs.medusajs.com/resources/references/js-sdk/store/order", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+order", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Order Module.", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "claim", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/claim", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "draftOrder", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/draftOrder", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "exchange", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/exchange", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "order", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/order", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderEdit", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/orderEdit", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refundReason", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/refundReason", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "return", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/return", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "returnReason", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/returnReason", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/events", - "title": "Events Reference", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/order/admin-widget-zones", - "title": "Admin Widget Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "order-service-reference", - "title": "Main Service Reference", - "childSidebarTitle": "Order Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/order/IOrderModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/addOrderAction", - "title": "addOrderAction", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/addOrderTransactions", - "title": "addOrderTransactions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/applyPendingOrderActions", - "title": "applyPendingOrderActions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/archive", - "title": "archive", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/cancel", - "title": "cancel", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/cancelClaim", - "title": "cancelClaim", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/cancelExchange", - "title": "cancelExchange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/cancelFulfillment", - "title": "cancelFulfillment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/cancelOrderChange", - "title": "cancelOrderChange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/cancelReturn", - "title": "cancelReturn", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/completeOrder", - "title": "completeOrder", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/confirmOrderChange", - "title": "confirmOrderChange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createClaim", - "title": "createClaim", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createExchange", - "title": "createExchange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrderAddresses", - "title": "createOrderAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrderChange", - "title": "createOrderChange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrderClaimItems", - "title": "createOrderClaimItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrderClaims", - "title": "createOrderClaims", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrderCreditLines", - "title": "createOrderCreditLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrderExchangeItems", - "title": "createOrderExchangeItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrderExchanges", - "title": "createOrderExchanges", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrderLineItemAdjustments", - "title": "createOrderLineItemAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrderLineItemTaxLines", - "title": "createOrderLineItemTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrderLineItems", - "title": "createOrderLineItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrderShippingMethodAdjustments", - "title": "createOrderShippingMethodAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrderShippingMethodTaxLines", - "title": "createOrderShippingMethodTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrderShippingMethods", - "title": "createOrderShippingMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createOrders", - "title": "createOrders", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createReturn", - "title": "createReturn", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createReturnItems", - "title": "createReturnItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createReturnReasons", - "title": "createReturnReasons", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/createReturns", - "title": "createReturns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/declineOrderChange", - "title": "declineOrderChange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderAddresses", - "title": "deleteOrderAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderChangeActions", - "title": "deleteOrderChangeActions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderChanges", - "title": "deleteOrderChanges", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderClaimItemImages", - "title": "deleteOrderClaimItemImages", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderClaimItems", - "title": "deleteOrderClaimItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderClaims", - "title": "deleteOrderClaims", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderExchangeItems", - "title": "deleteOrderExchangeItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderExchanges", - "title": "deleteOrderExchanges", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderLineItemAdjustments", - "title": "deleteOrderLineItemAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderLineItemTaxLines", - "title": "deleteOrderLineItemTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderLineItems", - "title": "deleteOrderLineItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderShippingMethodAdjustments", - "title": "deleteOrderShippingMethodAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderShippingMethodTaxLines", - "title": "deleteOrderShippingMethodTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderShippingMethods", - "title": "deleteOrderShippingMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrderTransactions", - "title": "deleteOrderTransactions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteOrders", - "title": "deleteOrders", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteReturnItems", - "title": "deleteReturnItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteReturnReasons", - "title": "deleteReturnReasons", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/deleteReturns", - "title": "deleteReturns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listAndCountOrderClaims", - "title": "listAndCountOrderClaims", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listAndCountOrderExchanges", - "title": "listAndCountOrderExchanges", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listAndCountOrders", - "title": "listAndCountOrders", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listAndCountReturns", - "title": "listAndCountReturns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listOrderAddresses", - "title": "listOrderAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listOrderChangeActions", - "title": "listOrderChangeActions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listOrderChanges", - "title": "listOrderChanges", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listOrderClaims", - "title": "listOrderClaims", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listOrderExchanges", - "title": "listOrderExchanges", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listOrderLineItemAdjustments", - "title": "listOrderLineItemAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listOrderLineItemTaxLines", - "title": "listOrderLineItemTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listOrderLineItems", - "title": "listOrderLineItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listOrderShippingMethodAdjustments", - "title": "listOrderShippingMethodAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listOrderShippingMethodTaxLines", - "title": "listOrderShippingMethodTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listOrderShippingMethods", - "title": "listOrderShippingMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listOrderTransactions", - "title": "listOrderTransactions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listOrders", - "title": "listOrders", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listReturnReasons", - "title": "listReturnReasons", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/listReturns", - "title": "listReturns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/previewOrderChange", - "title": "previewOrderChange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/receiveReturn", - "title": "receiveReturn", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/registerDelivery", - "title": "registerDelivery", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/registerFulfillment", - "title": "registerFulfillment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/registerOrderChange", - "title": "registerOrderChange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/registerShipment", - "title": "registerShipment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreOrderAddresses", - "title": "restoreOrderAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreOrderChangeActions", - "title": "restoreOrderChangeActions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreOrderChanges", - "title": "restoreOrderChanges", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreOrderClaims", - "title": "restoreOrderClaims", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreOrderExchanges", - "title": "restoreOrderExchanges", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreOrderLineItemAdjustments", - "title": "restoreOrderLineItemAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreOrderLineItemTaxLines", - "title": "restoreOrderLineItemTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreOrderLineItems", - "title": "restoreOrderLineItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreOrderShippingMethodAdjustments", - "title": "restoreOrderShippingMethodAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreOrderShippingMethodTaxLines", - "title": "restoreOrderShippingMethodTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreOrderShippingMethods", - "title": "restoreOrderShippingMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreOrderTransactions", - "title": "restoreOrderTransactions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreOrders", - "title": "restoreOrders", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreReturnReasons", - "title": "restoreReturnReasons", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/restoreReturns", - "title": "restoreReturns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/retrieveOrder", - "title": "retrieveOrder", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/retrieveOrderChange", - "title": "retrieveOrderChange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/retrieveOrderChangeAction", - "title": "retrieveOrderChangeAction", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/retrieveOrderClaim", - "title": "retrieveOrderClaim", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/retrieveOrderExchange", - "title": "retrieveOrderExchange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/retrieveOrderLineItem", - "title": "retrieveOrderLineItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/retrieveReturn", - "title": "retrieveReturn", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/retrieveReturnReason", - "title": "retrieveReturnReason", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/revertLastVersion", - "title": "revertLastVersion", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/setOrderLineItemAdjustments", - "title": "setOrderLineItemAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/setOrderLineItemTaxLines", - "title": "setOrderLineItemTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/setOrderShippingMethodAdjustments", - "title": "setOrderShippingMethodAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/setOrderShippingMethodTaxLines", - "title": "setOrderShippingMethodTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteOrderAddresses", - "title": "softDeleteOrderAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteOrderChangeActions", - "title": "softDeleteOrderChangeActions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteOrderChanges", - "title": "softDeleteOrderChanges", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteOrderClaims", - "title": "softDeleteOrderClaims", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteOrderExchanges", - "title": "softDeleteOrderExchanges", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteOrderLineItemAdjustments", - "title": "softDeleteOrderLineItemAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteOrderLineItemTaxLines", - "title": "softDeleteOrderLineItemTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteOrderLineItems", - "title": "softDeleteOrderLineItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteOrderShippingMethodAdjustments", - "title": "softDeleteOrderShippingMethodAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteOrderShippingMethodTaxLines", - "title": "softDeleteOrderShippingMethodTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteOrderShippingMethods", - "title": "softDeleteOrderShippingMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteOrderTransactions", - "title": "softDeleteOrderTransactions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteOrders", - "title": "softDeleteOrders", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteReturnReasons", - "title": "softDeleteReturnReasons", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/softDeleteReturns", - "title": "softDeleteReturns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/undoLastChange", - "title": "undoLastChange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/updateOrderAddresses", - "title": "updateOrderAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/updateOrderChangeActions", - "title": "updateOrderChangeActions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/updateOrderChanges", - "title": "updateOrderChanges", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/updateOrderClaims", - "title": "updateOrderClaims", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/updateOrderExchanges", - "title": "updateOrderExchanges", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/updateOrderItem", - "title": "updateOrderItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/updateOrderLineItems", - "title": "updateOrderLineItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/updateOrderShippingMethods", - "title": "updateOrderShippingMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/updateOrders", - "title": "updateOrders", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/updateReturnReasons", - "title": "updateReturnReasons", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/updateReturns", - "title": "updateReturns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/upsertOrderLineItemAdjustments", - "title": "upsertOrderLineItemAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/upsertOrderLineItemTaxLines", - "title": "upsertOrderLineItemTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/upsertOrderShippingMethodAdjustments", - "title": "upsertOrderShippingMethodAdjustments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/upsertOrderShippingMethodTaxLines", - "title": "upsertOrderShippingMethodTaxLines", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "order-models-reference", - "title": "Data Models Reference", - "childSidebarTitle": "Order Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "hasTitleStyling": true, - "autogenerate_path": "/references/order_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/Order", - "title": "Order", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderAddress", - "title": "OrderAddress", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderChange", - "title": "OrderChange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderChangeAction", - "title": "OrderChangeAction", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderClaim", - "title": "OrderClaim", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderClaimItem", - "title": "OrderClaimItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderClaimItemImage", - "title": "OrderClaimItemImage", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderCreditLine", - "title": "OrderCreditLine", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderExchange", - "title": "OrderExchange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderExchangeItem", - "title": "OrderExchangeItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderItem", - "title": "OrderItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderLineItem", - "title": "OrderLineItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderLineItemAdjustment", - "title": "OrderLineItemAdjustment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderLineItemTaxLine", - "title": "OrderLineItemTaxLine", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderShipping", - "title": "OrderShipping", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderShippingMethod", - "title": "OrderShippingMethod", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderShippingMethodAdjustment", - "title": "OrderShippingMethodAdjustment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderShippingMethodTaxLine", - "title": "OrderShippingMethodTaxLine", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderSummary", - "title": "OrderSummary", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/OrderTransaction", - "title": "OrderTransaction", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/Return", - "title": "Return", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/ReturnItem", - "title": "ReturnItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/order/models/ReturnReason", - "title": "ReturnReason", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "payment", - "title": "Payment Module", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment/module-options", - "title": "Module Options", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment/payment-collection", - "title": "Payment Collections", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment/payment-session", - "title": "Payment Session", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment/payment", - "title": "Payment", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment/payment-provider", - "title": "Payment Provider Module", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment/account-holder", - "title": "Account Holder", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment/webhook-events", - "title": "Webhook Events", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment/links-to-other-modules", - "title": "Links to Other Modules", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Server Guides", - "autogenerate_tags": "server+payment", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to use the Payment Module in your customizations on the Medusa application server.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment/payment-flow", - "title": "Accept Payment Flow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/provider", - "title": "Create Payment Provider", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create Payment Provider", - "path": "https://docs.medusajs.com/resources/references/payment/provider", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Storefront Guides", - "autogenerate_tags": "storefront+payment,-jsSdk", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to integrate the Payment Module's features into your storefront.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Checkout Step 4: Choose Payment Provider", - "path": "https://docs.medusajs.com/resources/storefront-development/checkout/payment", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Checkout Step 5: Complete Cart", - "path": "https://docs.medusajs.com/resources/storefront-development/checkout/complete-cart", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Customize the Stripe Integration in the Next.js Starter", - "path": "https://docs.medusajs.com/resources/nextjs-starter/guides/customize-stripe", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Implement Express Checkout with Medusa", - "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Payment with Stripe in React Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/checkout/payment/stripe", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+payment", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to utilize and manage Payment features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Order Payments", - "path": "https://docs.medusajs.com/user-guide/orders/payments", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Providers", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment/payment-provider/stripe", - "title": "Stripe", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "description": "Find references for tools and resources related to the Payment Module, such as data models, methods, and more. These are useful for your customizations.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+payment", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addShippingMethodToCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addShippingMethodToCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addToCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addToCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "capturePaymentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/capturePaymentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "completeCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/completeCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmClaimRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmClaimRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmExchangeRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmExchangeRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmOrderEditRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmOrderEditRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "confirmReturnRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmReturnRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderPaymentCollectionWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderPaymentCollectionWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrUpdateOrderPaymentCollectionWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrUpdateOrderPaymentCollectionWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPaymentCollectionForCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPaymentCollectionForCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPaymentSessionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPaymentSessionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createRefundReasonsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createRefundReasonsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createRegionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createRegionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteLineItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deletePaymentSessionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deletePaymentSessionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteRefundReasonsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteRefundReasonsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "markPaymentCollectionAsPaid", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/markPaymentCollectionAsPaid", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "processPaymentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/processPaymentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refreshCartItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refreshPaymentCollectionForCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshPaymentCollectionForCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refundPaymentsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refundPaymentsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refundPaymentWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refundPaymentWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "requestOrderEditRequestWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/requestOrderEditRequestWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "transferCartCustomerWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/transferCartCustomerWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateLineItemInCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateLineItemInCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateRefundReasonsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateRefundReasonsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateRegionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateRegionsWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+payment", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "authorizePaymentSessionStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/authorizePaymentSessionStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "cancelPaymentStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/cancelPaymentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "capturePaymentStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/capturePaymentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPaymentAccountHolderStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPaymentAccountHolderStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPaymentCollectionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPaymentCollectionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPaymentSessionStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPaymentSessionStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createRefundReasonStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createRefundReasonStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deletePaymentSessionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deletePaymentSessionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteRefundReasonsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteRefundReasonsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refundPaymentsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/refundPaymentsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refundPaymentStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/refundPaymentStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "setRegionsPaymentProvidersStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/setRegionsPaymentProvidersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePaymentCollectionStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePaymentCollectionStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateRefundReasonsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateRefundReasonsStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Store", - "autogenerate_tags": "jsSdk+storefront+payment", - "description": "The following methods or properties are used to send requests to Store API Routes related to the Payment Module.", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "payment", - "path": "https://docs.medusajs.com/resources/references/js-sdk/store/payment", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+payment", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Payment Module.", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "payment", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/payment", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "paymentCollection", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/paymentCollection", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment/events", - "title": "Events Reference", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "payment-service-reference", - "title": "Main Service Reference", - "childSidebarTitle": "Payment Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/payment/IPaymentModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/authorizePaymentSession", - "title": "authorizePaymentSession", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/cancelPayment", - "title": "cancelPayment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/capturePayment", - "title": "capturePayment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/completePaymentCollections", - "title": "completePaymentCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/createAccountHolder", - "title": "createAccountHolder", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/createPaymentCollections", - "title": "createPaymentCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/createPaymentMethods", - "title": "createPaymentMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/createPaymentSession", - "title": "createPaymentSession", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/createRefundReasons", - "title": "createRefundReasons", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/deleteAccountHolder", - "title": "deleteAccountHolder", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/deleteCaptures", - "title": "deleteCaptures", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/deletePaymentCollections", - "title": "deletePaymentCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/deletePaymentSession", - "title": "deletePaymentSession", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/deleteRefundReasons", - "title": "deleteRefundReasons", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/deleteRefunds", - "title": "deleteRefunds", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/getWebhookActionAndData", - "title": "getWebhookActionAndData", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/listAndCountPaymentCollections", - "title": "listAndCountPaymentCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/listAndCountPaymentMethods", - "title": "listAndCountPaymentMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/listAndCountPaymentProviders", - "title": "listAndCountPaymentProviders", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/listCaptures", - "title": "listCaptures", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/listPaymentCollections", - "title": "listPaymentCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/listPaymentMethods", - "title": "listPaymentMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/listPaymentProviders", - "title": "listPaymentProviders", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/listPaymentSessions", - "title": "listPaymentSessions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/listPayments", - "title": "listPayments", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/listRefundReasons", - "title": "listRefundReasons", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/listRefunds", - "title": "listRefunds", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/refundPayment", - "title": "refundPayment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/restorePaymentCollections", - "title": "restorePaymentCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/restoreRefundReasons", - "title": "restoreRefundReasons", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/retrievePaymentCollection", - "title": "retrievePaymentCollection", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/retrievePaymentSession", - "title": "retrievePaymentSession", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/softDeletePaymentCollections", - "title": "softDeletePaymentCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/softDeleteRefundReasons", - "title": "softDeleteRefundReasons", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/updateAccountHolder", - "title": "updateAccountHolder", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/updatePayment", - "title": "updatePayment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/updatePaymentCollections", - "title": "updatePaymentCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/updatePaymentSession", - "title": "updatePaymentSession", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/updateRefundReasons", - "title": "updateRefundReasons", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/upsertPaymentCollections", - "title": "upsertPaymentCollections", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "payment-models-reference", - "title": "Data Models Reference", - "childSidebarTitle": "Payment Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/models", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "autogenerate_path": "/references/payment_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/models/AccountHolder", - "title": "AccountHolder", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/models/Capture", - "title": "Capture", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/models/Payment", - "title": "Payment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/models/PaymentCollection", - "title": "PaymentCollection", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/models/PaymentProvider", - "title": "PaymentProvider", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/models/PaymentSession", - "title": "PaymentSession", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/models/Refund", - "title": "Refund", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/payment/models/RefundReason", - "title": "RefundReason", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "pricing", - "title": "Pricing Module", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/pricing", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/pricing/concepts", - "title": "Pricing Concepts", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/pricing/price-rules", - "title": "Price Rules", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/pricing/price-calculation", - "title": "Prices Calculation", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/pricing/tax-inclusive-pricing", - "title": "Tax-Inclusive Pricing", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/pricing/links-to-other-modules", - "title": "Links to Other Modules", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Server Guides", - "autogenerate_tags": "server+pricing", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to use the Pricing Module in your customizations on the Medusa application server.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Get Variant Price with Taxes", - "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price-with-taxes", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Get Variant Prices", - "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Implement Custom Line Item Pricing in Medusa", - "path": "https://docs.medusajs.com/resources/examples/guides/custom-item-price", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Storefront Guides", - "autogenerate_tags": "storefront+pricing,-jsSdk", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to integrate the Pricing Module's features into your storefront.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Example: Show Price with Taxes", - "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/tax-price", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Example: Show Sale Price", - "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/sale-price", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Example: Show Variant's Price", - "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/show-price", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Retrieve Product Variant's Prices in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/price", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+pricing", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to utilize and manage Pricing features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create a Price List", - "path": "https://docs.medusajs.com/user-guide/price-lists/create", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Price Lists", - "path": "https://docs.medusajs.com/user-guide/price-lists/manage", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Price Lists Overview", - "path": "https://docs.medusajs.com/user-guide/price-lists", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "description": "Find references for tools and resources related to the Pricing Module, such as data models, methods, and more. These are useful for your customizations.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/pricing/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+pricing", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchPriceListPricesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchPriceListPricesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchProductVariantsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPriceListPricesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPriceListPricesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPriceListsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPriceListsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPricePreferencesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPricePreferencesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductVariantsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createRegionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createRegionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createShippingOptionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createShippingOptionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createStoresWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createStoresWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deletePriceListsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deletePriceListsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deletePricePreferencesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deletePricePreferencesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removePriceListPricesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removePriceListPricesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePriceListPricesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updatePriceListPricesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePriceListsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updatePriceListsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePricePreferencesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updatePricePreferencesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductVariantsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateRegionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateRegionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateShippingOptionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateShippingOptionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateStoresWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateStoresWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "upsertVariantPricesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/upsertVariantPricesWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+pricing", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPriceListPricesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPriceListPricesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPriceListsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPriceListsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPricePreferencesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPricePreferencesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPriceSetsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPriceSetsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createShippingOptionsPriceSetsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createShippingOptionsPriceSetsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deletePriceListsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deletePriceListsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deletePricePreferencesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deletePricePreferencesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removePriceListPricesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/removePriceListPricesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "setShippingOptionsPricesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/setShippingOptionsPricesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePriceListPricesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePriceListPricesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePriceListsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePriceListsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePricePreferencesAsArrayStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePricePreferencesAsArrayStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePricePreferencesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePricePreferencesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePriceSetsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePriceSetsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "validatePriceListsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validatePriceListsStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/pricing/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+pricing", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Pricing Module.", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "priceList", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/priceList", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "pricePreference", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/pricePreference", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/pricing/admin-widget-zones", - "title": "Admin Widget Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "pricing-service-reference", - "title": "Main Service Reference", - "childSidebarTitle": "Pricing Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/pricing/IPricingModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/addPriceListPrices", - "title": "addPriceListPrices", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/addPrices", - "title": "addPrices", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/calculatePrices", - "title": "calculatePrices", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/createPriceLists", - "title": "createPriceLists", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/createPricePreferences", - "title": "createPricePreferences", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/createPriceRules", - "title": "createPriceRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/createPriceSets", - "title": "createPriceSets", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/deletePriceListRules", - "title": "deletePriceListRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/deletePriceLists", - "title": "deletePriceLists", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/deletePricePreferences", - "title": "deletePricePreferences", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/deletePriceRules", - "title": "deletePriceRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/deletePriceSets", - "title": "deletePriceSets", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/listAndCountPriceListRules", - "title": "listAndCountPriceListRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/listAndCountPriceLists", - "title": "listAndCountPriceLists", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/listAndCountPriceRules", - "title": "listAndCountPriceRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/listAndCountPriceSets", - "title": "listAndCountPriceSets", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/listAndCountPrices", - "title": "listAndCountPrices", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/listPriceListRules", - "title": "listPriceListRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/listPriceLists", - "title": "listPriceLists", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/listPricePreferences", - "title": "listPricePreferences", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/listPriceRules", - "title": "listPriceRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/listPriceSets", - "title": "listPriceSets", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/listPrices", - "title": "listPrices", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/removePriceListRules", - "title": "removePriceListRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/removePrices", - "title": "removePrices", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/restorePriceLists", - "title": "restorePriceLists", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/restorePricePreferences", - "title": "restorePricePreferences", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/restorePrices", - "title": "restorePrices", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/retrievePriceList", - "title": "retrievePriceList", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/retrievePriceListRule", - "title": "retrievePriceListRule", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/retrievePricePreference", - "title": "retrievePricePreference", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/retrievePriceRule", - "title": "retrievePriceRule", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/retrievePriceSet", - "title": "retrievePriceSet", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/setPriceListRules", - "title": "setPriceListRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/softDeletePriceLists", - "title": "softDeletePriceLists", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/softDeletePricePreferences", - "title": "softDeletePricePreferences", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/softDeletePrices", - "title": "softDeletePrices", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/updatePriceListPrices", - "title": "updatePriceListPrices", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/updatePriceLists", - "title": "updatePriceLists", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/updatePricePreferences", - "title": "updatePricePreferences", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/updatePriceRules", - "title": "updatePriceRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/updatePriceSets", - "title": "updatePriceSets", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/upsertPricePreferences", - "title": "upsertPricePreferences", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/upsertPriceSets", - "title": "upsertPriceSets", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "pricing-models-reference", - "title": "Data Models Reference", - "childSidebarTitle": "Pricing Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/models", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "hasTitleStyling": true, - "autogenerate_path": "/references/pricing_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/models/Price", - "title": "Price", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/models/PriceList", - "title": "PriceList", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/models/PriceListRule", - "title": "PriceListRule", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/models/PricePreference", - "title": "PricePreference", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/models/PriceRule", - "title": "PriceRule", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/pricing/models/PriceSet", - "title": "PriceSet", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "product", - "title": "Product Module", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/product", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "autogenerate_tags": "concept+product", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/product/variant-inventory", - "title": "Variant Inventory", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/product/selling-products", - "title": "Selling Use Cases", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/product/links-to-other-modules", - "title": "Links to Other Modules", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Inventory Kits", - "path": "https://docs.medusajs.com/resources/commerce-modules/inventory/inventory-kit", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Server Guides", - "autogenerate_tags": "server+product", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to use the Product Module in your customizations on the Medusa application server.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Build Wishlist Plugin", - "path": "https://docs.medusajs.com/resources/plugins/guides/wishlist", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/product/extend", - "title": "Extend Module", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Extend Product", - "path": "https://docs.medusajs.com/resources/commerce-modules/product/extend", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/product/guides/price-with-taxes", - "title": "Get Variant Price with Taxes", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Get Variant Price with Taxes", - "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price-with-taxes", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/product/guides/price", - "title": "Get Variant Prices", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Get Variant Prices", - "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Storefront Guides", - "autogenerate_tags": "storefront+product,-jsSdk", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to integrate the Product Module's features into your storefront.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Example: Show Price with Taxes", - "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/tax-price", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Example: Show Sale Price", - "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/sale-price", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Example: Show Variant's Price", - "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/show-price", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Implement Express Checkout with Medusa", - "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "List Product Categories in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/categories/list", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "List Product Collections in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/collections/list", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "List Products in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/list", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Retrieve a Category in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/categories/retrieve", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Retrieve a Category's Products in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/categories/products", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Retrieve a Collection in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/collections/retrieve", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Retrieve a Collection's Products in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/collections/products", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Retrieve a Product in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/retrieve", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Retrieve Nested Categories in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/categories/nested-categories", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Retrieve Product Variant's Inventory in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/inventory", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Retrieve Product Variant's Prices in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/price", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Select Product Variants in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/products/variants", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+product", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to utilize and manage Product features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create Bundle Product", - "path": "https://docs.medusajs.com/user-guide/products/create/bundle", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create Multi-Part Product", - "path": "https://docs.medusajs.com/user-guide/products/create/multi-part", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create Product", - "path": "https://docs.medusajs.com/user-guide/products/create", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Edit Product", - "path": "https://docs.medusajs.com/user-guide/products/edit", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Export Products", - "path": "https://docs.medusajs.com/user-guide/products/export", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Import Products", - "path": "https://docs.medusajs.com/user-guide/products/import", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Product Categories", - "path": "https://docs.medusajs.com/user-guide/products/categories", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Product Collections", - "path": "https://docs.medusajs.com/user-guide/products/collections", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Product Tags", - "path": "https://docs.medusajs.com/user-guide/settings/product-tags", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Product Types", - "path": "https://docs.medusajs.com/user-guide/settings/product-types", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Product Variants", - "path": "https://docs.medusajs.com/user-guide/products/variants", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Products Overview", - "path": "https://docs.medusajs.com/user-guide/products", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "description": "Find references for tools and resources related to the Product Module, such as data models, methods, and more. These are useful for your customizations.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/product/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+product", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchLinkProductsToCategoryWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchLinkProductsToCategoryWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchLinkProductsToCollectionWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchLinkProductsToCollectionWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchProductVariantsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCollectionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCollectionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductCategoriesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductCategoriesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductOptionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductOptionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductTagsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductTagsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductTypesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductTypesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductVariantsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCollectionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteCollectionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductCategoriesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductCategoriesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductOptionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductOptionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductTagsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductTagsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductTypesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductTypesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductVariantsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteProductVariantsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "importProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/importProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCollectionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCollectionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductCategoriesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductCategoriesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductOptionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductOptionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductTagsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductTagsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductTypesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductTypesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductVariantsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateProductVariantsWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+product", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchLinkProductsToCategoryStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/batchLinkProductsToCategoryStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchLinkProductsToCollectionStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/batchLinkProductsToCollectionStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCollectionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCollectionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductCategoriesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createProductCategoriesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductOptionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createProductOptionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createProductsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductTagsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createProductTagsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductTypesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createProductTypesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createProductVariantsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createProductVariantsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCollectionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteCollectionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductCategoriesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteProductCategoriesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductOptionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteProductOptionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteProductsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductTagsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteProductTagsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductTypesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteProductTypesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteProductVariantsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteProductVariantsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "getProductsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/getProductsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "groupProductsForBatchStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/groupProductsForBatchStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "parseProductCsvStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/parseProductCsvStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCollectionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCollectionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductCategoriesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateProductCategoriesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductOptionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateProductOptionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateProductsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductTagsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateProductTagsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductTypesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateProductTypesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateProductVariantsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateProductVariantsStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/product/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Store", - "autogenerate_tags": "jsSdk+storefront+product", - "description": "The following methods or properties are used to send requests to Store API Routes related to the Product Module.", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "category", - "path": "https://docs.medusajs.com/resources/references/js-sdk/store/category", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "collection", - "path": "https://docs.medusajs.com/resources/references/js-sdk/store/collection", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "product", - "path": "https://docs.medusajs.com/resources/references/js-sdk/store/product", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+product", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Product Module.", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "product", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/product", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "productCategory", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/productCategory", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "productCollection", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/productCollection", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "productTag", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/productTag", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "productType", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/productType", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "productVariant", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/productVariant", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/product/events", - "title": "Events Reference", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/product/admin-widget-zones", - "title": "Admin Widget Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "product-service-reference", - "title": "Main Service Reference", - "childSidebarTitle": "Product Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/product/IProductModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/createProductCategories", - "title": "createProductCategories", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/createProductCollections", - "title": "createProductCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/createProductOptionValues", - "title": "createProductOptionValues", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/createProductOptions", - "title": "createProductOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/createProductTags", - "title": "createProductTags", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/createProductTypes", - "title": "createProductTypes", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/createProductVariants", - "title": "createProductVariants", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/createProducts", - "title": "createProducts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/deleteProductCategories", - "title": "deleteProductCategories", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/deleteProductCollections", - "title": "deleteProductCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/deleteProductOptionValues", - "title": "deleteProductOptionValues", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/deleteProductOptions", - "title": "deleteProductOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/deleteProductTags", - "title": "deleteProductTags", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/deleteProductTypes", - "title": "deleteProductTypes", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/deleteProductVariants", - "title": "deleteProductVariants", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/deleteProducts", - "title": "deleteProducts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listAndCountProductCategories", - "title": "listAndCountProductCategories", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listAndCountProductCollections", - "title": "listAndCountProductCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listAndCountProductOptionValues", - "title": "listAndCountProductOptionValues", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listAndCountProductOptions", - "title": "listAndCountProductOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listAndCountProductTags", - "title": "listAndCountProductTags", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listAndCountProductTypes", - "title": "listAndCountProductTypes", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listAndCountProductVariants", - "title": "listAndCountProductVariants", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listAndCountProducts", - "title": "listAndCountProducts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listProductCategories", - "title": "listProductCategories", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listProductCollections", - "title": "listProductCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listProductOptionValues", - "title": "listProductOptionValues", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listProductOptions", - "title": "listProductOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listProductTags", - "title": "listProductTags", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listProductTypes", - "title": "listProductTypes", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listProductVariants", - "title": "listProductVariants", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/listProducts", - "title": "listProducts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/restoreProductCategories", - "title": "restoreProductCategories", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/restoreProductCollections", - "title": "restoreProductCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/restoreProductOptionValues", - "title": "restoreProductOptionValues", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/restoreProductOptions", - "title": "restoreProductOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/restoreProductTags", - "title": "restoreProductTags", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/restoreProductTypes", - "title": "restoreProductTypes", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/restoreProductVariants", - "title": "restoreProductVariants", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/restoreProducts", - "title": "restoreProducts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/retrieveProduct", - "title": "retrieveProduct", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/retrieveProductCategory", - "title": "retrieveProductCategory", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/retrieveProductCollection", - "title": "retrieveProductCollection", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/retrieveProductOption", - "title": "retrieveProductOption", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/retrieveProductTag", - "title": "retrieveProductTag", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/retrieveProductType", - "title": "retrieveProductType", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/retrieveProductVariant", - "title": "retrieveProductVariant", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/softDeleteProductCategories", - "title": "softDeleteProductCategories", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/softDeleteProductCollections", - "title": "softDeleteProductCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/softDeleteProductOptionValues", - "title": "softDeleteProductOptionValues", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/softDeleteProductOptions", - "title": "softDeleteProductOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/softDeleteProductTags", - "title": "softDeleteProductTags", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/softDeleteProductTypes", - "title": "softDeleteProductTypes", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/softDeleteProductVariants", - "title": "softDeleteProductVariants", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/softDeleteProducts", - "title": "softDeleteProducts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/updateProductCategories", - "title": "updateProductCategories", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/updateProductCollections", - "title": "updateProductCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/updateProductOptionValues", - "title": "updateProductOptionValues", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/updateProductOptions", - "title": "updateProductOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/updateProductTags", - "title": "updateProductTags", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/updateProductTypes", - "title": "updateProductTypes", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/updateProductVariants", - "title": "updateProductVariants", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/updateProducts", - "title": "updateProducts", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/upsertProductCategories", - "title": "upsertProductCategories", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/upsertProductCollections", - "title": "upsertProductCollections", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/upsertProductOptions", - "title": "upsertProductOptions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/upsertProductTags", - "title": "upsertProductTags", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/upsertProductTypes", - "title": "upsertProductTypes", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/upsertProductVariants", - "title": "upsertProductVariants", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/upsertProducts", - "title": "upsertProducts", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "product-models-reference", - "title": "Data Models Reference", - "childSidebarTitle": "Product Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/models", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "hasTitleStyling": true, - "autogenerate_path": "/references/product_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/models/Product", - "title": "Product", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/models/ProductCategory", - "title": "ProductCategory", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/models/ProductCollection", - "title": "ProductCollection", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/models/ProductImage", - "title": "ProductImage", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/models/ProductOption", - "title": "ProductOption", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/models/ProductOptionValue", - "title": "ProductOptionValue", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/models/ProductTag", - "title": "ProductTag", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/models/ProductType", - "title": "ProductType", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/product/models/ProductVariant", - "title": "ProductVariant", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "promotion", - "title": "Promotion Module", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/promotion", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/promotion/concepts", - "title": "Promotion", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/promotion/application-method", - "title": "Application Method", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/promotion/campaign", - "title": "Campaign", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/promotion/actions", - "title": "Promotion Actions", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/promotion/links-to-other-modules", - "title": "Links to Modules", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Server Guides", - "autogenerate_tags": "server+promotion", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to use the Promotion Module in your customizations on the Medusa application server.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/promotion/extend", - "title": "Extend Module", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Extend Promotion", - "path": "https://docs.medusajs.com/resources/commerce-modules/promotion/extend", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+promotion", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to utilize and manage Promotion features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create a Promotion", - "path": "https://docs.medusajs.com/user-guide/promotions/create", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Campaigns", - "path": "https://docs.medusajs.com/user-guide/promotions/campaigns", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Promotions", - "path": "https://docs.medusajs.com/user-guide/promotions/manage", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Promotions Overview", - "path": "https://docs.medusajs.com/user-guide/promotions", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "description": "Find references for tools and resources related to the Promotion Module, such as data models, methods, and more. These are useful for your customizations.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/promotion/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+promotion", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addOrRemoveCampaignPromotionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrRemoveCampaignPromotionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addShippingMethodToCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addShippingMethodToCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addToCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addToCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "batchPromotionRulesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/batchPromotionRulesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCampaignsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCampaignsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPromotionRulesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPromotionRulesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPromotionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createPromotionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCampaignsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteCampaignsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteLineItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deletePromotionRulesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deletePromotionRulesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deletePromotionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deletePromotionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refreshCartItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "transferCartCustomerWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/transferCartCustomerWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCampaignsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCampaignsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartPromotionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartPromotionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateLineItemInCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateLineItemInCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePromotionRulesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updatePromotionRulesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePromotionsStatusWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updatePromotionsStatusWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePromotionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updatePromotionsWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+promotion", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addCampaignPromotionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/addCampaignPromotionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addRulesToPromotionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/addRulesToPromotionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCampaignsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createCampaignsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createPromotionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createPromotionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteCampaignsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteCampaignsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deletePromotionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deletePromotionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "getActionsToComputeFromPromotionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/getActionsToComputeFromPromotionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "getPromotionCodesToApply", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/getPromotionCodesToApply", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "prepareAdjustmentsFromPromotionActionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/prepareAdjustmentsFromPromotionActionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeCampaignPromotionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/removeCampaignPromotionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeRulesFromPromotionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/removeRulesFromPromotionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCampaignsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCampaignsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartPromotionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateCartPromotionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePromotionRulesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePromotionRulesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updatePromotionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updatePromotionsStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/promotion/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+promotion", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Promotion Module.", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "campaign", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/campaign", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "promotion", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/promotion", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/promotion/admin-widget-zones", - "title": "Admin Widget Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "promotion-service-reference", - "title": "Main Service Reference", - "childSidebarTitle": "Promotion Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "hasTitleStyling": true, - "autogenerate_path": "/references/promotion/IPromotionModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/addPromotionBuyRules", - "title": "addPromotionBuyRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/addPromotionRules", - "title": "addPromotionRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/addPromotionTargetRules", - "title": "addPromotionTargetRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/addPromotionsToCampaign", - "title": "addPromotionsToCampaign", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/computeActions", - "title": "computeActions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/createCampaigns", - "title": "createCampaigns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/createPromotions", - "title": "createPromotions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/deleteCampaigns", - "title": "deleteCampaigns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/deletePromotions", - "title": "deletePromotions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/listAndCountCampaigns", - "title": "listAndCountCampaigns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/listAndCountPromotions", - "title": "listAndCountPromotions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/listCampaigns", - "title": "listCampaigns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/listPromotionRules", - "title": "listPromotionRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/listPromotions", - "title": "listPromotions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/registerUsage", - "title": "registerUsage", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/removePromotionBuyRules", - "title": "removePromotionBuyRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/removePromotionRules", - "title": "removePromotionRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/removePromotionTargetRules", - "title": "removePromotionTargetRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/removePromotionsFromCampaign", - "title": "removePromotionsFromCampaign", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/restoreCampaigns", - "title": "restoreCampaigns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/restorePromotions", - "title": "restorePromotions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/retrieveCampaign", - "title": "retrieveCampaign", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/retrievePromotion", - "title": "retrievePromotion", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/revertUsage", - "title": "revertUsage", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/softDeleteCampaigns", - "title": "softDeleteCampaigns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/softDeletePromotions", - "title": "softDeletePromotions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/updateCampaigns", - "title": "updateCampaigns", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/updatePromotionRules", - "title": "updatePromotionRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/updatePromotions", - "title": "updatePromotions", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "promotion-models-reference", - "title": "Data Models Reference", - "childSidebarTitle": "Promotion Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/models", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "hasTitleStyling": true, - "autogenerate_path": "/references/promotion_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/models/ApplicationMethod", - "title": "ApplicationMethod", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/models/Campaign", - "title": "Campaign", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/models/CampaignBudget", - "title": "CampaignBudget", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/models/Promotion", - "title": "Promotion", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/models/PromotionRule", - "title": "PromotionRule", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/promotion/models/PromotionRuleValue", - "title": "PromotionRuleValue", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "region", - "title": "Region Module", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/region", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/region/links-to-other-modules", - "title": "Links to Modules", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Storefront Guides", - "autogenerate_tags": "storefront+region,-jsSdk", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to integrate the Region Module's features into your storefront.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Implement Express Checkout with Medusa", - "path": "https://docs.medusajs.com/resources/storefront-development/guides/express-checkout", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "List Regions in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/regions/list", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Region Context in Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/regions/context", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Store and Retrieve Region", - "path": "https://docs.medusajs.com/resources/storefront-development/regions/store-retrieve-region", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+region", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to utilize and manage Region features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Regions", - "path": "https://docs.medusajs.com/user-guide/settings/regions", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "description": "Find references for tools and resources related to the Region Module, such as data models, methods, and more. These are useful for your customizations.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/region/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+region", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addOrderLineItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrderLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createRegionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createRegionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createShippingOptionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createShippingOptionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteRegionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteRegionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "exportProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/exportProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "importProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/importProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderClaimAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderEditAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderExchangeAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateRegionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateRegionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateShippingOptionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateShippingOptionsWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+region", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createRegionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createRegionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteRegionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteRegionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "findOneOrAnyRegionStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/findOneOrAnyRegionStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "generateProductCsvStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/generateProductCsvStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "parseProductCsvStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/parseProductCsvStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateRegionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateRegionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "validateShippingOptionPricesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateShippingOptionPricesStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/region/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Store", - "autogenerate_tags": "jsSdk+storefront+region", - "description": "The following methods or properties are used to send requests to Store API Routes related to the Region Module.", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "region", - "path": "https://docs.medusajs.com/resources/references/js-sdk/store/region", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+region", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Region Module.", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "region", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/region", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/region/events", - "title": "Events Reference", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/region/admin-widget-zones", - "title": "Admin Widget Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "region-service-reference", - "title": "Main Service Reference", - "childSidebarTitle": "Region Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/region/IRegionModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/createRegions", - "title": "createRegions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/deleteRegions", - "title": "deleteRegions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/listAndCountCountries", - "title": "listAndCountCountries", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/listAndCountRegions", - "title": "listAndCountRegions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/listCountries", - "title": "listCountries", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/listRegions", - "title": "listRegions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/restoreRegions", - "title": "restoreRegions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/retrieveCountry", - "title": "retrieveCountry", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/retrieveRegion", - "title": "retrieveRegion", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/softDeleteRegions", - "title": "softDeleteRegions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/updateRegions", - "title": "updateRegions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/upsertRegions", - "title": "upsertRegions", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "region-models-reference", - "title": "Data Models Reference", - "childSidebarTitle": "Region Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/models", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "autogenerate_path": "/references/region_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/models/Country", - "title": "Country", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/region/models/Region", - "title": "Region", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "sales-channel", - "title": "Sales Channel Module", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/sales-channel", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "autogenerate_tags": "concept+salesChannel", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/sales-channel/publishable-api-keys", - "title": "Publishable API Keys", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/sales-channel/links-to-other-modules", - "title": "Links to Modules", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Product Variant Inventory", - "path": "https://docs.medusajs.com/resources/commerce-modules/product/variant-inventory", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Storefront Guides", - "autogenerate_tags": "storefront+salesChannel,-jsSdk", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to integrate the Sales Channel Module's features into your storefront.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Use a Publishable API Key in the Storefront", - "path": "https://docs.medusajs.com/resources/storefront-development/publishable-api-keys", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+salesChannel", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to utilize and manage Sales Channel features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Sales Channels", - "path": "https://docs.medusajs.com/user-guide/settings/sales-channels", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "description": "Find references for tools and resources related to the Sales Channel Module, such as data models, methods, and more. These are useful for your customizations.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/sales-channel/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+salesChannel", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addOrderLineItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrderLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createDefaultsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createDefaultsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createSalesChannelsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createSalesChannelsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteSalesChannelsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteSalesChannelsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "importProductsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/importProductsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "linkSalesChannelsToApiKeyWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/linkSalesChannelsToApiKeyWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderClaimAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderEditAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderExchangeAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateSalesChannelsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateSalesChannelsWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+salesChannel", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createDefaultSalesChannelStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createDefaultSalesChannelStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createSalesChannelsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createSalesChannelsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteSalesChannelsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteSalesChannelsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "findSalesChannelStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/findSalesChannelStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "parseProductCsvStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/parseProductCsvStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateSalesChannelsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateSalesChannelsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "validateSalesChannelsExistStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateSalesChannelsExistStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/sales-channel/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+salesChannel", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Sales Channel Module.", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "salesChannel", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/salesChannel", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/sales-channel/events", - "title": "Events Reference", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/sales-channel/admin-widget-zones", - "title": "Admin Widget Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "sales-channel-service-reference", - "title": "Main Service Reference", - "childSidebarTitle": "Sales Channel Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/sales-channel", - "title": "Reference Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/sales_channel/ISalesChannelModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/sales-channel/createSalesChannels", - "title": "createSalesChannels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/sales-channel/deleteSalesChannels", - "title": "deleteSalesChannels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/sales-channel/listAndCountSalesChannels", - "title": "listAndCountSalesChannels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/sales-channel/listSalesChannels", - "title": "listSalesChannels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/sales-channel/restoreSalesChannels", - "title": "restoreSalesChannels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/sales-channel/retrieveSalesChannel", - "title": "retrieveSalesChannel", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/sales-channel/softDeleteSalesChannels", - "title": "softDeleteSalesChannels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/sales-channel/updateSalesChannels", - "title": "updateSalesChannels", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/sales-channel/upsertSalesChannels", - "title": "upsertSalesChannels", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "sales-channel-models-reference", - "title": "Data Models Reference", - "childSidebarTitle": "Sales Channel Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/sales-channel/models", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "autogenerate_path": "/references/sales_channel_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/sales-channel/models/SalesChannel", - "title": "SalesChannel", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "stock-location", - "title": "Stock Location Module", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/stock-location", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "autogenerate_tags": "concept+stockLocation", - "autogenerate_as_ref": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/stock-location/concepts", - "title": "Stock Location Concepts", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/stock-location/links-to-other-modules", - "title": "Links to Modules", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Inventory Kits", - "path": "https://docs.medusajs.com/resources/commerce-modules/inventory/inventory-kit", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Product Variant Inventory", - "path": "https://docs.medusajs.com/resources/commerce-modules/product/variant-inventory", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+stockLocation", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to utilize and manage Stock Location features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Locations & Shipping Overview", - "path": "https://docs.medusajs.com/user-guide/settings/locations-and-shipping", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Locations", - "path": "https://docs.medusajs.com/user-guide/settings/locations-and-shipping/locations", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "description": "Find references for tools and resources related to the Stock Location Module, such as data models, methods, and more. These are useful for your customizations.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/stock-location/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+stockLocation", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createStockLocationsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createStockLocationsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteStockLocationsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteStockLocationsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateStockLocationsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateStockLocationsWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+stockLocation", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createStockLocations", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createStockLocations", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteStockLocationsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteStockLocationsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateStockLocationsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateStockLocationsStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/stock-location/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+stockLocation", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Stock Location Module.", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "stockLocation", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/stockLocation", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/stock-location/admin-widget-zones", - "title": "Admin Widget Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "stock-location-service-reference", - "title": "Main Service Reference", - "childSidebarTitle": "Stock Location Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/stock_location_next/IStockLocationService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/createStockLocations", - "title": "createStockLocations", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/deleteStockLocationAddresses", - "title": "deleteStockLocationAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/deleteStockLocations", - "title": "deleteStockLocations", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/listAndCountStockLocations", - "title": "listAndCountStockLocations", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/listStockLocationAddresses", - "title": "listStockLocationAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/listStockLocations", - "title": "listStockLocations", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/restoreStockLocations", - "title": "restoreStockLocations", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/retrieveStockLocation", - "title": "retrieveStockLocation", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/softDeleteStockLocations", - "title": "softDeleteStockLocations", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/updateStockLocations", - "title": "updateStockLocations", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/upsertStockLocationAddresses", - "title": "upsertStockLocationAddresses", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/upsertStockLocations", - "title": "upsertStockLocations", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "stock-location-models-reference", - "title": "Data Models Reference", - "childSidebarTitle": "Stock Location Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/models", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "autogenerate_path": "/references/stock_location_next_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/models/StockLocation", - "title": "StockLocation", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/stock-location-next/models/StockLocationAddress", - "title": "StockLocationAddress", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "store", - "title": "Store Module", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/store", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/store/links-to-other-modules", - "title": "Link to Modules", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+store", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to utilize and manage Store features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Store", - "path": "https://docs.medusajs.com/user-guide/settings/store", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "description": "Find references for tools and resources related to the Store Module, such as data models, methods, and more. These are useful for your customizations.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/store/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+store", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addOrderLineItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addOrderLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createDefaultsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createDefaultsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createStoresWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createStoresWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteStoresWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteStoresWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderClaimAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderEditAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderExchangeAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateStoresWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateStoresWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+store", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createDefaultStoreStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createDefaultStoreStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createStoresStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createStoresStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteStoresStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteStoresStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "findOneOrAnyRegionStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/findOneOrAnyRegionStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "findSalesChannelStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/findSalesChannelStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateStoresStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateStoresStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/store/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+store", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Store Module.", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "store", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/store", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/store/admin-widget-zones", - "title": "Admin Widget Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "store-service-reference", - "title": "Main Service Reference", - "childSidebarTitle": "Store Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/store", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/store/IStoreModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/store/createStores", - "title": "createStores", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/store/deleteStores", - "title": "deleteStores", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/store/listAndCountStores", - "title": "listAndCountStores", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/store/listStores", - "title": "listStores", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/store/restoreStores", - "title": "restoreStores", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/store/retrieveStore", - "title": "retrieveStore", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/store/softDeleteStores", - "title": "softDeleteStores", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/store/updateStores", - "title": "updateStores", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/store/upsertStores", - "title": "upsertStores", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "store-models-reference", - "title": "Data Models Reference", - "childSidebarTitle": "Store Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/store/models", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "autogenerate_path": "/references/store_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/store/models/Store", - "title": "Store", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/store/models/StoreCurrency", - "title": "StoreCurrency", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "tax", - "title": "Tax Module", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/tax", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/tax/module-options", - "title": "Module Options", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Concepts", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/tax/tax-region", - "title": "Tax Region", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/tax/tax-rates-and-rules", - "title": "Tax Rates and Rules", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/tax/tax-calculation-with-provider", - "title": "Tax Calculation and Providers", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Server Guides", - "autogenerate_tags": "server+tax", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to use the Tax Module in your customizations on the Medusa application server.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create Tax Provider", - "path": "https://docs.medusajs.com/resources/references/tax/provider", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Get Variant Price with Taxes", - "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price-with-taxes", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/provider", - "title": "Tax Provider Reference", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Storefront Guides", - "autogenerate_tags": "storefront+tax,-jsSdk", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to integrate the Tax Module's features into your storefront.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Example: Show Price with Taxes", - "path": "https://docs.medusajs.com/resources/storefront-development/products/price/examples/tax-price", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+tax", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to utilize and manage Tax features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Tax Regions", - "path": "https://docs.medusajs.com/user-guide/settings/tax-regions", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "description": "Find references for tools and resources related to the Tax Module, such as data models, methods, and more. These are useful for your customizations.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/tax/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+tax", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addShippingMethodToCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addShippingMethodToCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "addToCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addToCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createClaimShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createClaimShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createExchangeShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createExchangeShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderEditShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderEditShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createOrderWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createReturnShippingMethodWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createReturnShippingMethodWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createTaxRateRulesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createTaxRateRulesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createTaxRatesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createTaxRatesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createTaxRegionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createTaxRegionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteLineItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteLineItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteTaxRateRulesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteTaxRateRulesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteTaxRatesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteTaxRatesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteTaxRegionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteTaxRegionsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderClaimAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderClaimAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderEditAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderEditAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "orderExchangeAddNewItemWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/orderExchangeAddNewItemWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refreshCartItemsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshCartItemsWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "setTaxRateRulesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/setTaxRateRulesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "transferCartCustomerWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/transferCartCustomerWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateLineItemInCartWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateLineItemInCartWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateOrderTaxLinesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateOrderTaxLinesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateTaxLinesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateTaxLinesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateTaxRatesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateTaxRatesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateTaxRegionsWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateTaxRegionsWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+tax", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createTaxRateRulesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createTaxRateRulesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createTaxRatesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createTaxRatesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createTaxRegionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createTaxRegionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteTaxRateRulesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteTaxRateRulesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteTaxRatesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteTaxRatesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteTaxRegionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteTaxRegionsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "getItemTaxLinesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/getItemTaxLinesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "listTaxRateRuleIdsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/listTaxRateRuleIdsStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateTaxRatesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateTaxRatesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateTaxRegionsStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateTaxRegionsStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/tax/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+tax", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the Tax Module.", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "taxRate", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/taxRate", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "taxRegion", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/taxRegion", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/tax/admin-widget-zones", - "title": "Admin Widget Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "tax-service-reference", - "title": "Main Service Reference", - "childSidebarTitle": "Tax Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/tax/ITaxModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/createTaxRateRules", - "title": "createTaxRateRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/createTaxRates", - "title": "createTaxRates", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/createTaxRegions", - "title": "createTaxRegions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/deleteTaxRateRules", - "title": "deleteTaxRateRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/deleteTaxRates", - "title": "deleteTaxRates", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/deleteTaxRegions", - "title": "deleteTaxRegions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/getTaxLines", - "title": "getTaxLines", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/listAndCountTaxRates", - "title": "listAndCountTaxRates", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/listTaxRateRules", - "title": "listTaxRateRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/listTaxRates", - "title": "listTaxRates", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/listTaxRegions", - "title": "listTaxRegions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/restoreTaxRateRules", - "title": "restoreTaxRateRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/restoreTaxRates", - "title": "restoreTaxRates", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/restoreTaxRegions", - "title": "restoreTaxRegions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/retrieveTaxRate", - "title": "retrieveTaxRate", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/softDeleteTaxRateRules", - "title": "softDeleteTaxRateRules", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/softDeleteTaxRates", - "title": "softDeleteTaxRates", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/softDeleteTaxRegions", - "title": "softDeleteTaxRegions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/updateTaxRates", - "title": "updateTaxRates", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/updateTaxRegions", - "title": "updateTaxRegions", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/upsertTaxRates", - "title": "upsertTaxRates", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "tax-models-reference", - "title": "Data Models Reference", - "childSidebarTitle": "Tax Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/models", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "autogenerate_path": "/references/tax_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/models/TaxProvider", - "title": "TaxProvider", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/models/TaxRate", - "title": "TaxRate", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/models/TaxRateRule", - "title": "TaxRateRule", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/tax/models/TaxRegion", - "title": "TaxRegion", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "user", - "title": "User Module", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/user", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/user/module-options", - "title": "Module Options", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Server Guides", - "autogenerate_tags": "server+user", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to use the User Module in your customizations on the Medusa application server.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/user/user-creation-flows", - "title": "User Creation Flows", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin User Guides", - "autogenerate_tags": "userGuide+user", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "description": "Learn how to utilize and manage User features in the Medusa Admin dashboard.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Invites", - "path": "https://docs.medusajs.com/user-guide/settings/users/invites", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Profile", - "path": "https://docs.medusajs.com/user-guide/settings/profile", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Manage Users", - "path": "https://docs.medusajs.com/user-guide/settings/users", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Reset Password", - "path": "https://docs.medusajs.com/user-guide/reset-password", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "description": "Find references for tools and resources related to the User Module, such as data models, methods, and more. These are useful for your customizations.", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/user/workflows", - "title": "Workflows", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflows", - "autogenerate_tags": "workflow+user", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "acceptInviteWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/acceptInviteWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createInvitesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createInvitesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createUserAccountWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createUserAccountWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createUsersWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createUsersWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteInvitesWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteInvitesWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteUsersWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteUsersWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refreshInviteTokensWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refreshInviteTokensWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "removeUserAccountWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeUserAccountWorkflow", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateUsersWorkflow", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateUsersWorkflow", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_tags": "step+user", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createInviteStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createInviteStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "createUsersStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/createUsersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteInvitesStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteInvitesStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "deleteUsersStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteUsersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "refreshInviteTokensStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/refreshInviteTokensStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "updateUsersStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/updateUsersStep", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "validateTokenStep", - "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/validateTokenStep", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/user/js-sdk", - "title": "JS SDK", - "hideChildren": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "jsSdk+admin+user", - "description": "The following methods or properties are used to send requests to Admin API Routes related to the User Module.", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "invite", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/invite", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "user", - "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/user", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/user/events", - "title": "Events Reference", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/user/admin-widget-zones", - "title": "Admin Widget Zones", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "user-service-reference", - "title": "Main Service Reference", - "childSidebarTitle": "User Module's Main Service Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/references/user/IUserModuleService/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/createInvites", - "title": "createInvites", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/createUsers", - "title": "createUsers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/deleteInvites", - "title": "deleteInvites", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/deleteUsers", - "title": "deleteUsers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/listAndCountInvites", - "title": "listAndCountInvites", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/listAndCountUsers", - "title": "listAndCountUsers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/listInvites", - "title": "listInvites", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/listUsers", - "title": "listUsers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/refreshInviteTokens", - "title": "refreshInviteTokens", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/restoreInvites", - "title": "restoreInvites", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/restoreUsers", - "title": "restoreUsers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/retrieveInvite", - "title": "retrieveInvite", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/retrieveUser", - "title": "retrieveUser", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/softDeleteInvites", - "title": "softDeleteInvites", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/softDeleteUsers", - "title": "softDeleteUsers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/updateInvites", - "title": "updateInvites", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/updateUsers", - "title": "updateUsers", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/validateInviteToken", - "title": "validateInviteToken", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "user-models-reference", - "title": "Data Models Reference", - "childSidebarTitle": "User Module Data Models Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/models", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Data Models", - "hasTitleStyling": true, - "autogenerate_path": "/references/user_models/variables", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/models/Invite", - "title": "Invite", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/user/models/User", - "title": "User", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "architectural-modules", - "title": "Architectural Modules", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Cache Modules", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/cache", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/cache/in-memory", - "title": "In-Memory", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/cache/redis", - "title": "Redis", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Guides", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/cache/create", - "title": "Create Cache Module", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Event Modules", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/event", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/event/local", - "title": "Local", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/event/redis", - "title": "Redis", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Guides", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/event/create", - "title": "Create Event Module", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "File Module Providers", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/file", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/file/local", - "title": "Local", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/file/s3", - "title": "AWS S3 (and Compatible APIs)", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Guides", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/file-provider-module", - "title": "Create File Provider", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Notification Module Providers", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/notification", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/notification/local", - "title": "Local", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/notification/sendgrid", - "title": "SendGrid", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Guides", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/notification-provider-module", - "title": "Create Notification Provider", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/integrations/guides/resend", - "title": "Integrate Resend", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/notification/send-notification", - "title": "Send Notification", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Workflow Engine Modules", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/workflow-engine", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/workflow-engine/in-memory", - "title": "In-Memory", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/workflow-engine/redis", - "title": "Redis", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "integrations", - "title": "Integrations", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/integrations", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Auth", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/auth/auth-providers/google", - "title": "Google", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/auth/auth-providers/github", - "title": "GitHub", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "CMS", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/integrations/guides/sanity", - "title": "Sanity", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "File", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/file/s3", - "title": "AWS", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Fulfillment", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/integrations/guides/shipstation", - "title": "ShipStation", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Notification", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/architectural-modules/notification/sendgrid", - "title": "SendGrid", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/integrations/guides/resend", - "title": "Resend", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Payment", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/commerce-modules/payment/payment-provider/stripe", - "title": "Stripe", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "plugins", - "title": "Plugins", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Overview", - "path": "/plugins", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "storefront-development", - "title": "Storefront Development", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "General", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/tips", - "title": "Tips", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/publishable-api-keys", - "title": "Publishable API Key", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Examples", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/guides/express-checkout", - "title": "Express Checkout Storefront", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Regions", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/regions", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/regions/list", - "title": "List Regions", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/regions/store-retrieve-region", - "title": "Store and Retrieve Regions", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/regions/context", - "title": "Region React Context", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Products", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/list", - "title": "List Products", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/retrieve", - "title": "Retrieve a Product", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/variants", - "title": "Select a Variant", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/price", - "title": "Retrieve Variant Prices", - "autogenerate_path": "storefront-development/products/price/examples", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/price/examples/show-price", - "title": "Example: Show Variant's Price", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/price/examples/sale-price", - "title": "Example: Show Sale Price", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/price/examples/tax-price", - "title": "Example: Show Price with Taxes", - "description": "", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/inventory", - "title": "Retrieve Variant Inventory", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Product Categories", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/categories/list", - "title": "List Categories", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/categories/retrieve", - "title": "Retrieve a Category", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/categories/products", - "title": "Retrieve a Category's Products", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/categories/nested-categories", - "title": "Retrieve Nested Categories", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Product Collections", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/collections/list", - "title": "List Collections", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/collections/retrieve", - "title": "Retrieve a Collection", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/products/collections/products", - "title": "Retrieve a Collection's Products", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Carts", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/cart/create", - "title": "Create Cart", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/cart/retrieve", - "title": "Retrieve Cart", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/cart/context", - "title": "Cart React Context", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/cart/update", - "title": "Update Cart", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/cart/manage-items", - "title": "Manage Line Items", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Checkout", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/checkout", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/checkout/email", - "title": "1. Enter Email", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/checkout/address", - "title": "2. Set Address", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/checkout/shipping", - "title": "3. Choose Shipping Method", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/checkout/payment", - "title": "4. Choose Payment Provider", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/checkout/payment/stripe", - "title": "Example: Stripe", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/checkout/complete-cart", - "title": "5. Complete Cart", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Customers", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/customers/register", - "title": "Register Customer", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/customers/login", - "title": "Login Customer", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/customers/third-party-login", - "title": "Third-Party (Social) Login", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/customers/reset-password", - "title": "Reset Password", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/customers/retrieve", - "title": "Retrieve Customer", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/customers/context", - "title": "Customer React Context", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/customers/profile", - "title": "Edit Customer Profile", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/customers/addresses", - "title": "Manage Customer Addresses", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/storefront-development/customers/log-out", - "title": "Log-out Customer", - "children": [] - } - ] - } - ] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "SDKs and Tools", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/create-medusa-app", - "title": "create-medusa-app", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "medusa-cli", - "title": "Medusa CLI", - "childSidebarTitle": "Medusa CLI Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/medusa-cli", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Commands", - "autogenerate_path": "medusa-cli/commands", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/medusa-cli/commands/new", - "title": "new", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/medusa-cli/commands/develop", - "title": "develop", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/medusa-cli/commands/start", - "title": "start", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/medusa-cli/commands/user", - "title": "user", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/medusa-cli/commands/build", - "title": "build", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/medusa-cli/commands/db", - "title": "db", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/medusa-cli/commands/plugin", - "title": "plugin", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/medusa-cli/commands/exec", - "title": "exec", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/medusa-cli/commands/start-cluster", - "title": "start-cluster", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/medusa-cli/commands/telemtry", - "title": "telemetry", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "js-sdk", - "title": "JS SDK", - "childSidebarTitle": "JS SDK Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/js-sdk", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Auth", - "autogenerate_path": "/references/js_sdk/auth/Auth/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/auth/callback", - "title": "callback", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/auth/login", - "title": "login", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/auth/logout", - "title": "logout", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/auth/refresh", - "title": "refresh", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/auth/register", - "title": "register", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/auth/resetPassword", - "title": "resetPassword", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/auth/updateProvider", - "title": "updateProvider", - "description": "", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Store", - "autogenerate_path": "/references/js_sdk/store/Store/properties", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/store/cart", - "title": "cart", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/store/category", - "title": "category", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/store/collection", - "title": "collection", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/store/customer", - "title": "customer", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/store/fulfillment", - "title": "fulfillment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/store/order", - "title": "order", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/store/payment", - "title": "payment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/store/product", - "title": "product", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/store/region", - "title": "region", - "description": "", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin", - "autogenerate_path": "/references/js_sdk/admin/Admin/properties", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/apiKey", - "title": "apiKey", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/campaign", - "title": "campaign", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/claim", - "title": "claim", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/currency", - "title": "currency", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/customer", - "title": "customer", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/customerGroup", - "title": "customerGroup", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/draftOrder", - "title": "draftOrder", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/exchange", - "title": "exchange", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/fulfillment", - "title": "fulfillment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/fulfillmentProvider", - "title": "fulfillmentProvider", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/fulfillmentSet", - "title": "fulfillmentSet", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/inventoryItem", - "title": "inventoryItem", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/invite", - "title": "invite", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/notification", - "title": "notification", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/order", - "title": "order", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/orderEdit", - "title": "orderEdit", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/payment", - "title": "payment", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/paymentCollection", - "title": "paymentCollection", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/priceList", - "title": "priceList", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/pricePreference", - "title": "pricePreference", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/product", - "title": "product", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/productCategory", - "title": "productCategory", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/productCollection", - "title": "productCollection", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/productTag", - "title": "productTag", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/productType", - "title": "productType", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/productVariant", - "title": "productVariant", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/promotion", - "title": "promotion", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/refundReason", - "title": "refundReason", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/region", - "title": "region", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/reservation", - "title": "reservation", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/return", - "title": "return", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/returnReason", - "title": "returnReason", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/salesChannel", - "title": "salesChannel", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/shippingOption", - "title": "shippingOption", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/shippingProfile", - "title": "shippingProfile", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/stockLocation", - "title": "stockLocation", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/store", - "title": "store", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/taxRate", - "title": "taxRate", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/taxRegion", - "title": "taxRegion", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/upload", - "title": "upload", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/user", - "title": "user", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/js-sdk/admin/workflowExecution", - "title": "workflowExecution", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "nextjs-starter", - "title": "Next.js Starter Storefront", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/nextjs-starter", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Payment", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/nextjs-starter/guides/customize-stripe", - "title": "Customize Stripe Integration", - "children": [] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "General", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "troubleshooting", - "title": "Troubleshooting", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/troubleshooting", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Installation", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/troubleshooting/create-medusa-app-errors", - "title": "Create Medusa App Errors", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/troubleshooting/errors-installing-cli", - "title": "Errors Installing CLI", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/troubleshooting/general-errors", - "title": "General Errors", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Medusa Application", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/troubleshooting/eaddrinuse", - "title": "EADDRINUSE Error", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/troubleshooting/database-errors", - "title": "Database Errors", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/troubleshooting/dist-imports", - "title": "Importing from /dist", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/troubleshooting/workflow-errors", - "title": "Workflow Errors", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/troubleshooting/test-errors", - "title": "Test Errors", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin Development", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/troubleshooting/medusa-admin/no-widget-route", - "title": "Widget or Route not Showing", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Upgrade", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/troubleshooting/errors-after-upgrading", - "title": "Errors After Upgrading", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Frontend", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/troubleshooting/cors-errors", - "title": "CORS Errors", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Integrations", - "hasTitleStyling": true, - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/troubleshooting/s3", - "title": "S3 Module Provider Errors", - "children": [] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Admin", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/admin-widget-injection-zones", - "title": "Admin Widget Injection Zones", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Lists", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/medusa-container-resources", - "title": "Container Dependencies", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/events-reference", - "title": "Events List", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "References", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "workflows-sdk-reference", - "title": "Workflows SDK", - "childSidebarTitle": "Workflows SDK Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/workflows", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Functions", - "autogenerate_path": "/references/workflows/functions", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/workflows/createHook", - "title": "createHook", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/workflows/createStep", - "title": "createStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/workflows/createWorkflow", - "title": "createWorkflow", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/workflows/parallelize", - "title": "parallelize", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/workflows/transform", - "title": "transform", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "dml-reference", - "title": "Data Model Language", - "childSidebarTitle": "Data Model Language Reference", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/define", - "title": "Define Method", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Property Types", - "autogenerate_path": "/references/dml/Property_Types/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-types/array", - "title": "array", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-types/bignumber", - "title": "bigNumber", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-types/boolean", - "title": "boolean", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-types/datetime", - "title": "dateTime", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-types/enum", - "title": "enum", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-types/float", - "title": "float", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-types/id", - "title": "id", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-types/json", - "title": "json", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-types/number", - "title": "number", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-types/text", - "title": "text", - "description": "", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Relationship Methods", - "autogenerate_path": "/references/dml/Relationship_Methods/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/relationship-methods/belongsto", - "title": "belongsTo", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/relationship-methods/hasmany", - "title": "hasMany", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/relationship-methods/hasone", - "title": "hasOne", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/relationship-methods/manytomany", - "title": "manyToMany", - "description": "", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Model Methods", - "autogenerate_path": "/references/dml/Model_Methods/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/model-methods/cascades", - "title": "cascades", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/model-methods/indexes", - "title": "indexes", - "description": "", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Property Configuration Methods", - "autogenerate_path": "/references/dml/Property_Configuration_Methods/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-configuration/computed", - "title": "computed", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-configuration/default", - "title": "default", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-configuration/index", - "title": "index", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-configuration/nullable", - "title": "nullable", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/data-model/property-configuration/unique", - "title": "unique", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "service-factory-reference", - "title": "Service Factory", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/service-factory-reference", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Methods", - "autogenerate_path": "/service-factory-reference/methods", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/service-factory-reference/methods/create", - "title": "create", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/service-factory-reference/methods/delete", - "title": "delete", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/service-factory-reference/methods/list", - "title": "list", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/service-factory-reference/methods/listAndCount", - "title": "listAndCount", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/service-factory-reference/methods/restore", - "title": "restore", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/service-factory-reference/methods/retrieve", - "title": "retrieve", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/service-factory-reference/methods/soft-delete", - "title": "softDelete", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/service-factory-reference/methods/update", - "title": "update", - "description": "", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Tips", - "autogenerate_path": "/service-factory-reference/tips", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/service-factory-reference/tips/filtering", - "title": "Filtering", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "helper-steps-reference", - "title": "Helper Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/helper-steps", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Steps", - "autogenerate_path": "/references/helper_steps/functions", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/helper-steps/createRemoteLinkStep", - "title": "createRemoteLinkStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/helper-steps/dismissRemoteLinkStep", - "title": "dismissRemoteLinkStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/helper-steps/emitEventStep", - "title": "emitEventStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/helper-steps/removeRemoteLinkStep", - "title": "removeRemoteLinkStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/helper-steps/updateRemoteLinksStep", - "title": "updateRemoteLinksStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/helper-steps/useQueryGraphStep", - "title": "useQueryGraphStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/helper-steps/useRemoteQueryStep", - "title": "useRemoteQueryStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/helper-steps/validatePresenceOfStep", - "title": "validatePresenceOfStep", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "core-flows", - "title": "Core Workflows", - "custom_autogenerate": "core-flows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Overview", - "path": "/medusa-workflows-reference", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Api Key", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createApiKeysWorkflow", - "title": "createApiKeysWorkflow", - "description": "Create secret or publishable API keys.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteApiKeysWorkflow", - "title": "deleteApiKeysWorkflow", - "description": "Delete secret or publishable API keys.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/linkSalesChannelsToApiKeyWorkflow", - "title": "linkSalesChannelsToApiKeyWorkflow", - "description": "Manage the sales channels of a publishable API key.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/revokeApiKeysWorkflow", - "title": "revokeApiKeysWorkflow", - "description": "Revoke secret or publishable API keys.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateApiKeysWorkflow", - "title": "updateApiKeysWorkflow", - "description": "Update secret or publishable API keys.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createApiKeysStep", - "title": "createApiKeysStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteApiKeysStep", - "title": "deleteApiKeysStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/linkSalesChannelsToApiKeyStep", - "title": "linkSalesChannelsToApiKeyStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/revokeApiKeysStep", - "title": "revokeApiKeysStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateApiKeysStep", - "title": "updateApiKeysStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateSalesChannelsExistStep", - "title": "validateSalesChannelsExistStep", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Auth", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/generateResetPasswordTokenWorkflow", - "title": "generateResetPasswordTokenWorkflow", - "description": "Generate a reset password token for a user or customer.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/setAuthAppMetadataStep", - "title": "setAuthAppMetadataStep", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Cart", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/addShippingMethodToCartWorkflow", - "title": "addShippingMethodToCartWorkflow", - "description": "Add a shipping method to a cart.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/addToCartWorkflow", - "title": "addToCartWorkflow", - "description": "Add a line item to a cart.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/completeCartWorkflow", - "title": "completeCartWorkflow", - "description": "Complete a cart and place an order.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/confirmVariantInventoryWorkflow", - "title": "confirmVariantInventoryWorkflow", - "description": "Validate that a variant is in-stock before adding to the cart.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createCartCreditLinesWorkflow", - "title": "createCartCreditLinesWorkflow", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createCartWorkflow", - "title": "createCartWorkflow", - "description": "Create a cart specifying region, items, and more.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createPaymentCollectionForCartWorkflow", - "title": "createPaymentCollectionForCartWorkflow", - "description": "Create payment collection for cart.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteCartCreditLinesWorkflow", - "title": "deleteCartCreditLinesWorkflow", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/listShippingOptionsForCartWithPricingWorkflow", - "title": "listShippingOptionsForCartWithPricingWorkflow", - "description": "List a cart's shipping options with prices.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/listShippingOptionsForCartWorkflow", - "title": "listShippingOptionsForCartWorkflow", - "description": "List a cart's shipping options.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/refreshCartItemsWorkflow", - "title": "refreshCartItemsWorkflow", - "description": "Refresh a cart's details after an update.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/refreshCartShippingMethodsWorkflow", - "title": "refreshCartShippingMethodsWorkflow", - "description": "Refresh a cart's shipping methods after an update.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/refreshPaymentCollectionForCartWorkflow", - "title": "refreshPaymentCollectionForCartWorkflow", - "description": "Refresh a cart's payment collection details.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/transferCartCustomerWorkflow", - "title": "transferCartCustomerWorkflow", - "description": "Refresh a cart's payment collection details.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateCartPromotionsWorkflow", - "title": "updateCartPromotionsWorkflow", - "description": "Update a cart's applied promotions to add, replace, or remove them.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateCartWorkflow", - "title": "updateCartWorkflow", - "description": "Update a cart's details, such as region, address, and more.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateLineItemInCartWorkflow", - "title": "updateLineItemInCartWorkflow", - "description": "Update a cart's line item.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateTaxLinesWorkflow", - "title": "updateTaxLinesWorkflow", - "description": "Update a cart's tax lines.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/addShippingMethodToCartStep", - "title": "addShippingMethodToCartStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/confirmInventoryStep", - "title": "confirmInventoryStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createCartsStep", - "title": "createCartsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createLineItemAdjustmentsStep", - "title": "createLineItemAdjustmentsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createLineItemsStep", - "title": "createLineItemsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createPaymentCollectionsStep", - "title": "createPaymentCollectionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createShippingMethodAdjustmentsStep", - "title": "createShippingMethodAdjustmentsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/findOneOrAnyRegionStep", - "title": "findOneOrAnyRegionStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/findOrCreateCustomerStep", - "title": "findOrCreateCustomerStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/findSalesChannelStep", - "title": "findSalesChannelStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/getActionsToComputeFromPromotionsStep", - "title": "getActionsToComputeFromPromotionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/getLineItemActionsStep", - "title": "getLineItemActionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/getPromotionCodesToApply", - "title": "getPromotionCodesToApply", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/getVariantPriceSetsStep", - "title": "getVariantPriceSetsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/getVariantsStep", - "title": "getVariantsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/prepareAdjustmentsFromPromotionActionsStep", - "title": "prepareAdjustmentsFromPromotionActionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/removeLineItemAdjustmentsStep", - "title": "removeLineItemAdjustmentsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/removeShippingMethodAdjustmentsStep", - "title": "removeShippingMethodAdjustmentsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/removeShippingMethodFromCartStep", - "title": "removeShippingMethodFromCartStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/reserveInventoryStep", - "title": "reserveInventoryStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/retrieveCartStep", - "title": "retrieveCartStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/setTaxLinesForItemsStep", - "title": "setTaxLinesForItemsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateCartPromotionsStep", - "title": "updateCartPromotionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateCartsStep", - "title": "updateCartsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateLineItemsStep", - "title": "updateLineItemsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateShippingMethodsStep", - "title": "updateShippingMethodsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateAndReturnShippingMethodsDataStep", - "title": "validateAndReturnShippingMethodsDataStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateCartPaymentsStep", - "title": "validateCartPaymentsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateCartShippingOptionsPriceStep", - "title": "validateCartShippingOptionsPriceStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateCartShippingOptionsStep", - "title": "validateCartShippingOptionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateCartStep", - "title": "validateCartStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateLineItemPricesStep", - "title": "validateLineItemPricesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateShippingStep", - "title": "validateShippingStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateVariantPricesStep", - "title": "validateVariantPricesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/validateExistingPaymentCollectionStep", - "title": "validateExistingPaymentCollectionStep", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Common", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/batchLinksWorkflow", - "title": "batchLinksWorkflow", - "description": "Manage links between two records of linked data models.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createLinksWorkflow", - "title": "createLinksWorkflow", - "description": "Create links between two records of linked data models.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/dismissLinksWorkflow", - "title": "dismissLinksWorkflow", - "description": "Dismiss links between two records of linked data models.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateLinksWorkflow", - "title": "updateLinksWorkflow", - "description": "Update links between two records of linked data models.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createRemoteLinkStep", - "title": "createRemoteLinkStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/dismissRemoteLinkStep", - "title": "dismissRemoteLinkStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/emitEventStep", - "title": "emitEventStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/removeRemoteLinkStep", - "title": "removeRemoteLinkStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateRemoteLinksStep", - "title": "updateRemoteLinksStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/useQueryGraphStep", - "title": "useQueryGraphStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/useRemoteQueryStep", - "title": "useRemoteQueryStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validatePresenceOfStep", - "title": "validatePresenceOfStep", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Customer", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createCustomerAccountWorkflow", - "title": "createCustomerAccountWorkflow", - "description": "Create or register a customer account.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createCustomerAddressesWorkflow", - "title": "createCustomerAddressesWorkflow", - "description": "Create one or more customer addresses.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createCustomersWorkflow", - "title": "createCustomersWorkflow", - "description": "Create one or more customers.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteCustomerAddressesWorkflow", - "title": "deleteCustomerAddressesWorkflow", - "description": "Delete one or more customer addresses.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteCustomersWorkflow", - "title": "deleteCustomersWorkflow", - "description": "Delete one or more customers.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeCustomerAccountWorkflow", - "title": "removeCustomerAccountWorkflow", - "description": "Delete a customer account and its auth identity association.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateCustomerAddressesWorkflow", - "title": "updateCustomerAddressesWorkflow", - "description": "Update one or more customer addresses.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateCustomersWorkflow", - "title": "updateCustomersWorkflow", - "description": "Update one or more customers.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createCustomerAddressesStep", - "title": "createCustomerAddressesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createCustomersStep", - "title": "createCustomersStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteCustomerAddressesStep", - "title": "deleteCustomerAddressesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteCustomersStep", - "title": "deleteCustomersStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/maybeUnsetDefaultBillingAddressesStep", - "title": "maybeUnsetDefaultBillingAddressesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/maybeUnsetDefaultShippingAddressesStep", - "title": "maybeUnsetDefaultShippingAddressesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateCustomerAddressesStep", - "title": "updateCustomerAddressesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateCustomersStep", - "title": "updateCustomersStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateCustomerAccountCreation", - "title": "validateCustomerAccountCreation", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Customer Group", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createCustomerGroupsWorkflow", - "title": "createCustomerGroupsWorkflow", - "description": "Create one or more customer groups.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteCustomerGroupsWorkflow", - "title": "deleteCustomerGroupsWorkflow", - "description": "Delete one or more customer groups.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/linkCustomerGroupsToCustomerWorkflow", - "title": "linkCustomerGroupsToCustomerWorkflow", - "description": "Manage groups of a customer.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/linkCustomersToCustomerGroupWorkflow", - "title": "linkCustomersToCustomerGroupWorkflow", - "description": "Manage the customers of a customer group.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateCustomerGroupsWorkflow", - "title": "updateCustomerGroupsWorkflow", - "description": "Update one or more customer groups.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createCustomerGroupsStep", - "title": "createCustomerGroupsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteCustomerGroupStep", - "title": "deleteCustomerGroupStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/linkCustomerGroupsToCustomerStep", - "title": "linkCustomerGroupsToCustomerStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/linkCustomersToCustomerGroupStep", - "title": "linkCustomersToCustomerGroupStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateCustomerGroupsStep", - "title": "updateCustomerGroupsStep", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Defaults", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createDefaultsWorkflow", - "title": "createDefaultsWorkflow", - "description": "Create default data for a Medusa application.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createDefaultStoreStep", - "title": "createDefaultStoreStep", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "File", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteFilesWorkflow", - "title": "deleteFilesWorkflow", - "description": "Delete files from the database and storage.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/uploadFilesWorkflow", - "title": "uploadFilesWorkflow", - "description": "Upload files using the installed File Module Provider.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteFilesStep", - "title": "deleteFilesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/uploadFilesStep", - "title": "uploadFilesStep", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Fulfillment", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/batchShippingOptionRulesWorkflow", - "title": "batchShippingOptionRulesWorkflow", - "description": "Manage shipping option rules.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/calculateShippingOptionsPricesWorkflow", - "title": "calculateShippingOptionsPricesWorkflow", - "description": "Calculate shipping option prices in a cart.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelFulfillmentWorkflow", - "title": "cancelFulfillmentWorkflow", - "description": "Cancel a fulfillment.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createFulfillmentWorkflow", - "title": "createFulfillmentWorkflow", - "description": "Create a fulfillment.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createReturnFulfillmentWorkflow", - "title": "createReturnFulfillmentWorkflow", - "description": "Create a fulfillment for a return.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createServiceZonesWorkflow", - "title": "createServiceZonesWorkflow", - "description": "Create one or more service zones.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createShipmentWorkflow", - "title": "createShipmentWorkflow", - "description": "Create a shipment for a fulfillment.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createShippingOptionsWorkflow", - "title": "createShippingOptionsWorkflow", - "description": "Create shipping options.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createShippingProfilesWorkflow", - "title": "createShippingProfilesWorkflow", - "description": "Create one or more shipping profiles.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteFulfillmentSetsWorkflow", - "title": "deleteFulfillmentSetsWorkflow", - "description": "Delete one or more fulfillment sets.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteServiceZonesWorkflow", - "title": "deleteServiceZonesWorkflow", - "description": "Delete one or more service zones.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteShippingOptionsWorkflow", - "title": "deleteShippingOptionsWorkflow", - "description": "Delete one or more shipping options.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/markFulfillmentAsDeliveredWorkflow", - "title": "markFulfillmentAsDeliveredWorkflow", - "description": "Mark a fulfillment as delivered.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateFulfillmentWorkflow", - "title": "updateFulfillmentWorkflow", - "description": "Update a fulfillment.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateServiceZonesWorkflow", - "title": "updateServiceZonesWorkflow", - "description": "Update one or more service zones.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateShippingOptionsWorkflow", - "title": "updateShippingOptionsWorkflow", - "description": "Update one or more shipping options.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateShippingProfilesWorkflow", - "title": "updateShippingProfilesWorkflow", - "description": "Update one or more shipping profiles.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/buildPriceSet", - "title": "buildPriceSet", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/calculateShippingOptionsPricesStep", - "title": "calculateShippingOptionsPricesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/cancelFulfillmentStep", - "title": "cancelFulfillmentStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createFulfillmentSets", - "title": "createFulfillmentSets", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createFulfillmentStep", - "title": "createFulfillmentStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createReturnFulfillmentStep", - "title": "createReturnFulfillmentStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createServiceZonesStep", - "title": "createServiceZonesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createShippingOptionRulesStep", - "title": "createShippingOptionRulesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createShippingOptionsPriceSetsStep", - "title": "createShippingOptionsPriceSetsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createShippingProfilesStep", - "title": "createShippingProfilesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteFulfillmentSetsStep", - "title": "deleteFulfillmentSetsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteServiceZonesStep", - "title": "deleteServiceZonesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteShippingOptionRulesStep", - "title": "deleteShippingOptionRulesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteShippingOptionsStep", - "title": "deleteShippingOptionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/setShippingOptionsPricesStep", - "title": "setShippingOptionsPricesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateFulfillmentStep", - "title": "updateFulfillmentStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateServiceZonesStep", - "title": "updateServiceZonesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateShippingOptionRulesStep", - "title": "updateShippingOptionRulesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateShippingProfilesStep", - "title": "updateShippingProfilesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/upsertShippingOptionsStep", - "title": "upsertShippingOptionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateShipmentStep", - "title": "validateShipmentStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateShippingOptionPricesStep", - "title": "validateShippingOptionPricesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/validateFulfillmentDeliverabilityStep", - "title": "validateFulfillmentDeliverabilityStep", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Inventory", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/batchInventoryItemLevelsWorkflow", - "title": "batchInventoryItemLevelsWorkflow", - "description": "Manage inventory levels in bulk.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/bulkCreateDeleteLevelsWorkflow", - "title": "bulkCreateDeleteLevelsWorkflow", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createInventoryItemsWorkflow", - "title": "createInventoryItemsWorkflow", - "description": "Create one or more inventory items.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createInventoryLevelsWorkflow", - "title": "createInventoryLevelsWorkflow", - "description": "Create one or more inventory levels.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteInventoryItemWorkflow", - "title": "deleteInventoryItemWorkflow", - "description": "Delete one or more inventory items.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteInventoryLevelsWorkflow", - "title": "deleteInventoryLevelsWorkflow", - "description": "Delete one or more inventory levels.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateInventoryItemsWorkflow", - "title": "updateInventoryItemsWorkflow", - "description": "Update one or more inventory items.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateInventoryLevelsWorkflow", - "title": "updateInventoryLevelsWorkflow", - "description": "Update one or more inventory levels.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/adjustInventoryLevelsStep", - "title": "adjustInventoryLevelsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/attachInventoryItemToVariants", - "title": "attachInventoryItemToVariants", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createInventoryItemsStep", - "title": "createInventoryItemsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createInventoryLevelsStep", - "title": "createInventoryLevelsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteInventoryItemStep", - "title": "deleteInventoryItemStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteInventoryLevelsStep", - "title": "deleteInventoryLevelsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateInventoryItemsStep", - "title": "updateInventoryItemsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateInventoryLevelsStep", - "title": "updateInventoryLevelsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateInventoryDeleteStep", - "title": "validateInventoryDeleteStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateInventoryItemsForCreate", - "title": "validateInventoryItemsForCreate", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateInventoryLocationsStep", - "title": "validateInventoryLocationsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/validateInventoryLevelsDelete", - "title": "validateInventoryLevelsDelete", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Invite", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/acceptInviteWorkflow", - "title": "acceptInviteWorkflow", - "description": "Accept invite and create user.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createInvitesWorkflow", - "title": "createInvitesWorkflow", - "description": "Create one or more user invites.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteInvitesWorkflow", - "title": "deleteInvitesWorkflow", - "description": "Delete one or more user invites.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/refreshInviteTokensWorkflow", - "title": "refreshInviteTokensWorkflow", - "description": "Refresh user invite tokens.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createInviteStep", - "title": "createInviteStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteInvitesStep", - "title": "deleteInvitesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/refreshInviteTokensStep", - "title": "refreshInviteTokensStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateTokenStep", - "title": "validateTokenStep", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Line Item", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteLineItemsWorkflow", - "title": "deleteLineItemsWorkflow", - "description": "Delete line items from a cart.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteLineItemsStep", - "title": "deleteLineItemsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/listLineItemsStep", - "title": "listLineItemsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateLineItemsStepWithSelector", - "title": "updateLineItemsStepWithSelector", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Notification", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/notifyOnFailureStep", - "title": "notifyOnFailureStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/sendNotificationsStep", - "title": "sendNotificationsStep", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Order", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/acceptOrderTransferWorkflow", - "title": "acceptOrderTransferWorkflow", - "description": "Accept an order transfer request.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/addOrderLineItemsWorkflow", - "title": "addOrderLineItemsWorkflow", - "description": "Add line items to an order.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/archiveOrderWorkflow", - "title": "archiveOrderWorkflow", - "description": "Archive one or more orders.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/beginClaimOrderWorkflow", - "title": "beginClaimOrderWorkflow", - "description": "Create an order claim in requested state.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/beginExchangeOrderWorkflow", - "title": "beginExchangeOrderWorkflow", - "description": "Request an order exchange.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/beginOrderEditOrderWorkflow", - "title": "beginOrderEditOrderWorkflow", - "description": "Create an order edit request.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/beginReceiveReturnWorkflow", - "title": "beginReceiveReturnWorkflow", - "description": "Request a return receival.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/beginReturnOrderWorkflow", - "title": "beginReturnOrderWorkflow", - "description": "Create a return for an order.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelBeginOrderClaimWorkflow", - "title": "cancelBeginOrderClaimWorkflow", - "description": "Cancel a requested order claim.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelBeginOrderEditWorkflow", - "title": "cancelBeginOrderEditWorkflow", - "description": "Cancel a requested order edit.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelBeginOrderExchangeWorkflow", - "title": "cancelBeginOrderExchangeWorkflow", - "description": "Cancel a requested order exchange.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelOrderChangeWorkflow", - "title": "cancelOrderChangeWorkflow", - "description": "Cancel an order change.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelOrderClaimWorkflow", - "title": "cancelOrderClaimWorkflow", - "description": "Cancel a confirmed order claim.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelOrderExchangeWorkflow", - "title": "cancelOrderExchangeWorkflow", - "description": "Cancel an exchange for an order.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelOrderFulfillmentWorkflow", - "title": "cancelOrderFulfillmentWorkflow", - "description": "Cancel an order's fulfillment.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelOrderTransferRequestWorkflow", - "title": "cancelOrderTransferRequestWorkflow", - "description": "Cancel an order transfer request.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelOrderWorkflow", - "title": "cancelOrderWorkflow", - "description": "Cancel an order.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelReturnReceiveWorkflow", - "title": "cancelReturnReceiveWorkflow", - "description": "Cancel a return receival.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelReturnRequestWorkflow", - "title": "cancelReturnRequestWorkflow", - "description": "Cancel a requested return.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelReturnWorkflow", - "title": "cancelReturnWorkflow", - "description": "Cancel a return.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/completeOrderWorkflow", - "title": "completeOrderWorkflow", - "description": "Complete one or more orders.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/confirmClaimRequestWorkflow", - "title": "confirmClaimRequestWorkflow", - "description": "Confirm a requested claim.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/confirmExchangeRequestWorkflow", - "title": "confirmExchangeRequestWorkflow", - "description": "Confirm an exchange request.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/confirmOrderEditRequestWorkflow", - "title": "confirmOrderEditRequestWorkflow", - "description": "Confirm an order edit request.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/confirmReturnReceiveWorkflow", - "title": "confirmReturnReceiveWorkflow", - "description": "Confirm a return receival request.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/confirmReturnRequestWorkflow", - "title": "confirmReturnRequestWorkflow", - "description": "Confirm a return request.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createAndCompleteReturnOrderWorkflow", - "title": "createAndCompleteReturnOrderWorkflow", - "description": "Create and complete a return for an order.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createClaimShippingMethodWorkflow", - "title": "createClaimShippingMethodWorkflow", - "description": "Create an inbound or outbound shipping method for a claim.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createExchangeShippingMethodWorkflow", - "title": "createExchangeShippingMethodWorkflow", - "description": "Create an inbound or outbound shipping method for an exchange.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createOrUpdateOrderPaymentCollectionWorkflow", - "title": "createOrUpdateOrderPaymentCollectionWorkflow", - "description": "Create or update payment collection for an order.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createOrderChangeActionsWorkflow", - "title": "createOrderChangeActionsWorkflow", - "description": "Create an order change action.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createOrderChangeWorkflow", - "title": "createOrderChangeWorkflow", - "description": "Create an order change.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createOrderEditShippingMethodWorkflow", - "title": "createOrderEditShippingMethodWorkflow", - "description": "Create a shipping method for an order edit.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createOrderFulfillmentWorkflow", - "title": "createOrderFulfillmentWorkflow", - "description": "Creates a fulfillment for an order.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createOrderPaymentCollectionWorkflow", - "title": "createOrderPaymentCollectionWorkflow", - "description": "Create a payment collection for an order.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createOrderShipmentWorkflow", - "title": "createOrderShipmentWorkflow", - "description": "Creates a shipment for an order.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createOrderWorkflow", - "title": "createOrderWorkflow", - "description": "Create an order.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createOrdersWorkflow", - "title": "createOrdersWorkflow", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createReturnShippingMethodWorkflow", - "title": "createReturnShippingMethodWorkflow", - "description": "Create a shipping method for a return.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/declineOrderChangeWorkflow", - "title": "declineOrderChangeWorkflow", - "description": "Decline an order change.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/declineOrderTransferRequestWorkflow", - "title": "declineOrderTransferRequestWorkflow", - "description": "Decline a requested order transfer.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteOrderChangeActionsWorkflow", - "title": "deleteOrderChangeActionsWorkflow", - "description": "Delete one or more order change actions.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteOrderChangeWorkflow", - "title": "deleteOrderChangeWorkflow", - "description": "Delete one or more order changes.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/dismissItemReturnRequestWorkflow", - "title": "dismissItemReturnRequestWorkflow", - "description": "Dismiss items from a return request.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/getOrderDetailWorkflow", - "title": "getOrderDetailWorkflow", - "description": "Retrieve an order's details.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/getOrdersListWorkflow", - "title": "getOrdersListWorkflow", - "description": "Retrieve a list of orders.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/markOrderFulfillmentAsDeliveredWorkflow", - "title": "markOrderFulfillmentAsDeliveredWorkflow", - "description": "Mark a fulfillment in an order as delivered.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/orderClaimAddNewItemWorkflow", - "title": "orderClaimAddNewItemWorkflow", - "description": "Add outbound or new items to a claim.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/orderClaimItemWorkflow", - "title": "orderClaimItemWorkflow", - "description": "Add order items to a claim as claim items.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/orderClaimRequestItemReturnWorkflow", - "title": "orderClaimRequestItemReturnWorkflow", - "description": "Request one or more items to be returned as part of a claim.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/orderEditAddNewItemWorkflow", - "title": "orderEditAddNewItemWorkflow", - "description": "Add new items to an order edit.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/orderEditUpdateItemQuantityWorkflow", - "title": "orderEditUpdateItemQuantityWorkflow", - "description": "Update the quantity of an existing order item in the order's edit.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/orderExchangeAddNewItemWorkflow", - "title": "orderExchangeAddNewItemWorkflow", - "description": "Add new or outbound items to an exchange.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/orderExchangeRequestItemReturnWorkflow", - "title": "orderExchangeRequestItemReturnWorkflow", - "description": "Add inbound items to be returned as part of the exchange.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/receiveAndCompleteReturnOrderWorkflow", - "title": "receiveAndCompleteReturnOrderWorkflow", - "description": "Receive and complete a return.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/receiveItemReturnRequestWorkflow", - "title": "receiveItemReturnRequestWorkflow", - "description": "Mark return items as received.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeAddItemClaimActionWorkflow", - "title": "removeAddItemClaimActionWorkflow", - "description": "Remove outbound (new) items from a claim.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeClaimShippingMethodWorkflow", - "title": "removeClaimShippingMethodWorkflow", - "description": "Remove an inbound or outbound shipping method from a claim.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeExchangeShippingMethodWorkflow", - "title": "removeExchangeShippingMethodWorkflow", - "description": "Remove an inbound or outbound shipping method from an exchange.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeItemClaimActionWorkflow", - "title": "removeItemClaimActionWorkflow", - "description": "Remove order items from a claim.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeItemExchangeActionWorkflow", - "title": "removeItemExchangeActionWorkflow", - "description": "Remove an outbound or new item from an exchange.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeItemOrderEditActionWorkflow", - "title": "removeItemOrderEditActionWorkflow", - "description": "Remove an item that was added to an order edit.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeItemReceiveReturnActionWorkflow", - "title": "removeItemReceiveReturnActionWorkflow", - "description": "Remove an item from a return receival.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeItemReturnActionWorkflow", - "title": "removeItemReturnActionWorkflow", - "description": "Remove an item from a return.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeOrderEditShippingMethodWorkflow", - "title": "removeOrderEditShippingMethodWorkflow", - "description": "Remove a shipping method from an order edit.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeReturnShippingMethodWorkflow", - "title": "removeReturnShippingMethodWorkflow", - "description": "Remove a shipping method from a return.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/requestItemReturnWorkflow", - "title": "requestItemReturnWorkflow", - "description": "Add items to a return.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/requestOrderEditRequestWorkflow", - "title": "requestOrderEditRequestWorkflow", - "description": "Request an order edit.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/requestOrderTransferWorkflow", - "title": "requestOrderTransferWorkflow", - "description": "Request a transfer of an order to a customer.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateClaimAddItemWorkflow", - "title": "updateClaimAddItemWorkflow", - "description": "Update a claim's new or outbound item.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateClaimItemWorkflow", - "title": "updateClaimItemWorkflow", - "description": "Update a claim item, added to the claim from an order item.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateClaimShippingMethodWorkflow", - "title": "updateClaimShippingMethodWorkflow", - "description": "Update an inbound or outbound shipping method of a claim.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateExchangeAddItemWorkflow", - "title": "updateExchangeAddItemWorkflow", - "description": "Update an outbound or new item in an exchange.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateExchangeShippingMethodWorkflow", - "title": "updateExchangeShippingMethodWorkflow", - "description": "Update an exchange's inbound or outbound shipping method.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateOrderChangeActionsWorkflow", - "title": "updateOrderChangeActionsWorkflow", - "description": "Update one or more order change actions.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateOrderChangesWorkflow", - "title": "updateOrderChangesWorkflow", - "description": "Update one or more order changes.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateOrderEditAddItemWorkflow", - "title": "updateOrderEditAddItemWorkflow", - "description": "Update a new item in an order edit.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateOrderEditItemQuantityWorkflow", - "title": "updateOrderEditItemQuantityWorkflow", - "description": "Update an existing order item previously added to an order edit.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateOrderEditShippingMethodWorkflow", - "title": "updateOrderEditShippingMethodWorkflow", - "description": "Update a shipping method of an order edit.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateOrderTaxLinesWorkflow", - "title": "updateOrderTaxLinesWorkflow", - "description": "Update the tax lines of items and shipping methods in an order.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateOrderWorkflow", - "title": "updateOrderWorkflow", - "description": "Update an order's details.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateReceiveItemReturnRequestWorkflow", - "title": "updateReceiveItemReturnRequestWorkflow", - "description": "Update an item in a return receival request.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateRequestItemReturnWorkflow", - "title": "updateRequestItemReturnWorkflow", - "description": "Update a requested item in a return.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateReturnShippingMethodWorkflow", - "title": "updateReturnShippingMethodWorkflow", - "description": "Update the shipping method of a return.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateReturnWorkflow", - "title": "updateReturnWorkflow", - "description": "Update a return's details.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/addOrderTransactionStep", - "title": "addOrderTransactionStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/archiveOrdersStep", - "title": "archiveOrdersStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/cancelOrderChangeStep", - "title": "cancelOrderChangeStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/cancelOrderClaimStep", - "title": "cancelOrderClaimStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/cancelOrderExchangeStep", - "title": "cancelOrderExchangeStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/cancelOrderFulfillmentStep", - "title": "cancelOrderFulfillmentStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/cancelOrderReturnStep", - "title": "cancelOrderReturnStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/cancelOrdersStep", - "title": "cancelOrdersStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/completeOrdersStep", - "title": "completeOrdersStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createCompleteReturnStep", - "title": "createCompleteReturnStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createOrderChangeStep", - "title": "createOrderChangeStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createOrderClaimItemsFromActionsStep", - "title": "createOrderClaimItemsFromActionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createOrderClaimsStep", - "title": "createOrderClaimsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createOrderExchangeItemsFromActionsStep", - "title": "createOrderExchangeItemsFromActionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createOrderExchangesStep", - "title": "createOrderExchangesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createOrderLineItemsStep", - "title": "createOrderLineItemsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createOrdersStep", - "title": "createOrdersStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createReturnsStep", - "title": "createReturnsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/declineOrderChangeStep", - "title": "declineOrderChangeStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteClaimsStep", - "title": "deleteClaimsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteExchangesStep", - "title": "deleteExchangesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteOrderChangeActionsStep", - "title": "deleteOrderChangeActionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteOrderChangesStep", - "title": "deleteOrderChangesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteOrderLineItems", - "title": "deleteOrderLineItems", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteOrderShippingMethods", - "title": "deleteOrderShippingMethods", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteReturnsStep", - "title": "deleteReturnsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/previewOrderChangeStep", - "title": "previewOrderChangeStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/registerOrderChangesStep", - "title": "registerOrderChangesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/registerOrderFulfillmentStep", - "title": "registerOrderFulfillmentStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/registerOrderShipmentStep", - "title": "registerOrderShipmentStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/setOrderTaxLinesForItemsStep", - "title": "setOrderTaxLinesForItemsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateOrderChangeActionsStep", - "title": "updateOrderChangeActionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateOrderChangesStep", - "title": "updateOrderChangesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateOrderShippingMethodsStep", - "title": "updateOrderShippingMethodsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateOrdersStep", - "title": "updateOrdersStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateReturnItemsStep", - "title": "updateReturnItemsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateReturnsStep", - "title": "updateReturnsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/acceptOrderTransferValidationStep", - "title": "acceptOrderTransferValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/beginClaimOrderValidationStep", - "title": "beginClaimOrderValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/beginOrderEditValidationStep", - "title": "beginOrderEditValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/beginOrderExchangeValidationStep", - "title": "beginOrderExchangeValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/beginReceiveReturnValidationStep", - "title": "beginReceiveReturnValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/beginReturnOrderValidationStep", - "title": "beginReturnOrderValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelBeginOrderClaimValidationStep", - "title": "cancelBeginOrderClaimValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelBeginOrderEditValidationStep", - "title": "cancelBeginOrderEditValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelBeginOrderExchangeValidationStep", - "title": "cancelBeginOrderExchangeValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelClaimValidateOrderStep", - "title": "cancelClaimValidateOrderStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelExchangeValidateOrder", - "title": "cancelExchangeValidateOrder", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelOrderFulfillmentValidateOrder", - "title": "cancelOrderFulfillmentValidateOrder", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelReceiveReturnValidationStep", - "title": "cancelReceiveReturnValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelRequestReturnValidationStep", - "title": "cancelRequestReturnValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelReturnValidateOrder", - "title": "cancelReturnValidateOrder", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelTransferOrderRequestValidationStep", - "title": "cancelTransferOrderRequestValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/cancelValidateOrder", - "title": "cancelValidateOrder", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/confirmClaimRequestValidationStep", - "title": "confirmClaimRequestValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/confirmExchangeRequestValidationStep", - "title": "confirmExchangeRequestValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/confirmOrderEditRequestValidationStep", - "title": "confirmOrderEditRequestValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/confirmReceiveReturnValidationStep", - "title": "confirmReceiveReturnValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/confirmReturnRequestValidationStep", - "title": "confirmReturnRequestValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createClaimShippingMethodValidationStep", - "title": "createClaimShippingMethodValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createCompleteReturnValidationStep", - "title": "createCompleteReturnValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createExchangeShippingMethodValidationStep", - "title": "createExchangeShippingMethodValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createFulfillmentValidateOrder", - "title": "createFulfillmentValidateOrder", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createOrderEditShippingMethodValidationStep", - "title": "createOrderEditShippingMethodValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createReturnShippingMethodValidationStep", - "title": "createReturnShippingMethodValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createShipmentValidateOrder", - "title": "createShipmentValidateOrder", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/declineTransferOrderRequestValidationStep", - "title": "declineTransferOrderRequestValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteOrderPaymentCollections", - "title": "deleteOrderPaymentCollections", - "description": "Delete a payment collection of an order.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/dismissItemReturnRequestValidationStep", - "title": "dismissItemReturnRequestValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/exchangeAddNewItemValidationStep", - "title": "exchangeAddNewItemValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/exchangeRequestItemReturnValidationStep", - "title": "exchangeRequestItemReturnValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/markPaymentCollectionAsPaid", - "title": "markPaymentCollectionAsPaid", - "description": "Mark a payment collection for an order as paid.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/orderClaimAddNewItemValidationStep", - "title": "orderClaimAddNewItemValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/orderClaimItemValidationStep", - "title": "orderClaimItemValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/orderClaimRequestItemReturnValidationStep", - "title": "orderClaimRequestItemReturnValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/orderEditAddNewItemValidationStep", - "title": "orderEditAddNewItemValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/orderEditUpdateItemQuantityValidationStep", - "title": "orderEditUpdateItemQuantityValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/orderFulfillmentDeliverablilityValidationStep", - "title": "orderFulfillmentDeliverablilityValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/receiveCompleteReturnValidationStep", - "title": "receiveCompleteReturnValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/receiveItemReturnRequestValidationStep", - "title": "receiveItemReturnRequestValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeClaimAddItemActionValidationStep", - "title": "removeClaimAddItemActionValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeClaimItemActionValidationStep", - "title": "removeClaimItemActionValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeClaimShippingMethodValidationStep", - "title": "removeClaimShippingMethodValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeExchangeItemActionValidationStep", - "title": "removeExchangeItemActionValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeExchangeShippingMethodValidationStep", - "title": "removeExchangeShippingMethodValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeItemReceiveReturnActionValidationStep", - "title": "removeItemReceiveReturnActionValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeOrderEditItemActionValidationStep", - "title": "removeOrderEditItemActionValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeOrderEditShippingMethodValidationStep", - "title": "removeOrderEditShippingMethodValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeReturnItemActionValidationStep", - "title": "removeReturnItemActionValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeReturnShippingMethodValidationStep", - "title": "removeReturnShippingMethodValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/requestItemReturnValidationStep", - "title": "requestItemReturnValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/requestOrderEditRequestValidationStep", - "title": "requestOrderEditRequestValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/requestOrderTransferValidationStep", - "title": "requestOrderTransferValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/throwUnlessPaymentCollectionNotPaid", - "title": "throwUnlessPaymentCollectionNotPaid", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/throwUnlessStatusIsNotPaid", - "title": "throwUnlessStatusIsNotPaid", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateClaimAddItemValidationStep", - "title": "updateClaimAddItemValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateClaimItemValidationStep", - "title": "updateClaimItemValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateClaimShippingMethodValidationStep", - "title": "updateClaimShippingMethodValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateExchangeAddItemValidationStep", - "title": "updateExchangeAddItemValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateExchangeShippingMethodValidationStep", - "title": "updateExchangeShippingMethodValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateOrderEditAddItemValidationStep", - "title": "updateOrderEditAddItemValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateOrderEditItemQuantityValidationStep", - "title": "updateOrderEditItemQuantityValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateOrderEditShippingMethodValidationStep", - "title": "updateOrderEditShippingMethodValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateOrderValidationStep", - "title": "updateOrderValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateReceiveItemReturnRequestValidationStep", - "title": "updateReceiveItemReturnRequestValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateRequestItemReturnValidationStep", - "title": "updateRequestItemReturnValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateReturnShippingMethodValidationStep", - "title": "updateReturnShippingMethodValidationStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateReturnValidationStep", - "title": "updateReturnValidationStep", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Payment", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/capturePaymentWorkflow", - "title": "capturePaymentWorkflow", - "description": "Capture a payment.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/processPaymentWorkflow", - "title": "processPaymentWorkflow", - "description": "Process a payment based on a webhook event.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/refundPaymentWorkflow", - "title": "refundPaymentWorkflow", - "description": "Refund a payment.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/refundPaymentsWorkflow", - "title": "refundPaymentsWorkflow", - "description": "Refund one or more payments.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/authorizePaymentSessionStep", - "title": "authorizePaymentSessionStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/cancelPaymentStep", - "title": "cancelPaymentStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/capturePaymentStep", - "title": "capturePaymentStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/refundPaymentStep", - "title": "refundPaymentStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/refundPaymentsStep", - "title": "refundPaymentsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/validatePaymentsRefundStep", - "title": "validatePaymentsRefundStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/validateRefundStep", - "title": "validateRefundStep", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Payment Collection", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createPaymentSessionsWorkflow", - "title": "createPaymentSessionsWorkflow", - "description": "Create payment sessions.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createRefundReasonsWorkflow", - "title": "createRefundReasonsWorkflow", - "description": "Create refund reasons.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deletePaymentSessionsWorkflow", - "title": "deletePaymentSessionsWorkflow", - "description": "Delete payment sessions.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteRefundReasonsWorkflow", - "title": "deleteRefundReasonsWorkflow", - "description": "Delete refund reasons.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateRefundReasonsWorkflow", - "title": "updateRefundReasonsWorkflow", - "description": "Update refund reasons.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createPaymentAccountHolderStep", - "title": "createPaymentAccountHolderStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createPaymentSessionStep", - "title": "createPaymentSessionStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createRefundReasonStep", - "title": "createRefundReasonStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deletePaymentSessionsStep", - "title": "deletePaymentSessionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteRefundReasonsStep", - "title": "deleteRefundReasonsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updatePaymentCollectionStep", - "title": "updatePaymentCollectionStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateRefundReasonsStep", - "title": "updateRefundReasonsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateDeletedPaymentSessionsStep", - "title": "validateDeletedPaymentSessionsStep", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Price List", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/batchPriceListPricesWorkflow", - "title": "batchPriceListPricesWorkflow", - "description": "Manage a price list's prices.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createPriceListPricesWorkflow", - "title": "createPriceListPricesWorkflow", - "description": "Create prices in price lists.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createPriceListsWorkflow", - "title": "createPriceListsWorkflow", - "description": "Create one or more price lists.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deletePriceListsWorkflow", - "title": "deletePriceListsWorkflow", - "description": "Delete one or more price lists.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removePriceListPricesWorkflow", - "title": "removePriceListPricesWorkflow", - "description": "Remove prices in price lists.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updatePriceListPricesWorkflow", - "title": "updatePriceListPricesWorkflow", - "description": "Update price lists' prices.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updatePriceListsWorkflow", - "title": "updatePriceListsWorkflow", - "description": "Update one or more price lists.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createPriceListPricesStep", - "title": "createPriceListPricesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createPriceListsStep", - "title": "createPriceListsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deletePriceListsStep", - "title": "deletePriceListsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/getExistingPriceListsPriceIdsStep", - "title": "getExistingPriceListsPriceIdsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/removePriceListPricesStep", - "title": "removePriceListPricesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updatePriceListPricesStep", - "title": "updatePriceListPricesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updatePriceListsStep", - "title": "updatePriceListsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validatePriceListsStep", - "title": "validatePriceListsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/validateVariantPriceLinksStep", - "title": "validateVariantPriceLinksStep", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Pricing", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createPricePreferencesWorkflow", - "title": "createPricePreferencesWorkflow", - "description": "Create one or more price preferences.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deletePricePreferencesWorkflow", - "title": "deletePricePreferencesWorkflow", - "description": "Delete one or more price preferences.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updatePricePreferencesWorkflow", - "title": "updatePricePreferencesWorkflow", - "description": "Update one or more price preferences.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createPricePreferencesStep", - "title": "createPricePreferencesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createPriceSetsStep", - "title": "createPriceSetsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deletePricePreferencesStep", - "title": "deletePricePreferencesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updatePricePreferencesAsArrayStep", - "title": "updatePricePreferencesAsArrayStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updatePricePreferencesStep", - "title": "updatePricePreferencesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updatePriceSetsStep", - "title": "updatePriceSetsStep", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Product", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/batchLinkProductsToCategoryWorkflow", - "title": "batchLinkProductsToCategoryWorkflow", - "description": "Manage the links between a collection and products.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/batchLinkProductsToCollectionWorkflow", - "title": "batchLinkProductsToCollectionWorkflow", - "description": "Manage the links between a collection and products.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/batchProductVariantsWorkflow", - "title": "batchProductVariantsWorkflow", - "description": "Create, update, and delete product variants.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/batchProductsWorkflow", - "title": "batchProductsWorkflow", - "description": "Manage products in bulk.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createCollectionsWorkflow", - "title": "createCollectionsWorkflow", - "description": "Create one or more product collections.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createProductOptionsWorkflow", - "title": "createProductOptionsWorkflow", - "description": "Create one or more product options.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createProductTagsWorkflow", - "title": "createProductTagsWorkflow", - "description": "Create one or more product tags.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createProductTypesWorkflow", - "title": "createProductTypesWorkflow", - "description": "Create one or more product types.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createProductVariantsWorkflow", - "title": "createProductVariantsWorkflow", - "description": "Create one or more product variants.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createProductsWorkflow", - "title": "createProductsWorkflow", - "description": "Create one or more products with options and variants.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteCollectionsWorkflow", - "title": "deleteCollectionsWorkflow", - "description": "Delete one or more product collection.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteProductOptionsWorkflow", - "title": "deleteProductOptionsWorkflow", - "description": "Delete one or more product option.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteProductTagsWorkflow", - "title": "deleteProductTagsWorkflow", - "description": "Delete one or more product tags.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteProductTypesWorkflow", - "title": "deleteProductTypesWorkflow", - "description": "Delete one or more product types.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteProductVariantsWorkflow", - "title": "deleteProductVariantsWorkflow", - "description": "Delete one or more product variants.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteProductsWorkflow", - "title": "deleteProductsWorkflow", - "description": "Delete one or more products.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/exportProductsWorkflow", - "title": "exportProductsWorkflow", - "description": "Export products with filtering capabilities.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/importProductsWorkflow", - "title": "importProductsWorkflow", - "description": "Import products from a CSV file.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateCollectionsWorkflow", - "title": "updateCollectionsWorkflow", - "description": "Update one or more product collections.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateProductOptionsWorkflow", - "title": "updateProductOptionsWorkflow", - "description": "Update one or more product options.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateProductTagsWorkflow", - "title": "updateProductTagsWorkflow", - "description": "Update one or more product tags.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateProductTypesWorkflow", - "title": "updateProductTypesWorkflow", - "description": "Update one or more product types.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateProductVariantsWorkflow", - "title": "updateProductVariantsWorkflow", - "description": "Update one or more product variants.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateProductsWorkflow", - "title": "updateProductsWorkflow", - "description": "Update one or more products with options and variants.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/upsertVariantPricesWorkflow", - "title": "upsertVariantPricesWorkflow", - "description": "Create, update, or remove variants' prices.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/batchLinkProductsToCategoryStep", - "title": "batchLinkProductsToCategoryStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/batchLinkProductsToCollectionStep", - "title": "batchLinkProductsToCollectionStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createCollectionsStep", - "title": "createCollectionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createProductOptionsStep", - "title": "createProductOptionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createProductTagsStep", - "title": "createProductTagsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createProductTypesStep", - "title": "createProductTypesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createProductVariantsStep", - "title": "createProductVariantsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createProductsStep", - "title": "createProductsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createVariantPricingLinkStep", - "title": "createVariantPricingLinkStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteCollectionsStep", - "title": "deleteCollectionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteProductOptionsStep", - "title": "deleteProductOptionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteProductTagsStep", - "title": "deleteProductTagsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteProductTypesStep", - "title": "deleteProductTypesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteProductVariantsStep", - "title": "deleteProductVariantsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteProductsStep", - "title": "deleteProductsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/generateProductCsvStep", - "title": "generateProductCsvStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/getAllProductsStep", - "title": "getAllProductsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/getProductsStep", - "title": "getProductsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/getVariantAvailabilityStep", - "title": "getVariantAvailabilityStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/groupProductsForBatchStep", - "title": "groupProductsForBatchStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/parseProductCsvStep", - "title": "parseProductCsvStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateCollectionsStep", - "title": "updateCollectionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateProductOptionsStep", - "title": "updateProductOptionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateProductTagsStep", - "title": "updateProductTagsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateProductTypesStep", - "title": "updateProductTypesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateProductVariantsStep", - "title": "updateProductVariantsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateProductsStep", - "title": "updateProductsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/waitConfirmationProductImportStep", - "title": "waitConfirmationProductImportStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/validateProductInputStep", - "title": "validateProductInputStep", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Product Category", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createProductCategoriesWorkflow", - "title": "createProductCategoriesWorkflow", - "description": "Create product categories.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteProductCategoriesWorkflow", - "title": "deleteProductCategoriesWorkflow", - "description": "Delete product categories.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateProductCategoriesWorkflow", - "title": "updateProductCategoriesWorkflow", - "description": "Update product categories.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createProductCategoriesStep", - "title": "createProductCategoriesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteProductCategoriesStep", - "title": "deleteProductCategoriesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateProductCategoriesStep", - "title": "updateProductCategoriesStep", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Promotion", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/addOrRemoveCampaignPromotionsWorkflow", - "title": "addOrRemoveCampaignPromotionsWorkflow", - "description": "Manage the promotions of a campaign.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/batchPromotionRulesWorkflow", - "title": "batchPromotionRulesWorkflow", - "description": "Manage the rules of a promotion.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createCampaignsWorkflow", - "title": "createCampaignsWorkflow", - "description": "Create one or more campaigns.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createPromotionRulesWorkflow", - "title": "createPromotionRulesWorkflow", - "description": "Create one or more promotion rules.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createPromotionsWorkflow", - "title": "createPromotionsWorkflow", - "description": "Create one or more promotions.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteCampaignsWorkflow", - "title": "deleteCampaignsWorkflow", - "description": "Delete one or more campaigns.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deletePromotionRulesWorkflow", - "title": "deletePromotionRulesWorkflow", - "description": "Delete one or more promotion rules.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deletePromotionsWorkflow", - "title": "deletePromotionsWorkflow", - "description": "Delete one or more promotions.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateCampaignsWorkflow", - "title": "updateCampaignsWorkflow", - "description": "Update one or more campaigns.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updatePromotionRulesWorkflow", - "title": "updatePromotionRulesWorkflow", - "description": "Update one or more promotion rules.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updatePromotionsStatusWorkflow", - "title": "updatePromotionsStatusWorkflow", - "description": "Update the status of one or more promotions.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updatePromotionsWorkflow", - "title": "updatePromotionsWorkflow", - "description": "Update one or more promotions.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/addCampaignPromotionsStep", - "title": "addCampaignPromotionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/addRulesToPromotionsStep", - "title": "addRulesToPromotionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createCampaignsStep", - "title": "createCampaignsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createPromotionsStep", - "title": "createPromotionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteCampaignsStep", - "title": "deleteCampaignsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deletePromotionsStep", - "title": "deletePromotionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/removeCampaignPromotionsStep", - "title": "removeCampaignPromotionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/removeRulesFromPromotionsStep", - "title": "removeRulesFromPromotionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateCampaignsStep", - "title": "updateCampaignsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updatePromotionRulesStep", - "title": "updatePromotionRulesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updatePromotionsStep", - "title": "updatePromotionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updatePromotionsValidationStep", - "title": "updatePromotionsValidationStep", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Region", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createRegionsWorkflow", - "title": "createRegionsWorkflow", - "description": "Create one or more regions.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteRegionsWorkflow", - "title": "deleteRegionsWorkflow", - "description": "Delete one or more regions.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateRegionsWorkflow", - "title": "updateRegionsWorkflow", - "description": "Update regions.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createRegionsStep", - "title": "createRegionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteRegionsStep", - "title": "deleteRegionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/setRegionsPaymentProvidersStep", - "title": "setRegionsPaymentProvidersStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateRegionsStep", - "title": "updateRegionsStep", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Reservation", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createReservationsWorkflow", - "title": "createReservationsWorkflow", - "description": "Create one or more reservations.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteReservationsByLineItemsWorkflow", - "title": "deleteReservationsByLineItemsWorkflow", - "description": "Delete reservations by their associated line items.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteReservationsWorkflow", - "title": "deleteReservationsWorkflow", - "description": "Delete one or more reservations.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateReservationsWorkflow", - "title": "updateReservationsWorkflow", - "description": "Update one or more reservations.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createReservationsStep", - "title": "createReservationsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteReservationsByLineItemsStep", - "title": "deleteReservationsByLineItemsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteReservationsStep", - "title": "deleteReservationsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateReservationsStep", - "title": "updateReservationsStep", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Return Reason", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createReturnReasonsWorkflow", - "title": "createReturnReasonsWorkflow", - "description": "Create return reasons.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteReturnReasonsWorkflow", - "title": "deleteReturnReasonsWorkflow", - "description": "Delete return reasons.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateReturnReasonsWorkflow", - "title": "updateReturnReasonsWorkflow", - "description": "Update return reasons.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createReturnReasonsStep", - "title": "createReturnReasonsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteReturnReasonStep", - "title": "deleteReturnReasonStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateReturnReasonsStep", - "title": "updateReturnReasonsStep", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Sales Channel", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createSalesChannelsWorkflow", - "title": "createSalesChannelsWorkflow", - "description": "Create sales channels.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteSalesChannelsWorkflow", - "title": "deleteSalesChannelsWorkflow", - "description": "Delete sales channels.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/linkProductsToSalesChannelWorkflow", - "title": "linkProductsToSalesChannelWorkflow", - "description": "Manage the products available in a sales channel.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateSalesChannelsWorkflow", - "title": "updateSalesChannelsWorkflow", - "description": "Update sales channels.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/associateLocationsWithSalesChannelsStep", - "title": "associateLocationsWithSalesChannelsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/associateProductsWithSalesChannelsStep", - "title": "associateProductsWithSalesChannelsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/canDeleteSalesChannelsOrThrowStep", - "title": "canDeleteSalesChannelsOrThrowStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createDefaultSalesChannelStep", - "title": "createDefaultSalesChannelStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createSalesChannelsStep", - "title": "createSalesChannelsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteSalesChannelsStep", - "title": "deleteSalesChannelsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/detachLocationsFromSalesChannelsStep", - "title": "detachLocationsFromSalesChannelsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/detachProductsFromSalesChannelsStep", - "title": "detachProductsFromSalesChannelsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateSalesChannelsStep", - "title": "updateSalesChannelsStep", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Shipping Options", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/listShippingOptionsForContextStep", - "title": "listShippingOptionsForContextStep", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Shipping Profile", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteShippingProfileWorkflow", - "title": "deleteShippingProfileWorkflow", - "description": "Delete shipping profiles.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteShippingProfilesStep", - "title": "deleteShippingProfilesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/validateStepShippingProfileDelete", - "title": "validateStepShippingProfileDelete", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Stock Location", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createLocationFulfillmentSetWorkflow", - "title": "createLocationFulfillmentSetWorkflow", - "description": "Add fulfillment set to a stock location.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createStockLocationsWorkflow", - "title": "createStockLocationsWorkflow", - "description": "Create one or more stock locations.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteStockLocationsWorkflow", - "title": "deleteStockLocationsWorkflow", - "description": "Delete one or more stock locations.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/linkSalesChannelsToStockLocationWorkflow", - "title": "linkSalesChannelsToStockLocationWorkflow", - "description": "Manage the sales channels of a stock location.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateStockLocationsWorkflow", - "title": "updateStockLocationsWorkflow", - "description": "Update stock locations.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createStockLocations", - "title": "createStockLocations", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteStockLocationsStep", - "title": "deleteStockLocationsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateStockLocationsStep", - "title": "updateStockLocationsStep", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Store", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createStoresWorkflow", - "title": "createStoresWorkflow", - "description": "Create one or more stores.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteStoresWorkflow", - "title": "deleteStoresWorkflow", - "description": "Delete one or more stores.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateStoresWorkflow", - "title": "updateStoresWorkflow", - "description": "Update stores.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createStoresStep", - "title": "createStoresStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteStoresStep", - "title": "deleteStoresStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateStoresStep", - "title": "updateStoresStep", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Tax", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createTaxRateRulesWorkflow", - "title": "createTaxRateRulesWorkflow", - "description": "Create one or more tax rules for rates.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createTaxRatesWorkflow", - "title": "createTaxRatesWorkflow", - "description": "Create one or more tax rates.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createTaxRegionsWorkflow", - "title": "createTaxRegionsWorkflow", - "description": "Create one or more tax regions.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteTaxRateRulesWorkflow", - "title": "deleteTaxRateRulesWorkflow", - "description": "Delete one or more tax rate rules.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteTaxRatesWorkflow", - "title": "deleteTaxRatesWorkflow", - "description": "Delete one or more tax rates.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteTaxRegionsWorkflow", - "title": "deleteTaxRegionsWorkflow", - "description": "Delete one or more tax regions.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/setTaxRateRulesWorkflow", - "title": "setTaxRateRulesWorkflow", - "description": "Set the rules of tax rates.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateTaxRatesWorkflow", - "title": "updateTaxRatesWorkflow", - "description": "Update tax rates.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateTaxRegionsWorkflow", - "title": "updateTaxRegionsWorkflow", - "description": "Update one or more tax regions.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createTaxRateRulesStep", - "title": "createTaxRateRulesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createTaxRatesStep", - "title": "createTaxRatesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createTaxRegionsStep", - "title": "createTaxRegionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteTaxRateRulesStep", - "title": "deleteTaxRateRulesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteTaxRatesStep", - "title": "deleteTaxRatesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteTaxRegionsStep", - "title": "deleteTaxRegionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/getItemTaxLinesStep", - "title": "getItemTaxLinesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/listTaxRateIdsStep", - "title": "listTaxRateIdsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/listTaxRateRuleIdsStep", - "title": "listTaxRateRuleIdsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateTaxRatesStep", - "title": "updateTaxRatesStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateTaxRegionsStep", - "title": "updateTaxRegionsStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/maybeListTaxRateRuleIdsStep", - "title": "maybeListTaxRateRuleIdsStep", - "description": "", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "User", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Workflows", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createUserAccountWorkflow", - "title": "createUserAccountWorkflow", - "description": "Create a user account and attach an auth identity.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/createUsersWorkflow", - "title": "createUsersWorkflow", - "description": "Create one or more users.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/deleteUsersWorkflow", - "title": "deleteUsersWorkflow", - "description": "Delete one or more users.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/removeUserAccountWorkflow", - "title": "removeUserAccountWorkflow", - "description": "Delete a user and remove the association to its auth identity.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/updateUsersWorkflow", - "title": "updateUsersWorkflow", - "description": "Update one or more users.", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Steps", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/createUsersStep", - "title": "createUsersStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/deleteUsersStep", - "title": "deleteUsersStep", - "description": "", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/references/medusa-workflows/steps/updateUsersStep", - "title": "updateUsersStep", - "description": "", - "children": [] - } - ] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sidebar", - "sidebar_id": "test-tools-reference", - "title": "Testing Framework", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/test-tools-reference", - "title": "Reference Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Functions", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "medusaIntegrationTestRunner", - "path": "/test-tools-reference/medusaIntegrationTestRunner", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "moduleIntegrationTestRunner", - "path": "/test-tools-reference/moduleIntegrationTestRunner", - "children": [] - } - ] - } - ] - } - ] - } - ] - }, - { - "sidebar_id": "recipes", - "title": "Recipes", - "items": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/marketplace", - "title": "Marketplace", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/marketplace/examples/vendors", - "title": "Example: Vendors", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/marketplace/examples/restaurant-delivery", - "title": "Example: Restaurant-Delivery", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/subscriptions", - "title": "Subscriptions", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/subscriptions/examples/standard", - "title": "Example", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/digital-products", - "title": "Digital Products", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/digital-products/examples/standard", - "title": "Example", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/erp", - "title": "Integrate ERP", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/erp/odoo", - "title": "Example: Odoo Integration", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/b2b", - "title": "B2B", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/commerce-automation", - "title": "Commerce Automation", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/commerce-automation/restock-notification", - "title": "Example: Restock Notifications", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/ecommerce", - "title": "Ecommerce", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/multi-region-store", - "title": "Multi-Region Store", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/omnichannel", - "title": "Omnichannel Store", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/oms", - "title": "OMS", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/personalized-products", - "title": "Personalized Products", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/recipes/pos", - "title": "POS", - "children": [] - } - ] - }, - { - "sidebar_id": "how-to-tutorials", - "title": "How-To & Tutorials", - "items": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/how-to-tutorials", - "title": "Overview", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/examples", - "title": "Example Snippets", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "How-To Guides", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Server", - "autogenerate_tags": "howTo+server", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create Actor Type", - "path": "https://docs.medusajs.com/resources/commerce-modules/auth/create-actor-type", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create Auth Provider", - "path": "https://docs.medusajs.com/resources/references/auth/provider", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create Cache Module", - "path": "https://docs.medusajs.com/resources/architectural-modules/cache/create", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create Event Module", - "path": "https://docs.medusajs.com/resources/architectural-modules/event/create", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create Fulfillment Provider", - "path": "https://docs.medusajs.com/resources/references/fulfillment/provider", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create Notification Provider", - "path": "https://docs.medusajs.com/resources/references/notification-provider-module", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create Payment Provider", - "path": "https://docs.medusajs.com/resources/references/payment/provider", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Create Tax Provider", - "path": "https://docs.medusajs.com/resources/references/tax/provider", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Get Variant Price with Taxes", - "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price-with-taxes", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Get Variant Prices", - "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/price", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Handle Password Reset Event", - "path": "https://docs.medusajs.com/resources/commerce-modules/auth/reset-password", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Send Notification", - "path": "https://docs.medusajs.com/resources/architectural-modules/notification/send-notification", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Admin", - "autogenerate_tags": "howTo+admin", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/admin-components", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Components", - "autogenerate_path": "/admin-components/components", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Layouts", - "autogenerate_path": "/admin-components/layouts", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Tutorials", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Custom Item Pricing", - "path": "/examples/guides/custom-item-price", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Wishlist", - "path": "/plugins/guides/wishlist", - "description": "Learn how to build a wishlist plugin.", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "sub-category", - "title": "Extend Modules", - "autogenerate_tags": "tutorial+extendModule", - "autogenerate_as_ref": true, - "sort_sidebar": "alphabetize", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Extend Cart", - "path": "https://docs.medusajs.com/resources/commerce-modules/cart/extend", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Extend Customer", - "path": "https://docs.medusajs.com/resources/commerce-modules/customer/extend", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Extend Product", - "path": "https://docs.medusajs.com/resources/commerce-modules/product/extend", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "ref", - "title": "Extend Promotion", - "path": "https://docs.medusajs.com/resources/commerce-modules/promotion/extend", - "children": [] - } - ] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Deployment", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/deployment", - "title": "Overview", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "title": "Medusa Cloud", - "path": "https://medusajs.com/pricing", - "children": [] - }, - { - "type": "separator" - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Self-Hosting", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "https://docs.medusajs.com/learn/deployment/general", - "title": "General", - "children": [] - }, - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/deployment/medusa-application/railway", - "title": "Railway", - "children": [] - } - ] - }, - { - "loaded": true, - "isPathHref": true, - "type": "category", - "title": "Next.js Starter", - "autogenerate_path": "/deployment/storefront", - "children": [ - { - "loaded": true, - "isPathHref": true, - "type": "link", - "path": "/deployment/storefront/vercel", - "title": "Vercel", - "description": "", - "children": [] - } - ] - } - ] - } - ] - } -] \ No newline at end of file diff --git a/www/apps/resources/next.config.mjs b/www/apps/resources/next.config.mjs index 4da1541fed..5d79b199f2 100644 --- a/www/apps/resources/next.config.mjs +++ b/www/apps/resources/next.config.mjs @@ -149,7 +149,7 @@ const nextConfig = { "*": ["node_modules/@medusajs/icons"], }, experimental: { - optimizePackageImports: ["@medusajs/icons", "@medusajs/ui"], + optimizePackageImports: ["@medusajs/icons", "@medusajs/ui", "elkjs"], }, } diff --git a/www/apps/resources/providers/sidebar.tsx b/www/apps/resources/providers/sidebar.tsx index 4a7ac455da..eea7ad5dbe 100644 --- a/www/apps/resources/providers/sidebar.tsx +++ b/www/apps/resources/providers/sidebar.tsx @@ -1,9 +1,13 @@ "use client" + import { SidebarProvider as UiSidebarProvider, useScrollController, } from "docs-ui" -import { config } from "@/config" +import { usePathname } from "next/navigation" +import { useCallback, useEffect, useState } from "react" +import { Sidebar } from "types" +import { getSidebarForPath } from "../utils/get-sidebar-for-path" type SidebarProviderProps = { children?: React.ReactNode @@ -11,11 +15,36 @@ type SidebarProviderProps = { const SidebarProvider = ({ children }: SidebarProviderProps) => { const { scrollableElement } = useScrollController() + const [sidebar, setSidebar] = useState() + const pathname = usePathname() + + const loadSidebar = useCallback( + async () => getSidebarForPath(pathname), + [pathname] + ) + + useEffect(() => { + loadSidebar() + .then(setSidebar) + .catch((error) => { + console.error("Error loading sidebar:", error) + }) + }, [loadSidebar]) return ( {children} diff --git a/www/apps/resources/scripts/prepare.mjs b/www/apps/resources/scripts/prepare.mjs index 9991bd634a..52446274c7 100644 --- a/www/apps/resources/scripts/prepare.mjs +++ b/www/apps/resources/scripts/prepare.mjs @@ -1,10 +1,16 @@ -import { generateEditedDates, generateSidebar } from "build-scripts" +import { + generateEditedDates, + generateSidebar, + generateSplitSidebars, +} from "build-scripts" import { main as generateSlugChanges } from "./generate-slug-changes.mjs" import { main as generateFilesMap } from "./generate-files-map.mjs" import { sidebar } from "../sidebar.mjs" async function main() { - await generateSidebar(sidebar) + await generateSplitSidebars({ + sidebars: sidebar, + }) // await generateSlugChanges() // await generateFilesMap() // await generateEditedDates() diff --git a/www/apps/resources/utils/get-sidebar-for-path.ts b/www/apps/resources/utils/get-sidebar-for-path.ts new file mode 100644 index 0000000000..2b90f42c24 --- /dev/null +++ b/www/apps/resources/utils/get-sidebar-for-path.ts @@ -0,0 +1,53 @@ +import { Sidebar } from "types" + +const getDefaultSidebar = async () => + import("@/generated/generated-resources-sidebar.mjs") as Promise<{ + default: Sidebar.Sidebar + }> + +const sidebarMappings: { + module: () => Promise<{ default: Sidebar.Sidebar }> + paths: string[] +}[] = [ + { + module: async () => + import("@/generated/generated-recipes-sidebar.mjs") as Promise<{ + default: Sidebar.Sidebar + }>, + paths: ["/recipes/"], + }, + { + module: async () => + import("@/generated/generated-how-to-tutorials-sidebar.mjs") as Promise<{ + default: Sidebar.Sidebar + }>, + paths: [ + "/how-to-tutorials", + "/examples", + "/admin-components", + "/plugins/guides", + "/deployment", + ], + }, +] +export async function getSidebarForPath( + currentPath: string +): Promise { + const sidebarMapping = sidebarMappings.find(({ paths }) => + paths.some((path) => { + if (currentPath.startsWith(path)) { + return true + } + + const regex = new RegExp(`^${path.replace(/\/$/, "")}(/|$)`) + return regex.test(currentPath) + }) + ) + + if (sidebarMapping) { + const sidebarModule = await sidebarMapping.module() + return sidebarModule.default + } + + return await getDefaultSidebar().then((module) => module.default) +} diff --git a/www/apps/user-guide/components/EditButton/index.tsx b/www/apps/user-guide/components/EditButton/index.tsx index de31c6580b..16e7564021 100644 --- a/www/apps/user-guide/components/EditButton/index.tsx +++ b/www/apps/user-guide/components/EditButton/index.tsx @@ -2,19 +2,29 @@ import { EditButton as UiEditButton } from "docs-ui" import { usePathname } from "next/navigation" -import { useMemo } from "react" -import { generatedEditDates } from "../../generated/edit-dates.mjs" +import { useCallback, useEffect, useState } from "react" const EditButton = () => { const pathname = usePathname() + const [editDate, setEditDate] = useState() - const editDate = useMemo( - () => + const loadEditDate = useCallback(async () => { + const generatedEditDates = (await import("../../generated/edit-dates.mjs")) + .generatedEditDates + setEditDate( (generatedEditDates as Record)[ `app${pathname.replace(/\/$/, "")}/page.mdx` - ], - [pathname] - ) + ] + ) + }, [pathname]) + + useEffect(() => { + void loadEditDate() + }, [loadEditDate]) + + if (!editDate) { + return <> + } return ( Promise> = { "core-flows": getCoreFlowsRefSidebarChildren, } +function sortItems(itemA: ItemsToAdd, itemB: ItemsToAdd): number { + const itemASidebarPosition = itemA.sidebar_position || 0 + const itemBSidebarPosition = itemB.sidebar_position || 0 + + if (itemASidebarPosition > itemBSidebarPosition) { + return 1 + } + + return itemASidebarPosition < itemBSidebarPosition ? -1 : 0 +} + async function getAutogeneratedSidebarItems( dir: string, nested = false @@ -211,21 +223,27 @@ async function checkItems( export async function generateSidebar( sidebars: Sidebar.RawSidebar[], options?: GenerateSidebarOptions -): Promise { +): Promise { const path = await import("path") const { writeFileSync } = await import("fs") const normalizedSidebars: Sidebar.RawSidebar[] = [] + const { writeToFile = true, ...restOptions } = options || {} + validateSidebarUniqueIds(sidebars) for (const sidebarItem of sidebars) { normalizedSidebars.push({ ...sidebarItem, - items: await checkItems(sidebarItem.items, options), + items: await checkItems(sidebarItem.items, restOptions), }) } + if (!writeToFile) { + return normalizedSidebars + } + const generatedDirPath = path.resolve("generated") if (!existsSync(generatedDirPath)) { @@ -245,14 +263,3 @@ export async function generateSidebar( } ) } - -function sortItems(itemA: ItemsToAdd, itemB: ItemsToAdd): number { - const itemASidebarPosition = itemA.sidebar_position || 0 - const itemBSidebarPosition = itemB.sidebar_position || 0 - - if (itemASidebarPosition > itemBSidebarPosition) { - return 1 - } - - return itemASidebarPosition < itemBSidebarPosition ? -1 : 0 -} diff --git a/www/packages/build-scripts/src/generate-split-sidebars.ts b/www/packages/build-scripts/src/generate-split-sidebars.ts new file mode 100644 index 0000000000..abb13b5b83 --- /dev/null +++ b/www/packages/build-scripts/src/generate-split-sidebars.ts @@ -0,0 +1,51 @@ +import { Sidebar } from "types" +import { generateSidebar, GenerateSidebarOptions } from "./index.js" +import path from "path" +import { existsSync, mkdirSync } from "fs" +import { writeFile } from "fs/promises" + +function toCamelCase(str: string) { + return str + .replace(/-([a-z])/g, (g) => g[1].toUpperCase()) + .replace(/^./, (g) => g.toUpperCase()) +} + +export async function generateSplitSidebars({ + sidebars, + options, +}: { + sidebars: Sidebar.RawSidebar[] + options?: GenerateSidebarOptions +}) { + const generatedDirPath = path.resolve("generated") + + if (!existsSync(generatedDirPath)) { + mkdirSync(generatedDirPath) + } + + for (const sidebarItem of sidebars) { + const generatedSidebar = ( + (await generateSidebar([sidebarItem], { + ...options, + writeToFile: false, + })) as Sidebar.RawSidebar[] + )[0] + + const varName = `generated${toCamelCase(sidebarItem.sidebar_id)}Sidebar` + + await writeFile( + path.resolve( + generatedDirPath, + `generated-${sidebarItem.sidebar_id}-sidebar.mjs` + ), + `const generated${varName}Sidebar = ${JSON.stringify( + generatedSidebar, + null, + 2 + )}\n\nexport default generated${varName}Sidebar`, + { + flag: "w", + } + ) + } +} diff --git a/www/packages/build-scripts/src/index.ts b/www/packages/build-scripts/src/index.ts index 0f3387e7c9..170b6b13ae 100644 --- a/www/packages/build-scripts/src/index.ts +++ b/www/packages/build-scripts/src/index.ts @@ -1,6 +1,7 @@ export * from "./generate-edited-dates.js" export * from "./generate-llms-full.js" export * from "./generate-sidebar.js" +export * from "./generate-split-sidebars.js" export * from "./retrieve-mdx-pages.js" export * from "./utils/get-core-flows-ref-sidebar-children.js" diff --git a/www/packages/docs-ui/src/providers/Sidebar/index.tsx b/www/packages/docs-ui/src/providers/Sidebar/index.tsx index d7277b182c..45dea243bc 100644 --- a/www/packages/docs-ui/src/providers/Sidebar/index.tsx +++ b/www/packages/docs-ui/src/providers/Sidebar/index.tsx @@ -536,6 +536,12 @@ export const SidebarProvider = ({ ) }, [isBrowser, desktopSidebarOpen]) + useEffect(() => { + if (initialSidebars[0].sidebar_id !== sidebars[0].sidebar_id) { + resetItems() + } + }, [initialSidebars]) + const updatePersistedCategoryState = (title: string, opened: boolean) => { const storageData = JSON.parse( localStorage.getItem(categoriesStorageKey) || "{}"