const generatedgeneratedCommerceModulesSidebarSidebar = { "sidebar_id": "commerce-modules", "title": "Commerce Modules", "items": [ { "loaded": true, "isPathHref": true, "type": "link", "title": "Overview", "path": "/commerce-modules", "children": [] }, { "type": "separator" }, { "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": "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 Module Provider", "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": "auth+server", "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": "link", "path": "/commerce-modules/auth/create-actor-type", "title": "Create Actor Type", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/auth/provider", "title": "Create Auth Provider", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/commerce-modules/auth/reset-password", "title": "Handle Password Reset Event", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", "title": "Implement Phone Authentication", "path": "https://docs.medusajs.com/resources/how-to-tutorials/tutorials/phone-auth", "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": "/references/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": "cart+server", "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": "Add Gift Message", "path": "https://docs.medusajs.com/resources/how-to-tutorials/tutorials/gift-message", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/commerce-modules/cart/extend", "title": "Extend Module", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", "title": "Implement Bundled Products", "path": "https://docs.medusajs.com/resources/recipes/bundled-products/examples/standard", "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": "ref", "title": "Implement First-Purchase Discount", "path": "https://docs.medusajs.com/resources/how-to-tutorials/tutorials/first-purchase-discounts", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", "title": "Implement Loyalty Points", "path": "https://docs.medusajs.com/resources/how-to-tutorials/tutorials/loyalty-points", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", "title": "Implement Quote Management", "path": "https://docs.medusajs.com/resources/examples/guides/quote-management", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", "title": "Send Abandoned Cart Notification", "path": "https://docs.medusajs.com/resources/how-to-tutorials/tutorials/abandoned-cart", "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": "Show Cart Totals", "path": "https://docs.medusajs.com/resources/storefront-development/cart/totals", "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": "/references/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": "link", "path": "/references/cart/upsertLineItemAdjustments", "title": "upsertLineItemAdjustments", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/cart/upsertLineItemTaxLines", "title": "upsertLineItemTaxLines", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/cart/upsertShippingMethodAdjustments", "title": "upsertShippingMethodAdjustments", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/cart/upsertShippingMethodTaxLines", "title": "upsertShippingMethodTaxLines", "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": "customer+server", "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": "link", "path": "/commerce-modules/customer/extend", "title": "Extend Module", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", "title": "Implement First-Purchase Discount", "path": "https://docs.medusajs.com/resources/how-to-tutorials/tutorials/first-purchase-discounts", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", "title": "Implement Loyalty Points", "path": "https://docs.medusajs.com/resources/how-to-tutorials/tutorials/loyalty-points", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", "title": "Implement Phone Authentication", "path": "https://docs.medusajs.com/resources/how-to-tutorials/tutorials/phone-auth", "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": "addDraftOrderItemsWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addDraftOrderItemsWorkflow", "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": "/references/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": "fulfillment+concept", "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 Module 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": "Shipping Option Price Rules", "path": "https://docs.medusajs.com/resources/commerce-modules/pricing/price-rules", "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": "link", "path": "/references/fulfillment/provider", "title": "Create Fulfillment Provider", "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": "fulfillment+userGuide", "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 Options", "path": "https://docs.medusajs.com/user-guide/settings/locations-and-shipping/locations", "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": "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": "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": "createReturnShippingMethodWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createReturnShippingMethodWorkflow", "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": "fetchShippingOptionForOrderWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/fetchShippingOptionForOrderWorkflow", "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": "maybeRefreshShippingMethodsWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/maybeRefreshShippingMethodsWorkflow", "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": "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": "/references/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": "Product Variant Inventory", "path": "https://docs.medusajs.com/resources/commerce-modules/product/variant-inventory", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Server Guides", "autogenerate_tags": "server+inventory", "autogenerate_as_ref": true, "sort_sidebar": "alphabetize", "description": "Learn how to use the Inventory Module in your customizations on the Medusa application server.", "children": [ { "loaded": true, "isPathHref": true, "type": "ref", "title": "Get Variant Inventory", "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/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": "addDraftOrderItemsWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addDraftOrderItemsWorkflow", "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": "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": "confirmDraftOrderEditWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmDraftOrderEditWorkflow", "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": "Server Guides", "autogenerate_tags": "order+server", "autogenerate_as_ref": true, "sort_sidebar": "alphabetize", "description": "Learn how to use the Order Module in your customizations on the Medusa application server.", "children": [ { "loaded": true, "isPathHref": true, "type": "ref", "title": "Add Gift Message", "path": "https://docs.medusajs.com/resources/how-to-tutorials/tutorials/gift-message", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", "title": "Implement Loyalty Points", "path": "https://docs.medusajs.com/resources/how-to-tutorials/tutorials/loyalty-points", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", "title": "Implement Quote Management", "path": "https://docs.medusajs.com/resources/examples/guides/quote-management", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", "title": "Implement Re-Order", "path": "https://docs.medusajs.com/resources/how-to-tutorials/tutorials/re-order", "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": "ref", "title": "Order Confirmation in Storefront", "path": "https://docs.medusajs.com/resources/storefront-development/checkout/order-confirmation", "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": "addDraftOrderItemsWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addDraftOrderItemsWorkflow", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", "title": "addDraftOrderPromotionWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addDraftOrderPromotionWorkflow", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", "title": "addDraftOrderShippingMethodsWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addDraftOrderShippingMethodsWorkflow", "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": "beginDraftOrderEditWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/beginDraftOrderEditWorkflow", "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": "cancelDraftOrderEditWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/cancelDraftOrderEditWorkflow", "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": "confirmDraftOrderEditWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmDraftOrderEditWorkflow", "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": "createOrderCreditLinesWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/createOrderCreditLinesWorkflow", "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": "deleteDraftOrdersWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/deleteDraftOrdersWorkflow", "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": "markOrderFulfillmentAsDeliveredWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/markOrderFulfillmentAsDeliveredWorkflow", "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": "maybeRefreshShippingMethodsWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/maybeRefreshShippingMethodsWorkflow", "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": "refundPaymentAndRecreatePaymentSessionWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refundPaymentAndRecreatePaymentSessionWorkflow", "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": "removeDraftOrderActionItemWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeDraftOrderActionItemWorkflow", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", "title": "removeDraftOrderActionShippingMethodWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeDraftOrderActionShippingMethodWorkflow", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", "title": "removeDraftOrderPromotionsWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeDraftOrderPromotionsWorkflow", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", "title": "removeDraftOrderShippingMethodWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeDraftOrderShippingMethodWorkflow", "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": "requestDraftOrderEditWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/requestDraftOrderEditWorkflow", "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": "updateDraftOrderActionItemWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateDraftOrderActionItemWorkflow", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", "title": "updateDraftOrderActionShippingMethodWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateDraftOrderActionShippingMethodWorkflow", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", "title": "updateDraftOrderItemWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateDraftOrderItemWorkflow", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", "title": "updateDraftOrderShippingMethodWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateDraftOrderShippingMethodWorkflow", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", "title": "updateDraftOrderWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateDraftOrderWorkflow", "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": "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": "deleteDraftOrdersStep", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/deleteDraftOrdersStep", "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": "registerOrderDeliveryStep", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/steps/registerOrderDeliveryStep", "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": "updateDraftOrderStep", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateDraftOrderStep", "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": "/references/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 Module Provider", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/commerce-modules/payment/payment-checkout-flow", "title": "Payment in Checkout", "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": "Saved Payment Methods", "path": "https://docs.medusajs.com/resources/how-to-tutorials/tutorials/saved-payment-methods", "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": "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": "ref", "title": "Use Stripe's Payment Element in the Next.js Starter Storefront", "path": "https://docs.medusajs.com/resources/nextjs-starter/guides/customize-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": "confirmDraftOrderEditWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/confirmDraftOrderEditWorkflow", "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": "refundPaymentAndRecreatePaymentSessionWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/refundPaymentAndRecreatePaymentSessionWorkflow", "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": "requestDraftOrderEditWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/requestDraftOrderEditWorkflow", "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": "/references/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/retrievePayment", "title": "retrievePayment", "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 Tiers and 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": "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": "product+concept", "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": "ref", "title": "Variant Price Rules", "path": "https://docs.medusajs.com/resources/commerce-modules/pricing/price-rules", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Server Guides", "autogenerate_tags": "product+server", "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": "link", "path": "/commerce-modules/product/guides/variant-inventory", "title": "Get Variant Inventory", "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": "link", "path": "/commerce-modules/product/guides/price", "title": "Get Variant Prices", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", "title": "Implement Bundled Products", "path": "https://docs.medusajs.com/resources/recipes/bundled-products/examples/standard", "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": "ref", "title": "Implement Personalized Products", "path": "https://docs.medusajs.com/resources/recipes/personalized-products/example", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", "title": "Implement Product Reviews", "path": "https://docs.medusajs.com/resources/how-to-tutorials/tutorials/product-reviews", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", "title": "Localization with Contentful", "path": "https://docs.medusajs.com/resources/integrations/guides/contentful", "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 Collections in Storefront", "path": "https://docs.medusajs.com/resources/storefront-development/products/collections/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": "ref", "title": "Show Product Categories in Storefront", "path": "https://docs.medusajs.com/resources/storefront-development/products/categories/list", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", "title": "Show Products in Storefront", "path": "https://docs.medusajs.com/resources/storefront-development/products/list", "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": "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": "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": "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": "/references/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/promotion-taxes", "title": "Tax-Inclusive Promotions", "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": "promotion+server", "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": "Implement First-Purchase Discount", "path": "https://docs.medusajs.com/resources/how-to-tutorials/tutorials/first-purchase-discounts", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", "title": "Implement Loyalty Points", "path": "https://docs.medusajs.com/resources/how-to-tutorials/tutorials/loyalty-points", "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 React Context in Storefront", "path": "https://docs.medusajs.com/resources/storefront-development/regions/context", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", "title": "Store Selected Region in Storefront", "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": "addDraftOrderItemsWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addDraftOrderItemsWorkflow", "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": "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": "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": "/references/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": "Server Guides", "autogenerate_tags": "server+salesChannel", "autogenerate_as_ref": true, "sort_sidebar": "alphabetize", "description": "Learn how to use the Sales Channel Module in your customizations on the Medusa application server.", "children": [ { "loaded": true, "isPathHref": true, "type": "ref", "title": "Get Variant Inventory", "path": "https://docs.medusajs.com/resources/commerce-modules/product/guides/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": "addDraftOrderItemsWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addDraftOrderItemsWorkflow", "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": "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": "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": "/references/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": "addDraftOrderItemsWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addDraftOrderItemsWorkflow", "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-provider", "title": "Tax Module Providers", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/commerce-modules/tax/tax-calculation-with-provider", "title": "Tax Calculation", "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": "link", "path": "/references/tax/provider", "title": "Create 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": "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": "addDraftOrderItemsWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addDraftOrderItemsWorkflow", "children": [] }, { "loaded": true, "isPathHref": true, "type": "ref", "title": "addDraftOrderShippingMethodsWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/addDraftOrderShippingMethodsWorkflow", "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": "removeDraftOrderShippingMethodWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/removeDraftOrderShippingMethodWorkflow", "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": "updateDraftOrderShippingMethodWorkflow", "path": "https://docs.medusajs.com/resources/references/medusa-workflows/updateDraftOrderShippingMethodWorkflow", "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": "taxProvider", "path": "https://docs.medusajs.com/resources/references/js-sdk/admin/taxProvider", "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/listTaxProviders", "title": "listTaxProviders", "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": "/references/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": [] } ] } ] } ] } ] } ] } export default generatedgeneratedCommerceModulesSidebarSidebar