const generatedgeneratedReferencesSidebarSidebar = { "sidebar_id": "references", "title": "References", "items": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references-overview", "title": "Overview", "children": [] }, { "type": "separator" }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/admin-widget-injection-zones", "title": "Admin Widget Injection Zones", "description": "List of injection zones you can add widgets in.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/medusa-container-resources", "title": "Container Resources", "description": "Resources you can access through the Medusa and Module containers.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "sidebar", "sidebar_id": "core-flows", "title": "Core Workflows", "custom_autogenerate": "core-flows", "description": "Built-in workflows and steps you can use in your customizations.", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "title": "Overview", "path": "/medusa-workflows-reference", "children": [] }, { "type": "separator" }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Api Key", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createApiKeysWorkflow", "title": "createApiKeysWorkflow", "description": "Create secret or publishable API keys.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteApiKeysWorkflow", "title": "deleteApiKeysWorkflow", "description": "Delete secret or publishable API keys.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/linkSalesChannelsToApiKeyWorkflow", "title": "linkSalesChannelsToApiKeyWorkflow", "description": "Manage the sales channels of a publishable API key.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/revokeApiKeysWorkflow", "title": "revokeApiKeysWorkflow", "description": "Revoke secret or publishable API keys.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateApiKeysWorkflow", "title": "updateApiKeysWorkflow", "description": "Update secret or publishable API keys.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createApiKeysStep", "title": "createApiKeysStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteApiKeysStep", "title": "deleteApiKeysStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/linkSalesChannelsToApiKeyStep", "title": "linkSalesChannelsToApiKeyStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/revokeApiKeysStep", "title": "revokeApiKeysStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateApiKeysStep", "title": "updateApiKeysStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/validateSalesChannelsExistStep", "title": "validateSalesChannelsExistStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Auth", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/generateResetPasswordTokenWorkflow", "title": "generateResetPasswordTokenWorkflow", "description": "Generate a reset password token for a user or customer.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/setAuthAppMetadataStep", "title": "setAuthAppMetadataStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Cart", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/addShippingMethodToCartWorkflow", "title": "addShippingMethodToCartWorkflow", "description": "Add a shipping method to a cart.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/addToCartWorkflow", "title": "addToCartWorkflow", "description": "Add a line item to a cart.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/completeCartWorkflow", "title": "completeCartWorkflow", "description": "Complete a cart and place an order.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/confirmVariantInventoryWorkflow", "title": "confirmVariantInventoryWorkflow", "description": "Validate that a variant is in-stock before adding to the cart.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createCartCreditLinesWorkflow", "title": "createCartCreditLinesWorkflow", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createCartWorkflow", "title": "createCartWorkflow", "description": "Create a cart specifying region, items, and more.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createPaymentCollectionForCartWorkflow", "title": "createPaymentCollectionForCartWorkflow", "description": "Create payment collection for cart.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteCartCreditLinesWorkflow", "title": "deleteCartCreditLinesWorkflow", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/listShippingOptionsForCartWithPricingWorkflow", "title": "listShippingOptionsForCartWithPricingWorkflow", "description": "List a cart's shipping options with prices.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/listShippingOptionsForCartWorkflow", "title": "listShippingOptionsForCartWorkflow", "description": "List a cart's shipping options.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/refreshCartItemsWorkflow", "title": "refreshCartItemsWorkflow", "description": "Refresh a cart's details after an update.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/refreshCartShippingMethodsWorkflow", "title": "refreshCartShippingMethodsWorkflow", "description": "Refresh a cart's shipping methods after an update.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/refreshPaymentCollectionForCartWorkflow", "title": "refreshPaymentCollectionForCartWorkflow", "description": "Refresh a cart's payment collection details.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/refundPaymentAndRecreatePaymentSessionWorkflow", "title": "refundPaymentAndRecreatePaymentSessionWorkflow", "description": "Refund a payment and create a new payment session.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/transferCartCustomerWorkflow", "title": "transferCartCustomerWorkflow", "description": "Refresh a cart's payment collection details.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateCartPromotionsWorkflow", "title": "updateCartPromotionsWorkflow", "description": "Update a cart's applied promotions to add, replace, or remove them.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateCartWorkflow", "title": "updateCartWorkflow", "description": "Update a cart's details, such as region, address, and more.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateLineItemInCartWorkflow", "title": "updateLineItemInCartWorkflow", "description": "Update a cart's line item.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateTaxLinesWorkflow", "title": "updateTaxLinesWorkflow", "description": "Update a cart's tax lines.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/addShippingMethodToCartStep", "title": "addShippingMethodToCartStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/confirmInventoryStep", "title": "confirmInventoryStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createCartsStep", "title": "createCartsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createLineItemAdjustmentsStep", "title": "createLineItemAdjustmentsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createLineItemsStep", "title": "createLineItemsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createPaymentCollectionsStep", "title": "createPaymentCollectionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createShippingMethodAdjustmentsStep", "title": "createShippingMethodAdjustmentsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/findOneOrAnyRegionStep", "title": "findOneOrAnyRegionStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/findOrCreateCustomerStep", "title": "findOrCreateCustomerStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/findSalesChannelStep", "title": "findSalesChannelStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/getActionsToComputeFromPromotionsStep", "title": "getActionsToComputeFromPromotionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/getLineItemActionsStep", "title": "getLineItemActionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/getPromotionCodesToApply", "title": "getPromotionCodesToApply", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/getVariantPriceSetsStep", "title": "getVariantPriceSetsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/getVariantsStep", "title": "getVariantsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/prepareAdjustmentsFromPromotionActionsStep", "title": "prepareAdjustmentsFromPromotionActionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/removeLineItemAdjustmentsStep", "title": "removeLineItemAdjustmentsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/removeShippingMethodAdjustmentsStep", "title": "removeShippingMethodAdjustmentsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/removeShippingMethodFromCartStep", "title": "removeShippingMethodFromCartStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/reserveInventoryStep", "title": "reserveInventoryStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/retrieveCartStep", "title": "retrieveCartStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/setTaxLinesForItemsStep", "title": "setTaxLinesForItemsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateCartPromotionsStep", "title": "updateCartPromotionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateCartsStep", "title": "updateCartsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateLineItemsStep", "title": "updateLineItemsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateShippingMethodsStep", "title": "updateShippingMethodsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/validateAndReturnShippingMethodsDataStep", "title": "validateAndReturnShippingMethodsDataStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/validateCartPaymentsStep", "title": "validateCartPaymentsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/validateCartShippingOptionsPriceStep", "title": "validateCartShippingOptionsPriceStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/validateCartShippingOptionsStep", "title": "validateCartShippingOptionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/validateCartStep", "title": "validateCartStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/validateLineItemPricesStep", "title": "validateLineItemPricesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/validateShippingStep", "title": "validateShippingStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/validateVariantPricesStep", "title": "validateVariantPricesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/validateExistingPaymentCollectionStep", "title": "validateExistingPaymentCollectionStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Common", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/batchLinksWorkflow", "title": "batchLinksWorkflow", "description": "Manage links between two records of linked data models.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createLinksWorkflow", "title": "createLinksWorkflow", "description": "Create links between two records of linked data models.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/dismissLinksWorkflow", "title": "dismissLinksWorkflow", "description": "Dismiss links between two records of linked data models.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateLinksWorkflow", "title": "updateLinksWorkflow", "description": "Update links between two records of linked data models.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createEntitiesStep", "title": "createEntitiesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createRemoteLinkStep", "title": "createRemoteLinkStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteEntitiesStep", "title": "deleteEntitiesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/dismissRemoteLinkStep", "title": "dismissRemoteLinkStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/emitEventStep", "title": "emitEventStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/removeRemoteLinkStep", "title": "removeRemoteLinkStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateRemoteLinksStep", "title": "updateRemoteLinksStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/useQueryGraphStep", "title": "useQueryGraphStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/useRemoteQueryStep", "title": "useRemoteQueryStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/validatePresenceOfStep", "title": "validatePresenceOfStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Customer", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createCustomerAccountWorkflow", "title": "createCustomerAccountWorkflow", "description": "Create or register a customer account.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createCustomerAddressesWorkflow", "title": "createCustomerAddressesWorkflow", "description": "Create one or more customer addresses.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createCustomersWorkflow", "title": "createCustomersWorkflow", "description": "Create one or more customers.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteCustomerAddressesWorkflow", "title": "deleteCustomerAddressesWorkflow", "description": "Delete one or more customer addresses.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteCustomersWorkflow", "title": "deleteCustomersWorkflow", "description": "Delete one or more customers.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/removeCustomerAccountWorkflow", "title": "removeCustomerAccountWorkflow", "description": "Delete a customer account and its auth identity association.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateCustomerAddressesWorkflow", "title": "updateCustomerAddressesWorkflow", "description": "Update one or more customer addresses.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateCustomersWorkflow", "title": "updateCustomersWorkflow", "description": "Update one or more customers.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createCustomerAddressesStep", "title": "createCustomerAddressesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createCustomersStep", "title": "createCustomersStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteCustomerAddressesStep", "title": "deleteCustomerAddressesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteCustomersStep", "title": "deleteCustomersStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/maybeUnsetDefaultBillingAddressesStep", "title": "maybeUnsetDefaultBillingAddressesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/maybeUnsetDefaultShippingAddressesStep", "title": "maybeUnsetDefaultShippingAddressesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateCustomerAddressesStep", "title": "updateCustomerAddressesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateCustomersStep", "title": "updateCustomersStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/validateCustomerAccountCreation", "title": "validateCustomerAccountCreation", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Customer Group", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createCustomerGroupsWorkflow", "title": "createCustomerGroupsWorkflow", "description": "Create one or more customer groups.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteCustomerGroupsWorkflow", "title": "deleteCustomerGroupsWorkflow", "description": "Delete one or more customer groups.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/linkCustomerGroupsToCustomerWorkflow", "title": "linkCustomerGroupsToCustomerWorkflow", "description": "Manage groups of a customer.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/linkCustomersToCustomerGroupWorkflow", "title": "linkCustomersToCustomerGroupWorkflow", "description": "Manage the customers of a customer group.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateCustomerGroupsWorkflow", "title": "updateCustomerGroupsWorkflow", "description": "Update one or more customer groups.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createCustomerGroupsStep", "title": "createCustomerGroupsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteCustomerGroupStep", "title": "deleteCustomerGroupStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/linkCustomerGroupsToCustomerStep", "title": "linkCustomerGroupsToCustomerStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/linkCustomersToCustomerGroupStep", "title": "linkCustomersToCustomerGroupStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateCustomerGroupsStep", "title": "updateCustomerGroupsStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Defaults", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createDefaultsWorkflow", "title": "createDefaultsWorkflow", "description": "Create default data for a Medusa application.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createDefaultStoreStep", "title": "createDefaultStoreStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Draft Order", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/addDraftOrderItemsWorkflow", "title": "addDraftOrderItemsWorkflow", "description": "Add items to a draft order.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/addDraftOrderPromotionWorkflow", "title": "addDraftOrderPromotionWorkflow", "description": "Add promotions to a draft order.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/addDraftOrderShippingMethodsWorkflow", "title": "addDraftOrderShippingMethodsWorkflow", "description": "Add shipping methods to a draft order.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/beginDraftOrderEditWorkflow", "title": "beginDraftOrderEditWorkflow", "description": "Create a draft order edit request.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/cancelDraftOrderEditWorkflow", "title": "cancelDraftOrderEditWorkflow", "description": "Cancel a draft order edit.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/confirmDraftOrderEditWorkflow", "title": "confirmDraftOrderEditWorkflow", "description": "Confirm a draft order edit.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/convertDraftOrderWorkflow", "title": "convertDraftOrderWorkflow", "description": "Convert a draft order to a pending order.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteDraftOrdersWorkflow", "title": "deleteDraftOrdersWorkflow", "description": "Delete draft orders.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/removeDraftOrderActionItemWorkflow", "title": "removeDraftOrderActionItemWorkflow", "description": "Remove an item from a draft order edit.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/removeDraftOrderActionShippingMethodWorkflow", "title": "removeDraftOrderActionShippingMethodWorkflow", "description": "Remove a shipping method from an edited draft order.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/removeDraftOrderPromotionsWorkflow", "title": "removeDraftOrderPromotionsWorkflow", "description": "Remove promotions from a draft order edit.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/removeDraftOrderShippingMethodWorkflow", "title": "removeDraftOrderShippingMethodWorkflow", "description": "Remove an existing shipping method from a draft order edit.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/requestDraftOrderEditWorkflow", "title": "requestDraftOrderEditWorkflow", "description": "Request a draft order edit.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateDraftOrderActionItemWorkflow", "title": "updateDraftOrderActionItemWorkflow", "description": "Update a new item in a draft order edit.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateDraftOrderActionShippingMethodWorkflow", "title": "updateDraftOrderActionShippingMethodWorkflow", "description": "Update a new shipping method in a draft order edit.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateDraftOrderItemWorkflow", "title": "updateDraftOrderItemWorkflow", "description": "Update an item in a draft order edit.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateDraftOrderShippingMethodWorkflow", "title": "updateDraftOrderShippingMethodWorkflow", "description": "Update an existing shipping method in a draft order edit.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateDraftOrderWorkflow", "title": "updateDraftOrderWorkflow", "description": "Update a draft order's details.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteDraftOrdersStep", "title": "deleteDraftOrdersStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/validateDraftOrderStep", "title": "validateDraftOrderStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/convertDraftOrderStep", "title": "convertDraftOrderStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateDraftOrderStep", "title": "updateDraftOrderStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "File", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteFilesWorkflow", "title": "deleteFilesWorkflow", "description": "Delete files from the database and storage.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/uploadFilesWorkflow", "title": "uploadFilesWorkflow", "description": "Upload files using the installed File Module Provider.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteFilesStep", "title": "deleteFilesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/uploadFilesStep", "title": "uploadFilesStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Fulfillment", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/batchShippingOptionRulesWorkflow", "title": "batchShippingOptionRulesWorkflow", "description": "Manage shipping option rules.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/calculateShippingOptionsPricesWorkflow", "title": "calculateShippingOptionsPricesWorkflow", "description": "Calculate shipping option prices in a cart.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/cancelFulfillmentWorkflow", "title": "cancelFulfillmentWorkflow", "description": "Cancel a fulfillment.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createFulfillmentWorkflow", "title": "createFulfillmentWorkflow", "description": "Create a fulfillment.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createReturnFulfillmentWorkflow", "title": "createReturnFulfillmentWorkflow", "description": "Create a fulfillment for a return.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createServiceZonesWorkflow", "title": "createServiceZonesWorkflow", "description": "Create one or more service zones.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createShipmentWorkflow", "title": "createShipmentWorkflow", "description": "Create a shipment for a fulfillment.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createShippingOptionsWorkflow", "title": "createShippingOptionsWorkflow", "description": "Create shipping options.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createShippingProfilesWorkflow", "title": "createShippingProfilesWorkflow", "description": "Create one or more shipping profiles.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteFulfillmentSetsWorkflow", "title": "deleteFulfillmentSetsWorkflow", "description": "Delete one or more fulfillment sets.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteServiceZonesWorkflow", "title": "deleteServiceZonesWorkflow", "description": "Delete one or more service zones.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteShippingOptionsWorkflow", "title": "deleteShippingOptionsWorkflow", "description": "Delete one or more shipping options.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/markFulfillmentAsDeliveredWorkflow", "title": "markFulfillmentAsDeliveredWorkflow", "description": "Mark a fulfillment as delivered.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateFulfillmentWorkflow", "title": "updateFulfillmentWorkflow", "description": "Update a fulfillment.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateServiceZonesWorkflow", "title": "updateServiceZonesWorkflow", "description": "Update one or more service zones.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateShippingOptionsWorkflow", "title": "updateShippingOptionsWorkflow", "description": "Update one or more shipping options.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateShippingProfilesWorkflow", "title": "updateShippingProfilesWorkflow", "description": "Update one or more shipping profiles.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/buildPriceSet", "title": "buildPriceSet", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/calculateShippingOptionsPricesStep", "title": "calculateShippingOptionsPricesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/cancelFulfillmentStep", "title": "cancelFulfillmentStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createFulfillmentSets", "title": "createFulfillmentSets", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createFulfillmentStep", "title": "createFulfillmentStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createReturnFulfillmentStep", "title": "createReturnFulfillmentStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createServiceZonesStep", "title": "createServiceZonesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createShippingOptionRulesStep", "title": "createShippingOptionRulesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createShippingOptionsPriceSetsStep", "title": "createShippingOptionsPriceSetsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createShippingProfilesStep", "title": "createShippingProfilesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteFulfillmentSetsStep", "title": "deleteFulfillmentSetsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteServiceZonesStep", "title": "deleteServiceZonesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteShippingOptionRulesStep", "title": "deleteShippingOptionRulesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteShippingOptionsStep", "title": "deleteShippingOptionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/setShippingOptionsPricesStep", "title": "setShippingOptionsPricesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateFulfillmentStep", "title": "updateFulfillmentStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateServiceZonesStep", "title": "updateServiceZonesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateShippingOptionRulesStep", "title": "updateShippingOptionRulesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateShippingProfilesStep", "title": "updateShippingProfilesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/upsertShippingOptionsStep", "title": "upsertShippingOptionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/validateShipmentStep", "title": "validateShipmentStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/validateShippingOptionPricesStep", "title": "validateShippingOptionPricesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/validateFulfillmentDeliverabilityStep", "title": "validateFulfillmentDeliverabilityStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Inventory", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/batchInventoryItemLevelsWorkflow", "title": "batchInventoryItemLevelsWorkflow", "description": "Manage inventory levels in bulk.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/bulkCreateDeleteLevelsWorkflow", "title": "bulkCreateDeleteLevelsWorkflow", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createInventoryItemsWorkflow", "title": "createInventoryItemsWorkflow", "description": "Create one or more inventory items.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createInventoryLevelsWorkflow", "title": "createInventoryLevelsWorkflow", "description": "Create one or more inventory levels.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteInventoryItemWorkflow", "title": "deleteInventoryItemWorkflow", "description": "Delete one or more inventory items.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteInventoryLevelsWorkflow", "title": "deleteInventoryLevelsWorkflow", "description": "Delete one or more inventory levels.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateInventoryItemsWorkflow", "title": "updateInventoryItemsWorkflow", "description": "Update one or more inventory items.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateInventoryLevelsWorkflow", "title": "updateInventoryLevelsWorkflow", "description": "Update one or more inventory levels.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/adjustInventoryLevelsStep", "title": "adjustInventoryLevelsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/attachInventoryItemToVariants", "title": "attachInventoryItemToVariants", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createInventoryItemsStep", "title": "createInventoryItemsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createInventoryLevelsStep", "title": "createInventoryLevelsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteInventoryItemStep", "title": "deleteInventoryItemStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteInventoryLevelsStep", "title": "deleteInventoryLevelsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateInventoryItemsStep", "title": "updateInventoryItemsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateInventoryLevelsStep", "title": "updateInventoryLevelsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/validateInventoryDeleteStep", "title": "validateInventoryDeleteStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/validateInventoryItemsForCreate", "title": "validateInventoryItemsForCreate", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/validateInventoryLocationsStep", "title": "validateInventoryLocationsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/validateInventoryLevelsDelete", "title": "validateInventoryLevelsDelete", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Invite", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/acceptInviteWorkflow", "title": "acceptInviteWorkflow", "description": "Accept invite and create user.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createInvitesWorkflow", "title": "createInvitesWorkflow", "description": "Create one or more user invites.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteInvitesWorkflow", "title": "deleteInvitesWorkflow", "description": "Delete one or more user invites.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/refreshInviteTokensWorkflow", "title": "refreshInviteTokensWorkflow", "description": "Refresh user invite tokens.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createInviteStep", "title": "createInviteStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteInvitesStep", "title": "deleteInvitesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/refreshInviteTokensStep", "title": "refreshInviteTokensStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/validateTokenStep", "title": "validateTokenStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Line Item", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteLineItemsWorkflow", "title": "deleteLineItemsWorkflow", "description": "Delete line items from a cart.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteLineItemsStep", "title": "deleteLineItemsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/listLineItemsStep", "title": "listLineItemsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateLineItemsStepWithSelector", "title": "updateLineItemsStepWithSelector", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Locking", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/acquireLockStep", "title": "acquireLockStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/releaseLockStep", "title": "releaseLockStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Notification", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/notifyOnFailureStep", "title": "notifyOnFailureStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/sendNotificationsStep", "title": "sendNotificationsStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Order", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/acceptOrderTransferWorkflow", "title": "acceptOrderTransferWorkflow", "description": "Accept an order transfer request.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/addOrderLineItemsWorkflow", "title": "addOrderLineItemsWorkflow", "description": "Add line items to an order.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/archiveOrderWorkflow", "title": "archiveOrderWorkflow", "description": "Archive one or more orders.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/beginClaimOrderWorkflow", "title": "beginClaimOrderWorkflow", "description": "Create an order claim in requested state.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/beginExchangeOrderWorkflow", "title": "beginExchangeOrderWorkflow", "description": "Request an order exchange.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/beginOrderEditOrderWorkflow", "title": "beginOrderEditOrderWorkflow", "description": "Create an order edit request.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/beginReceiveReturnWorkflow", "title": "beginReceiveReturnWorkflow", "description": "Request a return receival.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/beginReturnOrderWorkflow", "title": "beginReturnOrderWorkflow", "description": "Create a return for an order.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/cancelBeginOrderClaimWorkflow", "title": "cancelBeginOrderClaimWorkflow", "description": "Cancel a requested order claim.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/cancelBeginOrderEditWorkflow", "title": "cancelBeginOrderEditWorkflow", "description": "Cancel a requested order edit.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/cancelBeginOrderExchangeWorkflow", "title": "cancelBeginOrderExchangeWorkflow", "description": "Cancel a requested order exchange.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/cancelOrderChangeWorkflow", "title": "cancelOrderChangeWorkflow", "description": "Cancel an order change.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/cancelOrderClaimWorkflow", "title": "cancelOrderClaimWorkflow", "description": "Cancel a confirmed order claim.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/cancelOrderExchangeWorkflow", "title": "cancelOrderExchangeWorkflow", "description": "Cancel an exchange for an order.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/cancelOrderFulfillmentWorkflow", "title": "cancelOrderFulfillmentWorkflow", "description": "Cancel an order's fulfillment.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/cancelOrderTransferRequestWorkflow", "title": "cancelOrderTransferRequestWorkflow", "description": "Cancel an order transfer request.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/cancelOrderWorkflow", "title": "cancelOrderWorkflow", "description": "Cancel an order.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/cancelReturnReceiveWorkflow", "title": "cancelReturnReceiveWorkflow", "description": "Cancel a return receival.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/cancelReturnRequestWorkflow", "title": "cancelReturnRequestWorkflow", "description": "Cancel a requested return.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/cancelReturnWorkflow", "title": "cancelReturnWorkflow", "description": "Cancel a return.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/completeOrderWorkflow", "title": "completeOrderWorkflow", "description": "Complete one or more orders.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/confirmClaimRequestWorkflow", "title": "confirmClaimRequestWorkflow", "description": "Confirm a requested claim.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/confirmExchangeRequestWorkflow", "title": "confirmExchangeRequestWorkflow", "description": "Confirm an exchange request.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/confirmOrderEditRequestWorkflow", "title": "confirmOrderEditRequestWorkflow", "description": "Confirm an order edit request.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/confirmReturnReceiveWorkflow", "title": "confirmReturnReceiveWorkflow", "description": "Confirm a return receival request.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/confirmReturnRequestWorkflow", "title": "confirmReturnRequestWorkflow", "description": "Confirm a return request.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createAndCompleteReturnOrderWorkflow", "title": "createAndCompleteReturnOrderWorkflow", "description": "Create and complete a return for an order.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createClaimShippingMethodWorkflow", "title": "createClaimShippingMethodWorkflow", "description": "Create an inbound or outbound shipping method for a claim.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createExchangeShippingMethodWorkflow", "title": "createExchangeShippingMethodWorkflow", "description": "Create an inbound or outbound shipping method for an exchange.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createOrUpdateOrderPaymentCollectionWorkflow", "title": "createOrUpdateOrderPaymentCollectionWorkflow", "description": "Create or update payment collection for an order.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createOrderChangeActionsWorkflow", "title": "createOrderChangeActionsWorkflow", "description": "Create an order change action.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createOrderChangeWorkflow", "title": "createOrderChangeWorkflow", "description": "Create an order change.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createOrderCreditLinesWorkflow", "title": "createOrderCreditLinesWorkflow", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createOrderEditShippingMethodWorkflow", "title": "createOrderEditShippingMethodWorkflow", "description": "Create a shipping method for an order edit.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createOrderFulfillmentWorkflow", "title": "createOrderFulfillmentWorkflow", "description": "Creates a fulfillment for an order.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createOrderPaymentCollectionWorkflow", "title": "createOrderPaymentCollectionWorkflow", "description": "Create a payment collection for an order.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createOrderShipmentWorkflow", "title": "createOrderShipmentWorkflow", "description": "Creates a shipment for an order.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createOrderWorkflow", "title": "createOrderWorkflow", "description": "Create an order.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createOrdersWorkflow", "title": "createOrdersWorkflow", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createReturnShippingMethodWorkflow", "title": "createReturnShippingMethodWorkflow", "description": "Create a shipping method for a return.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/declineOrderChangeWorkflow", "title": "declineOrderChangeWorkflow", "description": "Decline an order change.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/declineOrderTransferRequestWorkflow", "title": "declineOrderTransferRequestWorkflow", "description": "Decline a requested order transfer.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteOrderChangeActionsWorkflow", "title": "deleteOrderChangeActionsWorkflow", "description": "Delete one or more order change actions.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteOrderChangeWorkflow", "title": "deleteOrderChangeWorkflow", "description": "Delete one or more order changes.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/dismissItemReturnRequestWorkflow", "title": "dismissItemReturnRequestWorkflow", "description": "Dismiss items from a return request.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/fetchShippingOptionForOrderWorkflow", "title": "fetchShippingOptionForOrderWorkflow", "description": "Fetch a shipping option for an order.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/getOrderDetailWorkflow", "title": "getOrderDetailWorkflow", "description": "Retrieve an order's details.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/getOrdersListWorkflow", "title": "getOrdersListWorkflow", "description": "Retrieve a list of orders.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/listShippingOptionsForOrderWorkflow", "title": "listShippingOptionsForOrderWorkflow", "description": "List a order's shipping options.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/markOrderFulfillmentAsDeliveredWorkflow", "title": "markOrderFulfillmentAsDeliveredWorkflow", "description": "Mark a fulfillment in an order as delivered.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/maybeRefreshShippingMethodsWorkflow", "title": "maybeRefreshShippingMethodsWorkflow", "description": "Refreshes the shipping method prices of an order and its changes.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/orderClaimAddNewItemWorkflow", "title": "orderClaimAddNewItemWorkflow", "description": "Add outbound or new items to a claim.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/orderClaimItemWorkflow", "title": "orderClaimItemWorkflow", "description": "Add order items to a claim as claim items.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/orderClaimRequestItemReturnWorkflow", "title": "orderClaimRequestItemReturnWorkflow", "description": "Request one or more items to be returned as part of a claim.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/orderEditAddNewItemWorkflow", "title": "orderEditAddNewItemWorkflow", "description": "Add new items to an order edit.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/orderEditUpdateItemQuantityWorkflow", "title": "orderEditUpdateItemQuantityWorkflow", "description": "Update or remove an existing order item's quantity in the order's edit.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/orderExchangeAddNewItemWorkflow", "title": "orderExchangeAddNewItemWorkflow", "description": "Add new or outbound items to an exchange.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/orderExchangeRequestItemReturnWorkflow", "title": "orderExchangeRequestItemReturnWorkflow", "description": "Add inbound items to be returned as part of the exchange.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/receiveAndCompleteReturnOrderWorkflow", "title": "receiveAndCompleteReturnOrderWorkflow", "description": "Receive and complete a return.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/receiveItemReturnRequestWorkflow", "title": "receiveItemReturnRequestWorkflow", "description": "Mark return items as received.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/removeAddItemClaimActionWorkflow", "title": "removeAddItemClaimActionWorkflow", "description": "Remove outbound (new) items from a claim.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/removeClaimShippingMethodWorkflow", "title": "removeClaimShippingMethodWorkflow", "description": "Remove an inbound or outbound shipping method from a claim.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/removeExchangeShippingMethodWorkflow", "title": "removeExchangeShippingMethodWorkflow", "description": "Remove an inbound or outbound shipping method from an exchange.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/removeItemClaimActionWorkflow", "title": "removeItemClaimActionWorkflow", "description": "Remove order items from a claim.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/removeItemExchangeActionWorkflow", "title": "removeItemExchangeActionWorkflow", "description": "Remove an outbound or new item from an exchange.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/removeItemOrderEditActionWorkflow", "title": "removeItemOrderEditActionWorkflow", "description": "Remove an item that was added to an order edit.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/removeItemReceiveReturnActionWorkflow", "title": "removeItemReceiveReturnActionWorkflow", "description": "Remove an item from a return receival.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/removeItemReturnActionWorkflow", "title": "removeItemReturnActionWorkflow", "description": "Remove an item from a return.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/removeOrderEditShippingMethodWorkflow", "title": "removeOrderEditShippingMethodWorkflow", "description": "Remove a shipping method from an order edit.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/removeReturnShippingMethodWorkflow", "title": "removeReturnShippingMethodWorkflow", "description": "Remove a shipping method from a return.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/requestItemReturnWorkflow", "title": "requestItemReturnWorkflow", "description": "Add items to a return.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/requestOrderEditRequestWorkflow", "title": "requestOrderEditRequestWorkflow", "description": "Request an order edit.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/requestOrderTransferWorkflow", "title": "requestOrderTransferWorkflow", "description": "Request a transfer of an order to a customer.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateClaimAddItemWorkflow", "title": "updateClaimAddItemWorkflow", "description": "Update a claim's new or outbound item.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateClaimItemWorkflow", "title": "updateClaimItemWorkflow", "description": "Update a claim item, added to the claim from an order item.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateClaimShippingMethodWorkflow", "title": "updateClaimShippingMethodWorkflow", "description": "Update an inbound or outbound shipping method of a claim.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateExchangeAddItemWorkflow", "title": "updateExchangeAddItemWorkflow", "description": "Update an outbound or new item in an exchange.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateExchangeShippingMethodWorkflow", "title": "updateExchangeShippingMethodWorkflow", "description": "Update an exchange's inbound or outbound shipping method.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateOrderChangeActionsWorkflow", "title": "updateOrderChangeActionsWorkflow", "description": "Update one or more order change actions.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateOrderChangesWorkflow", "title": "updateOrderChangesWorkflow", "description": "Update one or more order changes.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateOrderEditAddItemWorkflow", "title": "updateOrderEditAddItemWorkflow", "description": "Update a new item in an order edit.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateOrderEditItemQuantityWorkflow", "title": "updateOrderEditItemQuantityWorkflow", "description": "Update an existing order item previously added to an order edit.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateOrderEditShippingMethodWorkflow", "title": "updateOrderEditShippingMethodWorkflow", "description": "Update a shipping method of an order edit.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateOrderTaxLinesWorkflow", "title": "updateOrderTaxLinesWorkflow", "description": "Update the tax lines of items and shipping methods in an order.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateOrderWorkflow", "title": "updateOrderWorkflow", "description": "Update an order's details.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateReceiveItemReturnRequestWorkflow", "title": "updateReceiveItemReturnRequestWorkflow", "description": "Update an item in a return receival request.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateRequestItemReturnWorkflow", "title": "updateRequestItemReturnWorkflow", "description": "Update a requested item in a return.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateReturnShippingMethodWorkflow", "title": "updateReturnShippingMethodWorkflow", "description": "Update the shipping method of a return.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateReturnWorkflow", "title": "updateReturnWorkflow", "description": "Update a return's details.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/addOrderTransactionStep", "title": "addOrderTransactionStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/archiveOrdersStep", "title": "archiveOrdersStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/cancelOrderChangeStep", "title": "cancelOrderChangeStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/cancelOrderClaimStep", "title": "cancelOrderClaimStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/cancelOrderExchangeStep", "title": "cancelOrderExchangeStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/cancelOrderFulfillmentStep", "title": "cancelOrderFulfillmentStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/cancelOrderReturnStep", "title": "cancelOrderReturnStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/cancelOrdersStep", "title": "cancelOrdersStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/completeOrdersStep", "title": "completeOrdersStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createCompleteReturnStep", "title": "createCompleteReturnStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createOrderChangeStep", "title": "createOrderChangeStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createOrderClaimItemsFromActionsStep", "title": "createOrderClaimItemsFromActionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createOrderClaimsStep", "title": "createOrderClaimsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createOrderExchangeItemsFromActionsStep", "title": "createOrderExchangeItemsFromActionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createOrderExchangesStep", "title": "createOrderExchangesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createOrderLineItemsStep", "title": "createOrderLineItemsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createOrdersStep", "title": "createOrdersStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createReturnsStep", "title": "createReturnsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/declineOrderChangeStep", "title": "declineOrderChangeStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteClaimsStep", "title": "deleteClaimsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteExchangesStep", "title": "deleteExchangesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteOrderChangeActionsStep", "title": "deleteOrderChangeActionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteOrderChangesStep", "title": "deleteOrderChangesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteOrderLineItems", "title": "deleteOrderLineItems", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteOrderShippingMethods", "title": "deleteOrderShippingMethods", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteReturnsStep", "title": "deleteReturnsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/previewOrderChangeStep", "title": "previewOrderChangeStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/registerOrderChangesStep", "title": "registerOrderChangesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/registerOrderDeliveryStep", "title": "registerOrderDeliveryStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/registerOrderFulfillmentStep", "title": "registerOrderFulfillmentStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/registerOrderShipmentStep", "title": "registerOrderShipmentStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/setOrderTaxLinesForItemsStep", "title": "setOrderTaxLinesForItemsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateOrderChangeActionsStep", "title": "updateOrderChangeActionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateOrderChangesStep", "title": "updateOrderChangesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateOrderShippingMethodsStep", "title": "updateOrderShippingMethodsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateOrdersStep", "title": "updateOrdersStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateReturnItemsStep", "title": "updateReturnItemsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateReturnsStep", "title": "updateReturnsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/acceptOrderTransferValidationStep", "title": "acceptOrderTransferValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/beginClaimOrderValidationStep", "title": "beginClaimOrderValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/beginOrderEditValidationStep", "title": "beginOrderEditValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/beginOrderExchangeValidationStep", "title": "beginOrderExchangeValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/beginReceiveReturnValidationStep", "title": "beginReceiveReturnValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/beginReturnOrderValidationStep", "title": "beginReturnOrderValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/cancelBeginOrderClaimValidationStep", "title": "cancelBeginOrderClaimValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/cancelBeginOrderEditValidationStep", "title": "cancelBeginOrderEditValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/cancelBeginOrderExchangeValidationStep", "title": "cancelBeginOrderExchangeValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/cancelClaimValidateOrderStep", "title": "cancelClaimValidateOrderStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/cancelExchangeValidateOrder", "title": "cancelExchangeValidateOrder", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/cancelOrderFulfillmentValidateOrder", "title": "cancelOrderFulfillmentValidateOrder", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/cancelReceiveReturnValidationStep", "title": "cancelReceiveReturnValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/cancelRequestReturnValidationStep", "title": "cancelRequestReturnValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/cancelReturnValidateOrder", "title": "cancelReturnValidateOrder", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/cancelTransferOrderRequestValidationStep", "title": "cancelTransferOrderRequestValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/cancelValidateOrder", "title": "cancelValidateOrder", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/confirmClaimRequestValidationStep", "title": "confirmClaimRequestValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/confirmExchangeRequestValidationStep", "title": "confirmExchangeRequestValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/confirmOrderEditRequestValidationStep", "title": "confirmOrderEditRequestValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/confirmReceiveReturnValidationStep", "title": "confirmReceiveReturnValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/confirmReturnRequestValidationStep", "title": "confirmReturnRequestValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createClaimShippingMethodValidationStep", "title": "createClaimShippingMethodValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createCompleteReturnValidationStep", "title": "createCompleteReturnValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createExchangeShippingMethodValidationStep", "title": "createExchangeShippingMethodValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createFulfillmentValidateOrder", "title": "createFulfillmentValidateOrder", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createOrderEditShippingMethodValidationStep", "title": "createOrderEditShippingMethodValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createReturnShippingMethodValidationStep", "title": "createReturnShippingMethodValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createShipmentValidateOrder", "title": "createShipmentValidateOrder", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/declineTransferOrderRequestValidationStep", "title": "declineTransferOrderRequestValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteOrderPaymentCollections", "title": "deleteOrderPaymentCollections", "description": "Delete a payment collection of an order.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/dismissItemReturnRequestValidationStep", "title": "dismissItemReturnRequestValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/exchangeAddNewItemValidationStep", "title": "exchangeAddNewItemValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/exchangeRequestItemReturnValidationStep", "title": "exchangeRequestItemReturnValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/markPaymentCollectionAsPaid", "title": "markPaymentCollectionAsPaid", "description": "Mark a payment collection for an order as paid.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/orderClaimAddNewItemValidationStep", "title": "orderClaimAddNewItemValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/orderClaimItemValidationStep", "title": "orderClaimItemValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/orderClaimRequestItemReturnValidationStep", "title": "orderClaimRequestItemReturnValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/orderEditAddNewItemValidationStep", "title": "orderEditAddNewItemValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/orderEditUpdateItemQuantityValidationStep", "title": "orderEditUpdateItemQuantityValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/orderFulfillmentDeliverablilityValidationStep", "title": "orderFulfillmentDeliverablilityValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/receiveCompleteReturnValidationStep", "title": "receiveCompleteReturnValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/receiveItemReturnRequestValidationStep", "title": "receiveItemReturnRequestValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/removeClaimAddItemActionValidationStep", "title": "removeClaimAddItemActionValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/removeClaimItemActionValidationStep", "title": "removeClaimItemActionValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/removeClaimShippingMethodValidationStep", "title": "removeClaimShippingMethodValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/removeExchangeItemActionValidationStep", "title": "removeExchangeItemActionValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/removeExchangeShippingMethodValidationStep", "title": "removeExchangeShippingMethodValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/removeItemReceiveReturnActionValidationStep", "title": "removeItemReceiveReturnActionValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/removeOrderEditItemActionValidationStep", "title": "removeOrderEditItemActionValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/removeOrderEditShippingMethodValidationStep", "title": "removeOrderEditShippingMethodValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/removeReturnItemActionValidationStep", "title": "removeReturnItemActionValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/removeReturnShippingMethodValidationStep", "title": "removeReturnShippingMethodValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/requestItemReturnValidationStep", "title": "requestItemReturnValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/requestOrderEditRequestValidationStep", "title": "requestOrderEditRequestValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/requestOrderTransferValidationStep", "title": "requestOrderTransferValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/throwUnlessPaymentCollectionNotPaid", "title": "throwUnlessPaymentCollectionNotPaid", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/throwUnlessStatusIsNotPaid", "title": "throwUnlessStatusIsNotPaid", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateClaimAddItemValidationStep", "title": "updateClaimAddItemValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateClaimItemValidationStep", "title": "updateClaimItemValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateClaimShippingMethodValidationStep", "title": "updateClaimShippingMethodValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateExchangeAddItemValidationStep", "title": "updateExchangeAddItemValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateExchangeShippingMethodValidationStep", "title": "updateExchangeShippingMethodValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateOrderEditAddItemValidationStep", "title": "updateOrderEditAddItemValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateOrderEditItemQuantityValidationStep", "title": "updateOrderEditItemQuantityValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateOrderEditShippingMethodValidationStep", "title": "updateOrderEditShippingMethodValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateOrderValidationStep", "title": "updateOrderValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateReceiveItemReturnRequestValidationStep", "title": "updateReceiveItemReturnRequestValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateRequestItemReturnValidationStep", "title": "updateRequestItemReturnValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateReturnShippingMethodValidationStep", "title": "updateReturnShippingMethodValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateReturnValidationStep", "title": "updateReturnValidationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/validateOrderCreditLinesStep", "title": "validateOrderCreditLinesStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Payment", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/capturePaymentWorkflow", "title": "capturePaymentWorkflow", "description": "Capture a payment.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/processPaymentWorkflow", "title": "processPaymentWorkflow", "description": "Process a payment based on a webhook event.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/refundPaymentWorkflow", "title": "refundPaymentWorkflow", "description": "Refund a payment.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/refundPaymentsWorkflow", "title": "refundPaymentsWorkflow", "description": "Refund one or more payments.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/authorizePaymentSessionStep", "title": "authorizePaymentSessionStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/cancelPaymentStep", "title": "cancelPaymentStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/capturePaymentStep", "title": "capturePaymentStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/refundPaymentStep", "title": "refundPaymentStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/refundPaymentsStep", "title": "refundPaymentsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/validatePaymentsRefundStep", "title": "validatePaymentsRefundStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/validateRefundPaymentExceedsCapturedAmountStep", "title": "validateRefundPaymentExceedsCapturedAmountStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Payment Collection", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createPaymentSessionsWorkflow", "title": "createPaymentSessionsWorkflow", "description": "Create payment sessions.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createRefundReasonsWorkflow", "title": "createRefundReasonsWorkflow", "description": "Create refund reasons.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deletePaymentSessionsWorkflow", "title": "deletePaymentSessionsWorkflow", "description": "Delete payment sessions.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteRefundReasonsWorkflow", "title": "deleteRefundReasonsWorkflow", "description": "Delete refund reasons.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateRefundReasonsWorkflow", "title": "updateRefundReasonsWorkflow", "description": "Update refund reasons.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createPaymentAccountHolderStep", "title": "createPaymentAccountHolderStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createPaymentSessionStep", "title": "createPaymentSessionStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createRefundReasonStep", "title": "createRefundReasonStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deletePaymentSessionsStep", "title": "deletePaymentSessionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteRefundReasonsStep", "title": "deleteRefundReasonsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updatePaymentCollectionStep", "title": "updatePaymentCollectionStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateRefundReasonsStep", "title": "updateRefundReasonsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/validateDeletedPaymentSessionsStep", "title": "validateDeletedPaymentSessionsStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Price List", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/batchPriceListPricesWorkflow", "title": "batchPriceListPricesWorkflow", "description": "Manage a price list's prices.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createPriceListPricesWorkflow", "title": "createPriceListPricesWorkflow", "description": "Create prices in price lists.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createPriceListsWorkflow", "title": "createPriceListsWorkflow", "description": "Create one or more price lists.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deletePriceListsWorkflow", "title": "deletePriceListsWorkflow", "description": "Delete one or more price lists.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/removePriceListPricesWorkflow", "title": "removePriceListPricesWorkflow", "description": "Remove prices in price lists.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updatePriceListPricesWorkflow", "title": "updatePriceListPricesWorkflow", "description": "Update price lists' prices.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updatePriceListsWorkflow", "title": "updatePriceListsWorkflow", "description": "Update one or more price lists.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createPriceListPricesStep", "title": "createPriceListPricesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createPriceListsStep", "title": "createPriceListsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deletePriceListsStep", "title": "deletePriceListsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/getExistingPriceListsPriceIdsStep", "title": "getExistingPriceListsPriceIdsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/removePriceListPricesStep", "title": "removePriceListPricesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updatePriceListPricesStep", "title": "updatePriceListPricesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updatePriceListsStep", "title": "updatePriceListsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/validatePriceListsStep", "title": "validatePriceListsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/validateVariantPriceLinksStep", "title": "validateVariantPriceLinksStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Pricing", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createPricePreferencesWorkflow", "title": "createPricePreferencesWorkflow", "description": "Create one or more price preferences.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deletePricePreferencesWorkflow", "title": "deletePricePreferencesWorkflow", "description": "Delete one or more price preferences.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updatePricePreferencesWorkflow", "title": "updatePricePreferencesWorkflow", "description": "Update one or more price preferences.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createPricePreferencesStep", "title": "createPricePreferencesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createPriceSetsStep", "title": "createPriceSetsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deletePricePreferencesStep", "title": "deletePricePreferencesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updatePricePreferencesAsArrayStep", "title": "updatePricePreferencesAsArrayStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updatePricePreferencesStep", "title": "updatePricePreferencesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updatePriceSetsStep", "title": "updatePriceSetsStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Product", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/batchImageVariantsWorkflow", "title": "batchImageVariantsWorkflow", "description": "Manage image-variant associations in bulk.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/batchLinkProductsToCategoryWorkflow", "title": "batchLinkProductsToCategoryWorkflow", "description": "Manage the links between a collection and products.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/batchLinkProductsToCollectionWorkflow", "title": "batchLinkProductsToCollectionWorkflow", "description": "Manage the links between a collection and products.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/batchProductVariantsWorkflow", "title": "batchProductVariantsWorkflow", "description": "Create, update, and delete product variants.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/batchProductsWorkflow", "title": "batchProductsWorkflow", "description": "Manage products in bulk.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/batchVariantImagesWorkflow", "title": "batchVariantImagesWorkflow", "description": "Manage variant-image associations in bulk.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createCollectionsWorkflow", "title": "createCollectionsWorkflow", "description": "Create one or more product collections.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createProductOptionsWorkflow", "title": "createProductOptionsWorkflow", "description": "Create one or more product options.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createProductTagsWorkflow", "title": "createProductTagsWorkflow", "description": "Create one or more product tags.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createProductTypesWorkflow", "title": "createProductTypesWorkflow", "description": "Create one or more product types.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createProductVariantsWorkflow", "title": "createProductVariantsWorkflow", "description": "Create one or more product variants.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createProductsWorkflow", "title": "createProductsWorkflow", "description": "Create one or more products with options and variants.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteCollectionsWorkflow", "title": "deleteCollectionsWorkflow", "description": "Delete one or more product collection.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteProductOptionsWorkflow", "title": "deleteProductOptionsWorkflow", "description": "Delete one or more product option.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteProductTagsWorkflow", "title": "deleteProductTagsWorkflow", "description": "Delete one or more product tags.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteProductTypesWorkflow", "title": "deleteProductTypesWorkflow", "description": "Delete one or more product types.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteProductVariantsWorkflow", "title": "deleteProductVariantsWorkflow", "description": "Delete one or more product variants.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteProductsWorkflow", "title": "deleteProductsWorkflow", "description": "Delete one or more products.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/exportProductsWorkflow", "title": "exportProductsWorkflow", "description": "Export products with filtering capabilities.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/importProductsAsChunksWorkflow", "title": "importProductsAsChunksWorkflow", "description": "Import products from a CSV file.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/importProductsWorkflow", "title": "importProductsWorkflow", "description": "Import products from a CSV file.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateCollectionsWorkflow", "title": "updateCollectionsWorkflow", "description": "Update one or more product collections.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateProductOptionsWorkflow", "title": "updateProductOptionsWorkflow", "description": "Update one or more product options.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateProductTagsWorkflow", "title": "updateProductTagsWorkflow", "description": "Update one or more product tags.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateProductTypesWorkflow", "title": "updateProductTypesWorkflow", "description": "Update one or more product types.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateProductVariantsWorkflow", "title": "updateProductVariantsWorkflow", "description": "Update one or more product variants.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateProductsWorkflow", "title": "updateProductsWorkflow", "description": "Update one or more products with options and variants.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/upsertVariantPricesWorkflow", "title": "upsertVariantPricesWorkflow", "description": "Create, update, or remove variants' prices.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/addImageToVariantsStep", "title": "addImageToVariantsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/addImagesToVariantStep", "title": "addImagesToVariantStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/batchLinkProductsToCategoryStep", "title": "batchLinkProductsToCategoryStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/batchLinkProductsToCollectionStep", "title": "batchLinkProductsToCollectionStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createCollectionsStep", "title": "createCollectionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createProductOptionsStep", "title": "createProductOptionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createProductTagsStep", "title": "createProductTagsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createProductTypesStep", "title": "createProductTypesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createProductVariantsStep", "title": "createProductVariantsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createProductsStep", "title": "createProductsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createVariantPricingLinkStep", "title": "createVariantPricingLinkStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteCollectionsStep", "title": "deleteCollectionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteProductOptionsStep", "title": "deleteProductOptionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteProductTagsStep", "title": "deleteProductTagsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteProductTypesStep", "title": "deleteProductTypesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteProductVariantsStep", "title": "deleteProductVariantsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteProductsStep", "title": "deleteProductsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/generateProductCsvStep", "title": "generateProductCsvStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/getAllProductsStep", "title": "getAllProductsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/getProductsStep", "title": "getProductsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/getVariantAvailabilityStep", "title": "getVariantAvailabilityStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/normalizeCsvStep", "title": "normalizeCsvStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/normalizeCsvToChunksStep", "title": "normalizeCsvToChunksStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/parseProductCsvStep", "title": "parseProductCsvStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/processImportChunksStep", "title": "processImportChunksStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/removeImageFromVariantsStep", "title": "removeImageFromVariantsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/removeImagesFromVariantStep", "title": "removeImagesFromVariantStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateCollectionsStep", "title": "updateCollectionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateProductOptionsStep", "title": "updateProductOptionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateProductTagsStep", "title": "updateProductTagsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateProductTypesStep", "title": "updateProductTypesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateProductVariantsStep", "title": "updateProductVariantsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateProductsStep", "title": "updateProductsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/waitConfirmationProductImportStep", "title": "waitConfirmationProductImportStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/validateProductInputStep", "title": "validateProductInputStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Product Category", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createProductCategoriesWorkflow", "title": "createProductCategoriesWorkflow", "description": "Create product categories.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteProductCategoriesWorkflow", "title": "deleteProductCategoriesWorkflow", "description": "Delete product categories.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateProductCategoriesWorkflow", "title": "updateProductCategoriesWorkflow", "description": "Update product categories.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createProductCategoriesStep", "title": "createProductCategoriesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteProductCategoriesStep", "title": "deleteProductCategoriesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateProductCategoriesStep", "title": "updateProductCategoriesStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Promotion", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/addOrRemoveCampaignPromotionsWorkflow", "title": "addOrRemoveCampaignPromotionsWorkflow", "description": "Manage the promotions of a campaign.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/batchPromotionRulesWorkflow", "title": "batchPromotionRulesWorkflow", "description": "Manage the rules of a promotion.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createCampaignsWorkflow", "title": "createCampaignsWorkflow", "description": "Create one or more campaigns.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createPromotionRulesWorkflow", "title": "createPromotionRulesWorkflow", "description": "Create one or more promotion rules.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createPromotionsWorkflow", "title": "createPromotionsWorkflow", "description": "Create one or more promotions.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteCampaignsWorkflow", "title": "deleteCampaignsWorkflow", "description": "Delete one or more campaigns.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deletePromotionRulesWorkflow", "title": "deletePromotionRulesWorkflow", "description": "Delete one or more promotion rules.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deletePromotionsWorkflow", "title": "deletePromotionsWorkflow", "description": "Delete one or more promotions.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateCampaignsWorkflow", "title": "updateCampaignsWorkflow", "description": "Update one or more campaigns.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updatePromotionRulesWorkflow", "title": "updatePromotionRulesWorkflow", "description": "Update one or more promotion rules.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updatePromotionsStatusWorkflow", "title": "updatePromotionsStatusWorkflow", "description": "Update the status of one or more promotions.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updatePromotionsWorkflow", "title": "updatePromotionsWorkflow", "description": "Update one or more promotions.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/addCampaignPromotionsStep", "title": "addCampaignPromotionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/addRulesToPromotionsStep", "title": "addRulesToPromotionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createCampaignsStep", "title": "createCampaignsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createPromotionsStep", "title": "createPromotionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteCampaignsStep", "title": "deleteCampaignsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deletePromotionsStep", "title": "deletePromotionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/removeCampaignPromotionsStep", "title": "removeCampaignPromotionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/removeRulesFromPromotionsStep", "title": "removeRulesFromPromotionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateCampaignsStep", "title": "updateCampaignsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updatePromotionRulesStep", "title": "updatePromotionRulesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updatePromotionsStep", "title": "updatePromotionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updatePromotionsValidationStep", "title": "updatePromotionsValidationStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Region", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createRegionsWorkflow", "title": "createRegionsWorkflow", "description": "Create one or more regions.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteRegionsWorkflow", "title": "deleteRegionsWorkflow", "description": "Delete one or more regions.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateRegionsWorkflow", "title": "updateRegionsWorkflow", "description": "Update regions.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createRegionsStep", "title": "createRegionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteRegionsStep", "title": "deleteRegionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/setRegionsPaymentProvidersStep", "title": "setRegionsPaymentProvidersStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateRegionsStep", "title": "updateRegionsStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Reservation", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createReservationsWorkflow", "title": "createReservationsWorkflow", "description": "Create one or more reservations.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteReservationsByLineItemsWorkflow", "title": "deleteReservationsByLineItemsWorkflow", "description": "Delete reservations by their associated line items.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteReservationsWorkflow", "title": "deleteReservationsWorkflow", "description": "Delete one or more reservations.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateReservationsWorkflow", "title": "updateReservationsWorkflow", "description": "Update one or more reservations.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createReservationsStep", "title": "createReservationsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteReservationsByLineItemsStep", "title": "deleteReservationsByLineItemsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteReservationsStep", "title": "deleteReservationsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateReservationsStep", "title": "updateReservationsStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Return Reason", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createReturnReasonsWorkflow", "title": "createReturnReasonsWorkflow", "description": "Create return reasons.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteReturnReasonsWorkflow", "title": "deleteReturnReasonsWorkflow", "description": "Delete return reasons.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateReturnReasonsWorkflow", "title": "updateReturnReasonsWorkflow", "description": "Update return reasons.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createReturnReasonsStep", "title": "createReturnReasonsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteReturnReasonStep", "title": "deleteReturnReasonStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateReturnReasonsStep", "title": "updateReturnReasonsStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Sales Channel", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createSalesChannelsWorkflow", "title": "createSalesChannelsWorkflow", "description": "Create sales channels.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteSalesChannelsWorkflow", "title": "deleteSalesChannelsWorkflow", "description": "Delete sales channels.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/linkProductsToSalesChannelWorkflow", "title": "linkProductsToSalesChannelWorkflow", "description": "Manage the products available in a sales channel.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateSalesChannelsWorkflow", "title": "updateSalesChannelsWorkflow", "description": "Update sales channels.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/associateLocationsWithSalesChannelsStep", "title": "associateLocationsWithSalesChannelsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/associateProductsWithSalesChannelsStep", "title": "associateProductsWithSalesChannelsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/canDeleteSalesChannelsOrThrowStep", "title": "canDeleteSalesChannelsOrThrowStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createDefaultSalesChannelStep", "title": "createDefaultSalesChannelStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createSalesChannelsStep", "title": "createSalesChannelsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteSalesChannelsStep", "title": "deleteSalesChannelsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/detachLocationsFromSalesChannelsStep", "title": "detachLocationsFromSalesChannelsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/detachProductsFromSalesChannelsStep", "title": "detachProductsFromSalesChannelsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateSalesChannelsStep", "title": "updateSalesChannelsStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Settings", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createViewConfigurationWorkflow", "title": "createViewConfigurationWorkflow", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateViewConfigurationWorkflow", "title": "updateViewConfigurationWorkflow", "description": "", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createViewConfigurationStep", "title": "createViewConfigurationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/setActiveViewConfigurationStep", "title": "setActiveViewConfigurationStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateViewConfigurationStep", "title": "updateViewConfigurationStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Shipping Options", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createShippingOptionTypesWorkflow", "title": "createShippingOptionTypesWorkflow", "description": "Create one or more shipping option types.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteShippingOptionTypesWorkflow", "title": "deleteShippingOptionTypesWorkflow", "description": "Delete one or more shipping option types.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateShippingOptionTypesWorkflow", "title": "updateShippingOptionTypesWorkflow", "description": "Update one or more shipping option types.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createShippingOptionTypesStep", "title": "createShippingOptionTypesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteShippingOptionTypesStep", "title": "deleteShippingOptionTypesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/listShippingOptionsForContextStep", "title": "listShippingOptionsForContextStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateShippingOptionTypesStep", "title": "updateShippingOptionTypesStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Shipping Profile", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteShippingProfileWorkflow", "title": "deleteShippingProfileWorkflow", "description": "Delete shipping profiles.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteShippingProfilesStep", "title": "deleteShippingProfilesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/validateStepShippingProfileDelete", "title": "validateStepShippingProfileDelete", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Stock Location", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createLocationFulfillmentSetWorkflow", "title": "createLocationFulfillmentSetWorkflow", "description": "Add fulfillment set to a stock location.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createStockLocationsWorkflow", "title": "createStockLocationsWorkflow", "description": "Create one or more stock locations.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteStockLocationsWorkflow", "title": "deleteStockLocationsWorkflow", "description": "Delete one or more stock locations.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/linkSalesChannelsToStockLocationWorkflow", "title": "linkSalesChannelsToStockLocationWorkflow", "description": "Manage the sales channels of a stock location.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateStockLocationsWorkflow", "title": "updateStockLocationsWorkflow", "description": "Update stock locations.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createStockLocations", "title": "createStockLocations", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteStockLocationsStep", "title": "deleteStockLocationsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateStockLocationsStep", "title": "updateStockLocationsStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Store", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createStoresWorkflow", "title": "createStoresWorkflow", "description": "Create one or more stores.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteStoresWorkflow", "title": "deleteStoresWorkflow", "description": "Delete one or more stores.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateStoresWorkflow", "title": "updateStoresWorkflow", "description": "Update stores.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createStoresStep", "title": "createStoresStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteStoresStep", "title": "deleteStoresStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateStoresStep", "title": "updateStoresStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Tax", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createTaxRateRulesWorkflow", "title": "createTaxRateRulesWorkflow", "description": "Create one or more tax rules for rates.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createTaxRatesWorkflow", "title": "createTaxRatesWorkflow", "description": "Create one or more tax rates.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createTaxRegionsWorkflow", "title": "createTaxRegionsWorkflow", "description": "Create one or more tax regions.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteTaxRateRulesWorkflow", "title": "deleteTaxRateRulesWorkflow", "description": "Delete one or more tax rate rules.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteTaxRatesWorkflow", "title": "deleteTaxRatesWorkflow", "description": "Delete one or more tax rates.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteTaxRegionsWorkflow", "title": "deleteTaxRegionsWorkflow", "description": "Delete one or more tax regions.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/setTaxRateRulesWorkflow", "title": "setTaxRateRulesWorkflow", "description": "Set the rules of tax rates.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateTaxRatesWorkflow", "title": "updateTaxRatesWorkflow", "description": "Update tax rates.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateTaxRegionsWorkflow", "title": "updateTaxRegionsWorkflow", "description": "Update one or more tax regions.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createTaxRateRulesStep", "title": "createTaxRateRulesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createTaxRatesStep", "title": "createTaxRatesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createTaxRegionsStep", "title": "createTaxRegionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteTaxRateRulesStep", "title": "deleteTaxRateRulesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteTaxRatesStep", "title": "deleteTaxRatesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteTaxRegionsStep", "title": "deleteTaxRegionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/getItemTaxLinesStep", "title": "getItemTaxLinesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/listTaxRateIdsStep", "title": "listTaxRateIdsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/listTaxRateRuleIdsStep", "title": "listTaxRateRuleIdsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateTaxRatesStep", "title": "updateTaxRatesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateTaxRegionsStep", "title": "updateTaxRegionsStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/maybeListTaxRateRuleIdsStep", "title": "maybeListTaxRateRuleIdsStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "User", "children": [ { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Workflows", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createUserAccountWorkflow", "title": "createUserAccountWorkflow", "description": "Create a user account and attach an auth identity.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/createUsersWorkflow", "title": "createUsersWorkflow", "description": "Create one or more users.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/deleteUsersWorkflow", "title": "deleteUsersWorkflow", "description": "Delete one or more users.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/removeUserAccountWorkflow", "title": "removeUserAccountWorkflow", "description": "Delete a user and remove the association to its auth identity.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/updateUsersWorkflow", "title": "updateUsersWorkflow", "description": "Update one or more users.", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "sub-category", "title": "Steps", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/createUsersStep", "title": "createUsersStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/deleteUsersStep", "title": "deleteUsersStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/medusa-workflows/steps/updateUsersStep", "title": "updateUsersStep", "description": "", "children": [] } ] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "sidebar", "sidebar_id": "dml-reference", "title": "Data Model Language", "childSidebarTitle": "Data Model Language Reference", "description": "API reference of the Data Model Langauge (DML).", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/data-model", "title": "Overview", "children": [] }, { "type": "separator" }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/data-model/define", "title": "Define Method", "children": [] }, { "type": "separator" }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Property Types", "autogenerate_path": "/references/dml/Property_Types/methods", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/data-model/property-types/array", "title": "array", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/data-model/property-types/bignumber", "title": "bigNumber", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/data-model/property-types/boolean", "title": "boolean", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/data-model/property-types/datetime", "title": "dateTime", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/data-model/property-types/enum", "title": "enum", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/data-model/property-types/float", "title": "float", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/data-model/property-types/id", "title": "id", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/data-model/property-types/json", "title": "json", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/data-model/property-types/number", "title": "number", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/data-model/property-types/text", "title": "text", "description": "", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Relationship Methods", "autogenerate_path": "/references/dml/Relationship_Methods/methods", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/data-model/relationship-methods/belongsto", "title": "belongsTo", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/data-model/relationship-methods/hasmany", "title": "hasMany", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/data-model/relationship-methods/hasone", "title": "hasOne", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/data-model/relationship-methods/manytomany", "title": "manyToMany", "description": "", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Model Methods", "autogenerate_path": "/references/dml/Model_Methods/methods", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/data-model/model-methods/cascades", "title": "cascades", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/data-model/model-methods/indexes", "title": "indexes", "description": "", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Property Configuration Methods", "autogenerate_path": "/references/dml/Property_Configuration_Methods/methods", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/data-model/property-configuration/computed", "title": "computed", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/data-model/property-configuration/default", "title": "default", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/data-model/property-configuration/index", "title": "index", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/data-model/property-configuration/nullable", "title": "nullable", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/data-model/property-configuration/unique", "title": "unique", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "sidebar", "sidebar_id": "data-model-repository-reference", "title": "Data Model Repository", "description": "List of methods in your service extending the data model repository.", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/data-model-repository-reference", "title": "Overview", "children": [] }, { "type": "separator" }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Methods", "initialOpen": true, "autogenerate_path": "/data-model-repository-reference/methods", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/data-model-repository-reference/methods/create", "title": "create", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/data-model-repository-reference/methods/delete", "title": "delete", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/data-model-repository-reference/methods/find", "title": "find", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/data-model-repository-reference/methods/findAndCount", "title": "findAndCount", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/data-model-repository-reference/methods/restore", "title": "restore", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/data-model-repository-reference/methods/softDelete", "title": "softDelete", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/data-model-repository-reference/methods/update", "title": "update", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/data-model-repository-reference/methods/upsert", "title": "upsert", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/data-model-repository-reference/methods/upsertWithReplace", "title": "upsertWithReplace", "description": "", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Tips", "initialOpen": true, "autogenerate_path": "/data-model-repository-reference/tips", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/data-model-repository-reference/tips/filtering", "title": "Filtering", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/events", "title": "Events", "description": "List of events emitted by Medusa's Commerce Modules.", "children": [] }, { "loaded": true, "isPathHref": true, "type": "sidebar", "sidebar_id": "helper-steps-reference", "title": "Helper Steps", "description": "Steps to query data, emit events, create links, and more.", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/helper-steps", "title": "Overview", "children": [] }, { "type": "separator" }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Steps", "autogenerate_path": "/references/helper_steps/functions", "initialOpen": true, "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/helper-steps/createEntitiesStep", "title": "createEntitiesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/helper-steps/createRemoteLinkStep", "title": "createRemoteLinkStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/helper-steps/deleteEntitiesStep", "title": "deleteEntitiesStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/helper-steps/dismissRemoteLinkStep", "title": "dismissRemoteLinkStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/helper-steps/emitEventStep", "title": "emitEventStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/helper-steps/removeRemoteLinkStep", "title": "removeRemoteLinkStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/helper-steps/updateRemoteLinksStep", "title": "updateRemoteLinksStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/helper-steps/useQueryGraphStep", "title": "useQueryGraphStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/helper-steps/useRemoteQueryStep", "title": "useRemoteQueryStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/helper-steps/validatePresenceOfStep", "title": "validatePresenceOfStep", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "sidebar", "sidebar_id": "service-factory-reference", "title": "Service Factory", "description": "List of methods in your service extending the service factory.", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/service-factory-reference", "title": "Overview", "children": [] }, { "type": "separator" }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Methods", "initialOpen": true, "autogenerate_path": "/service-factory-reference/methods", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/service-factory-reference/methods/create", "title": "create", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/service-factory-reference/methods/delete", "title": "delete", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/service-factory-reference/methods/list", "title": "list", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/service-factory-reference/methods/listAndCount", "title": "listAndCount", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/service-factory-reference/methods/restore", "title": "restore", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/service-factory-reference/methods/retrieve", "title": "retrieve", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/service-factory-reference/methods/soft-delete", "title": "softDelete", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/service-factory-reference/methods/update", "title": "update", "description": "", "children": [] } ] }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Tips", "initialOpen": true, "autogenerate_path": "/service-factory-reference/tips", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/service-factory-reference/tips/filtering", "title": "Filtering", "description": "", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "sidebar", "sidebar_id": "test-tools-reference", "title": "Testing Framework", "description": "API reference of functions you can use to write tests.", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/test-tools-reference", "title": "Overview", "children": [] }, { "type": "separator" }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Functions", "initialOpen": true, "children": [ { "loaded": true, "isPathHref": true, "type": "link", "title": "medusaIntegrationTestRunner", "path": "/test-tools-reference/medusaIntegrationTestRunner", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "title": "moduleIntegrationTestRunner", "path": "/test-tools-reference/moduleIntegrationTestRunner", "children": [] } ] } ] }, { "loaded": true, "isPathHref": true, "type": "sidebar", "sidebar_id": "workflows-sdk-reference", "title": "Workflows SDK", "childSidebarTitle": "Workflows SDK Reference", "description": "API reference of the Workflow SDK functions and helpers.", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/workflows", "title": "Overview", "children": [] }, { "type": "separator" }, { "loaded": true, "isPathHref": true, "type": "category", "title": "Functions", "initialOpen": true, "autogenerate_path": "/references/workflows/functions", "children": [ { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/workflows/applyStep", "title": "applyStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/workflows/createHook", "title": "createHook", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/workflows/createStep", "title": "createStep", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/workflows/createWorkflow", "title": "createWorkflow", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/workflows/parallelize", "title": "parallelize", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/workflows/resolveValue", "title": "resolveValue", "description": "", "children": [] }, { "loaded": true, "isPathHref": true, "type": "link", "path": "/references/workflows/transform", "title": "transform", "description": "", "children": [] } ] } ] } ] } export default generatedgeneratedReferencesSidebarSidebar