chore(docs): Generated References (automated) (#9772)
Generated the following references: - `auth_provider` - `core_flows` - `js_sdk` - `medusa_config` - `modules` - `payment_provider` - `tax` - `tax_provider` - `types` - `workflows` Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andShahed Nasser authored and 
GitHub committed
1 parent
59e6747800
commit
d40499ca6a
613 files changed
+56943
-55109
No files matched your search
@@ -3327,7 +3327,7 @@ This workflow deletes one or more API keys.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"deleteApiKeysWorkflow","steps":[{"type":"step","name":"deleteApiKeysStep","description":"This step deletes one or more API keys.","link":"../../core_flows/core_flows.Steps_Api_Key/page.mdx#deleteapikeysstep","depth":1},{"type":"step","name":"removeRemoteLinkStep","description":"This step deletes linked records of a record.\n\nLearn more in the [Remote Link documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#removeremotelinkstep","depth":2}]}} />
|
||||
<undefined workflow={{"name":"deleteApiKeysWorkflow","steps":[{"type":"step","name":"deleteApiKeysStep","description":"This step deletes one or more API keys.","link":"../../core_flows/core_flows.Steps_Api_Key/page.mdx#deleteapikeysstep","depth":1},{"type":"step","name":"removeRemoteLinkStep","description":"This step deletes linked records of a record.\n\nLearn more in the [Remote Link documentation](https://docs.medusajs.com/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#removeremotelinkstep","depth":2}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -3393,7 +3393,7 @@ This step sets the `app_metadata` property of an auth identity.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"generateResetPasswordTokenWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":2}]}} />
|
||||
<undefined workflow={{"name":"generateResetPasswordTokenWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":2}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -3732,7 +3732,7 @@ This workflow adds shipping methods to a cart.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"addShippingMethodToCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"validateCartShippingOptionsStep","description":"This step validates shipping options to ensure they can be applied on a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#validatecartshippingoptionsstep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"removeShippingMethodFromCartStep","description":"This step removes shipping methods from a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#removeshippingmethodfromcartstep","depth":4},{"type":"step","name":"addShippingMethodToCartStep","description":"This step adds shipping methods to a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#addshippingmethodtocartstep","depth":4},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":4},{"type":"workflow","name":"updateTaxLinesWorkflow","description":"This workflow updates a cart's tax lines.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatetaxlinesworkflow","depth":5},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"This workflow updates a cart's promotions.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatecartpromotionsworkflow","depth":6}]}} />
|
||||
<undefined workflow={{"name":"addShippingMethodToCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"validateCartShippingOptionsStep","description":"This step validates shipping options to ensure they can be applied on a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#validatecartshippingoptionsstep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"removeShippingMethodFromCartStep","description":"This step removes shipping methods from a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#removeshippingmethodfromcartstep","depth":4},{"type":"step","name":"addShippingMethodToCartStep","description":"This step adds shipping methods to a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#addshippingmethodtocartstep","depth":4},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":4},{"type":"workflow","name":"updateTaxLinesWorkflow","description":"This workflow updates a cart's tax lines.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatetaxlinesworkflow","depth":5},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"This workflow updates a cart's promotions.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatecartpromotionsworkflow","depth":6}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -3744,7 +3744,7 @@ This workflow adds items to a cart.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"addToCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#validatevariantpricesstep","depth":2},{"type":"step","name":"getLineItemActionsStep","description":"This step returns lists of cart line items to create or update based on the\nprovided input.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#getlineitemactionsstep","depth":3},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#confirmvariantinventoryworkflow","depth":4},{"type":"step","name":"createLineItemsStep","description":"This step creates line item in a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#createlineitemsstep","depth":5},{"type":"step","name":"updateLineItemsStep","description":"This step updates a cart's line items.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#updatelineitemsstep","depth":5},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":6},{"type":"step","name":"refreshCartShippingMethodsStep","description":"This step refreshes the shipping methods of a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#refreshcartshippingmethodsstep","depth":7},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":7},{"type":"workflow","name":"updateTaxLinesWorkflow","description":"This workflow updates a cart's tax lines.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatetaxlinesworkflow","depth":8},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"This workflow updates a cart's promotions.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatecartpromotionsworkflow","depth":9},{"type":"workflow","name":"refreshPaymentCollectionForCartWorkflow","description":"This workflow refreshes the payment collections of a cart.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#refreshpaymentcollectionforcartworkflow","depth":10}]}} />
|
||||
<undefined workflow={{"name":"addToCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#validatevariantpricesstep","depth":2},{"type":"step","name":"getLineItemActionsStep","description":"This step returns lists of cart line items to create or update based on the\nprovided input.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#getlineitemactionsstep","depth":3},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#confirmvariantinventoryworkflow","depth":4},{"type":"step","name":"createLineItemsStep","description":"This step creates line item in a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#createlineitemsstep","depth":5},{"type":"step","name":"updateLineItemsStep","description":"This step updates a cart's line items.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#updatelineitemsstep","depth":5},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":6},{"type":"step","name":"refreshCartShippingMethodsStep","description":"This step refreshes the shipping methods of a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#refreshcartshippingmethodsstep","depth":7},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":7},{"type":"workflow","name":"updateTaxLinesWorkflow","description":"This workflow updates a cart's tax lines.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatetaxlinesworkflow","depth":8},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"This workflow updates a cart's promotions.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatecartpromotionsworkflow","depth":9},{"type":"workflow","name":"refreshPaymentCollectionForCartWorkflow","description":"This workflow refreshes the payment collections of a cart.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#refreshpaymentcollectionforcartworkflow","depth":10}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -3760,7 +3760,7 @@ This workflow completes a cart.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"completeCartWorkflow","steps":[{"type":"when","condition":"{\n return !orderId\n }","depth":"1","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"validateCartPaymentsStep","description":"This step validates a cart's payment sessions. Their status must\nbe `pending` or `requires_more`.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#validatecartpaymentsstep","depth":1},{"type":"step","name":"authorizePaymentSessionStep","description":"This step authorizes a payment session.","link":"../../core_flows/core_flows.Steps_Payment/page.mdx#authorizepaymentsessionstep","depth":1},{"type":"step","name":"createOrdersStep","description":"This step creates one or more orders.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createordersstep","depth":1},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#create-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#createremotelinkstep","depth":1},{"type":"step","name":"updateCartsStep","description":"This step updates a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#updatecartsstep","depth":1},{"type":"step","name":"reserveInventoryStep","description":"This step reserves the quantity of line items from the associated\nvariant's inventory.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#reserveinventorystep","depth":1},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":1}]}]}} />
|
||||
<undefined workflow={{"name":"completeCartWorkflow","steps":[{"type":"when","condition":"{\n return !orderId\n }","depth":"1","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"validateCartPaymentsStep","description":"This step validates a cart's payment sessions. Their status must\nbe `pending` or `requires_more`.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#validatecartpaymentsstep","depth":1},{"type":"step","name":"authorizePaymentSessionStep","description":"This step authorizes a payment session.","link":"../../core_flows/core_flows.Steps_Payment/page.mdx#authorizepaymentsessionstep","depth":1},{"type":"step","name":"createOrdersStep","description":"This step creates one or more orders.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createordersstep","depth":1},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/advanced-development/modules/remote-link#create-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#createremotelinkstep","depth":1},{"type":"step","name":"updateCartsStep","description":"This step updates a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#updatecartsstep","depth":1},{"type":"step","name":"reserveInventoryStep","description":"This step reserves the quantity of line items from the associated\nvariant's inventory.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#reserveinventorystep","depth":1},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":1}]}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -3792,7 +3792,7 @@ This workflow creates a cart.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"createCartWorkflow","steps":[{"type":"step","name":"findSalesChannelStep","description":"This step either retrieves a sales channel either using the ID provided as an input, or, if no ID\nis provided, the default sales channel of the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findsaleschannelstep","depth":1},{"type":"step","name":"findOneOrAnyRegionStep","description":"This step retrieves a region either by the provided ID or the first region in the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findoneoranyregionstep","depth":1},{"type":"step","name":"findOrCreateCustomerStep","description":"This step either finds a customer matching the specified ID, or finds / create a customer\nmatching the specified email. If both ID and email are provided, ID takes precedence.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findorcreatecustomerstep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#validatevariantpricesstep","depth":3},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#confirmvariantinventoryworkflow","depth":4},{"type":"step","name":"getVariantPriceSetsStep","description":"This step retrieves the calculated price sets of the specified variants.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#getvariantpricesetsstep","depth":5},{"type":"step","name":"createCartsStep","description":"This step creates a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#createcartsstep","depth":6},{"type":"workflow","name":"updateTaxLinesWorkflow","description":"This workflow updates a cart's tax lines.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatetaxlinesworkflow","depth":7},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"This workflow updates a cart's promotions.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatecartpromotionsworkflow","depth":8},{"type":"workflow","name":"refreshPaymentCollectionForCartWorkflow","description":"This workflow refreshes the payment collections of a cart.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#refreshpaymentcollectionforcartworkflow","depth":9},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":9},{"type":"hook","name":"cartCreated","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#cartCreated","depth":10}]}} />
|
||||
<undefined workflow={{"name":"createCartWorkflow","steps":[{"type":"step","name":"findSalesChannelStep","description":"This step either retrieves a sales channel either using the ID provided as an input, or, if no ID\nis provided, the default sales channel of the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findsaleschannelstep","depth":1},{"type":"step","name":"findOneOrAnyRegionStep","description":"This step retrieves a region either by the provided ID or the first region in the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findoneoranyregionstep","depth":1},{"type":"step","name":"findOrCreateCustomerStep","description":"This step either finds a customer matching the specified ID, or finds / create a customer\nmatching the specified email. If both ID and email are provided, ID takes precedence.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findorcreatecustomerstep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#validatevariantpricesstep","depth":3},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#confirmvariantinventoryworkflow","depth":4},{"type":"step","name":"getVariantPriceSetsStep","description":"This step retrieves the calculated price sets of the specified variants.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#getvariantpricesetsstep","depth":5},{"type":"step","name":"createCartsStep","description":"This step creates a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#createcartsstep","depth":6},{"type":"workflow","name":"updateTaxLinesWorkflow","description":"This workflow updates a cart's tax lines.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatetaxlinesworkflow","depth":7},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"This workflow updates a cart's promotions.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatecartpromotionsworkflow","depth":8},{"type":"workflow","name":"refreshPaymentCollectionForCartWorkflow","description":"This workflow refreshes the payment collections of a cart.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#refreshpaymentcollectionforcartworkflow","depth":9},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":9},{"type":"hook","name":"cartCreated","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#cartCreated","depth":10}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -3838,7 +3838,7 @@ This workflow creates a payment collection for a cart.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"createPaymentCollectionForCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"validateExistingPaymentCollectionStep","description":"This step validates that a cart doesn't have a payment collection.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#validateexistingpaymentcollectionstep","depth":2},{"type":"step","name":"createPaymentCollectionsStep","description":"This step creates payment collections in a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#createpaymentcollectionsstep","depth":3},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#create-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#createremotelinkstep","depth":4}]}} />
|
||||
<undefined workflow={{"name":"createPaymentCollectionForCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"validateExistingPaymentCollectionStep","description":"This step validates that a cart doesn't have a payment collection.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#validateexistingpaymentcollectionstep","depth":2},{"type":"step","name":"createPaymentCollectionsStep","description":"This step creates payment collections in a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#createpaymentcollectionsstep","depth":3},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/advanced-development/modules/remote-link#create-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#createremotelinkstep","depth":4}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -3850,7 +3850,7 @@ This workflow lists the shipping options of a cart.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"listShippingOptionsForCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2}]}} />
|
||||
<undefined workflow={{"name":"listShippingOptionsForCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -3862,7 +3862,7 @@ This workflow refreshes the payment collections of a cart.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"refreshPaymentCollectionForCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"when","condition":"{\n const valueIsEqual = MathBN.eq(\n cart.payment_collection?.raw_amount ?? -1,\n cart.raw_total\n )\n\n if (valueIsEqual) {\n return cart.payment_collection.currency_code !== cart.currency_code\n }\n\n return true\n }","depth":"2","steps":[{"type":"workflow","name":"deletePaymentSessionsWorkflow","description":"This workflow deletes one or more payment sessions.","link":"../../core_flows/core_flows.Workflows_Payment_Collection/page.mdx#deletepaymentsessionsworkflow","depth":2},{"type":"step","name":"updatePaymentCollectionStep","description":"This step updates payment collections matching the specified filters.","link":"../../core_flows/core_flows.Steps_Payment_Collection/page.mdx#updatepaymentcollectionstep","depth":2}]}]}} />
|
||||
<undefined workflow={{"name":"refreshPaymentCollectionForCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"when","condition":"{\n const valueIsEqual = MathBN.eq(\n cart.payment_collection?.raw_amount ?? -1,\n cart.raw_total\n )\n\n if (valueIsEqual) {\n return cart.payment_collection.currency_code !== cart.currency_code\n }\n\n return true\n }","depth":"2","steps":[{"type":"workflow","name":"deletePaymentSessionsWorkflow","description":"This workflow deletes one or more payment sessions.","link":"../../core_flows/core_flows.Workflows_Payment_Collection/page.mdx#deletepaymentsessionsworkflow","depth":2},{"type":"step","name":"updatePaymentCollectionStep","description":"This step updates payment collections matching the specified filters.","link":"../../core_flows/core_flows.Steps_Payment_Collection/page.mdx#updatepaymentcollectionstep","depth":2}]}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -3874,7 +3874,7 @@ This workflow updates a cart's promotions.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"updateCartPromotionsWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"getPromotionCodesToApply","description":"This step retrieves the promotion codes to apply on a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#getpromotioncodestoapply","depth":2},{"type":"step","name":"getActionsToComputeFromPromotionsStep","description":"This step retrieves the actions to compute based on the promotions\napplied on a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#getactionstocomputefrompromotionsstep","depth":3},{"type":"step","name":"prepareAdjustmentsFromPromotionActionsStep","description":"This step prepares the line item or shipping method adjustments using\nactions computed by the Promotion Module.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#prepareadjustmentsfrompromotionactionsstep","depth":4},{"type":"step","name":"removeLineItemAdjustmentsStep","description":"This step removes line item adjustments from a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#removelineitemadjustmentsstep","depth":5},{"type":"step","name":"removeShippingMethodAdjustmentsStep","description":"This step removes shipping method adjustments from a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#removeshippingmethodadjustmentsstep","depth":5},{"type":"step","name":"createLineItemAdjustmentsStep","description":"This step creates line item adjustments in a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#createlineitemadjustmentsstep","depth":5},{"type":"step","name":"createShippingMethodAdjustmentsStep","description":"This step creates shipping method adjustments for a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#createshippingmethodadjustmentsstep","depth":5},{"type":"step","name":"updateCartPromotionsStep","description":"This step updates the promotions applied on a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#updatecartpromotionsstep","depth":5}]}} />
|
||||
<undefined workflow={{"name":"updateCartPromotionsWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"getPromotionCodesToApply","description":"This step retrieves the promotion codes to apply on a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#getpromotioncodestoapply","depth":2},{"type":"step","name":"getActionsToComputeFromPromotionsStep","description":"This step retrieves the actions to compute based on the promotions\napplied on a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#getactionstocomputefrompromotionsstep","depth":3},{"type":"step","name":"prepareAdjustmentsFromPromotionActionsStep","description":"This step prepares the line item or shipping method adjustments using\nactions computed by the Promotion Module.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#prepareadjustmentsfrompromotionactionsstep","depth":4},{"type":"step","name":"removeLineItemAdjustmentsStep","description":"This step removes line item adjustments from a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#removelineitemadjustmentsstep","depth":5},{"type":"step","name":"removeShippingMethodAdjustmentsStep","description":"This step removes shipping method adjustments from a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#removeshippingmethodadjustmentsstep","depth":5},{"type":"step","name":"createLineItemAdjustmentsStep","description":"This step creates line item adjustments in a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#createlineitemadjustmentsstep","depth":5},{"type":"step","name":"createShippingMethodAdjustmentsStep","description":"This step creates shipping method adjustments for a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#createshippingmethodadjustmentsstep","depth":5},{"type":"step","name":"updateCartPromotionsStep","description":"This step updates the promotions applied on a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#updatecartpromotionsstep","depth":5}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -3886,7 +3886,7 @@ This workflow updates a cart.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"updateCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"findSalesChannelStep","description":"This step either retrieves a sales channel either using the ID provided as an input, or, if no ID\nis provided, the default sales channel of the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findsaleschannelstep","depth":2},{"type":"step","name":"findOrCreateCustomerStep","description":"This step either finds a customer matching the specified ID, or finds / create a customer\nmatching the specified email. If both ID and email are provided, ID takes precedence.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findorcreatecustomerstep","depth":2},{"type":"when","condition":"{\n return !!data.input.region_id\n }","depth":"3","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3}]},{"type":"when","condition":"{\n return isDefined(cartInput.customer_id) || isDefined(cartInput.email)\n }","depth":"4","steps":[{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":4}]},{"type":"when","condition":"{\n return (\n isDefined(input.region_id) &&\n input.region_id !== cartToUpdate?.region?.id\n )\n }","depth":"5","steps":[{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":5}]},{"type":"step","name":"updateCartsStep","description":"This step updates a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#updatecartsstep","depth":6},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":6},{"type":"hook","name":"cartUpdated","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#cartUpdated","depth":7}]}} />
|
||||
<undefined workflow={{"name":"updateCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"findSalesChannelStep","description":"This step either retrieves a sales channel either using the ID provided as an input, or, if no ID\nis provided, the default sales channel of the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findsaleschannelstep","depth":2},{"type":"step","name":"findOrCreateCustomerStep","description":"This step either finds a customer matching the specified ID, or finds / create a customer\nmatching the specified email. If both ID and email are provided, ID takes precedence.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findorcreatecustomerstep","depth":2},{"type":"when","condition":"{\n return !!data.input.region_id\n }","depth":"3","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3}]},{"type":"when","condition":"{\n return isDefined(cartInput.customer_id) || isDefined(cartInput.email)\n }","depth":"4","steps":[{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":4}]},{"type":"when","condition":"{\n return (\n isDefined(input.region_id) &&\n input.region_id !== cartToUpdate?.region?.id\n )\n }","depth":"5","steps":[{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":5}]},{"type":"step","name":"updateCartsStep","description":"This step updates a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#updatecartsstep","depth":6},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":6},{"type":"hook","name":"cartUpdated","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#cartUpdated","depth":7}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -3924,7 +3924,7 @@ This workflow updates a cart's line item.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"updateLineItemInCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#validatevariantpricesstep","depth":2},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#confirmvariantinventoryworkflow","depth":3},{"type":"step","name":"updateLineItemsStepWithSelector","description":"This step updates line items.","link":"../../core_flows/core_flows.Steps_Line_Item/page.mdx#updatelineitemsstepwithselector","depth":4},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":5},{"type":"step","name":"refreshCartShippingMethodsStep","description":"This step refreshes the shipping methods of a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#refreshcartshippingmethodsstep","depth":6},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"This workflow updates a cart's promotions.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatecartpromotionsworkflow","depth":7},{"type":"workflow","name":"refreshPaymentCollectionForCartWorkflow","description":"This workflow refreshes the payment collections of a cart.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#refreshpaymentcollectionforcartworkflow","depth":8},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":8}]}} />
|
||||
<undefined workflow={{"name":"updateLineItemInCartWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#validatevariantpricesstep","depth":2},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#confirmvariantinventoryworkflow","depth":3},{"type":"step","name":"updateLineItemsStepWithSelector","description":"This step updates line items.","link":"../../core_flows/core_flows.Steps_Line_Item/page.mdx#updatelineitemsstepwithselector","depth":4},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":5},{"type":"step","name":"refreshCartShippingMethodsStep","description":"This step refreshes the shipping methods of a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#refreshcartshippingmethodsstep","depth":6},{"type":"workflow","name":"updateCartPromotionsWorkflow","description":"This workflow updates a cart's promotions.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#updatecartpromotionsworkflow","depth":7},{"type":"workflow","name":"refreshPaymentCollectionForCartWorkflow","description":"This workflow refreshes the payment collections of a cart.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#refreshpaymentcollectionforcartworkflow","depth":8},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":8}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -3940,7 +3940,7 @@ This workflow updates a cart's tax lines.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"updateTaxLinesWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"getItemTaxLinesStep","description":"This step retrieves the tax lines of the specified line items in a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#getitemtaxlinesstep","depth":2},{"type":"step","name":"setTaxLinesForItemsStep","description":"This step sets the tax lines of shipping methods and line items in a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#settaxlinesforitemsstep","depth":3}]}} />
|
||||
<undefined workflow={{"name":"updateTaxLinesWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"getItemTaxLinesStep","description":"This step retrieves the tax lines of the specified line items in a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#getitemtaxlinesstep","depth":2},{"type":"step","name":"setTaxLinesForItemsStep","description":"This step sets the tax lines of shipping methods and line items in a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#settaxlinesforitemsstep","depth":3}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -3950,7 +3950,7 @@ This workflow updates a cart's tax lines.
|
||||
|
||||
This step creates remote links between two records of linked data models.
|
||||
|
||||
Learn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#create-link).
|
||||
Learn more in the [Remote Link documentation.](https://docs.medusajs.com/advanced-development/modules/remote-link#create-link).
|
||||
|
||||
#### Example
|
||||
|
||||
@@ -3985,7 +3985,7 @@ const helloWorldWorkflow = createWorkflow("hello-world", () => {
|
||||
|
||||
This step removes remote links between two records of linked data models.
|
||||
|
||||
Learn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#dismiss-link).
|
||||
Learn more in the [Remote Link documentation.](https://docs.medusajs.com/advanced-development/modules/remote-link#dismiss-link).
|
||||
|
||||
#### Example
|
||||
|
||||
@@ -4058,7 +4058,7 @@ const helloWorldWorkflow = createWorkflow(
|
||||
|
||||
This step deletes linked records of a record.
|
||||
|
||||
Learn more in the [Remote Link documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#cascade-delete-linked-records)
|
||||
Learn more in the [Remote Link documentation](https://docs.medusajs.com/advanced-development/modules/remote-link#cascade-delete-linked-records)
|
||||
|
||||
#### Example
|
||||
|
||||
@@ -4121,7 +4121,7 @@ const helloWorldWorkflow = createWorkflow(
|
||||
|
||||
This step fetches data across modules using the remote query.
|
||||
|
||||
Learn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).
|
||||
Learn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).
|
||||
|
||||
#### Example
|
||||
|
||||
@@ -4220,7 +4220,7 @@ This workflow manages one or more links to create, update, or dismiss them.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"batchLinksWorkflow","steps":[{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#create-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#createremotelinkstep","depth":1},{"type":"step","name":"updateRemoteLinksStep","description":"","link":"../../core_flows/core_flows.Steps_Common/page.mdx#updateremotelinksstep","depth":1},{"type":"step","name":"dismissRemoteLinkStep","description":"This step removes remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#dismiss-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#dismissremotelinkstep","depth":1}]}} />
|
||||
<undefined workflow={{"name":"batchLinksWorkflow","steps":[{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/advanced-development/modules/remote-link#create-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#createremotelinkstep","depth":1},{"type":"step","name":"updateRemoteLinksStep","description":"","link":"../../core_flows/core_flows.Steps_Common/page.mdx#updateremotelinksstep","depth":1},{"type":"step","name":"dismissRemoteLinkStep","description":"This step removes remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/advanced-development/modules/remote-link#dismiss-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#dismissremotelinkstep","depth":1}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -4236,7 +4236,7 @@ This workflow creates one or more links between records.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"createLinksWorkflow","steps":[{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#create-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#createremotelinkstep","depth":1}]}} />
|
||||
<undefined workflow={{"name":"createLinksWorkflow","steps":[{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/advanced-development/modules/remote-link#create-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#createremotelinkstep","depth":1}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -4252,7 +4252,7 @@ This workflow dismisses one or more links between records.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"dismissLinksWorkflow","steps":[{"type":"step","name":"dismissRemoteLinkStep","description":"This step removes remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#dismiss-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#dismissremotelinkstep","depth":1}]}} />
|
||||
<undefined workflow={{"name":"dismissLinksWorkflow","steps":[{"type":"step","name":"dismissRemoteLinkStep","description":"This step removes remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/advanced-development/modules/remote-link#dismiss-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#dismissremotelinkstep","depth":1}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -4620,7 +4620,7 @@ This workflow deletes a user and remove the association in the auth identity.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"removeCustomerAccountWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"workflow","name":"deleteCustomersWorkflow","description":"This workflow deletes one or more customers.","link":"../../core_flows/core_flows.Workflows_Customer/page.mdx#deletecustomersworkflow","depth":2},{"type":"when","condition":"{\n return !!customers[0]?.has_account\n }","depth":"3","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"setAuthAppMetadataStep","description":"This step sets the `app_metadata` property of an auth identity.","link":"../../core_flows/core_flows.Steps_Auth/page.mdx#setauthappmetadatastep","depth":3}]}]}} />
|
||||
<undefined workflow={{"name":"removeCustomerAccountWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"workflow","name":"deleteCustomersWorkflow","description":"This workflow deletes one or more customers.","link":"../../core_flows/core_flows.Workflows_Customer/page.mdx#deletecustomersworkflow","depth":2},{"type":"when","condition":"{\n return !!customers[0]?.has_account\n }","depth":"3","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"setAuthAppMetadataStep","description":"This step sets the `app_metadata` property of an auth identity.","link":"../../core_flows/core_flows.Steps_Auth/page.mdx#setauthappmetadatastep","depth":3}]}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -4996,7 +4996,7 @@ This workflow creates a fulfillment.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"createFulfillmentWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"createFulfillmentStep","description":"This step creates a fulfillment","link":"../../core_flows/core_flows.Steps_Fulfillment/page.mdx#createfulfillmentstep","depth":2}]}} />
|
||||
<undefined workflow={{"name":"createFulfillmentWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"createFulfillmentStep","description":"This step creates a fulfillment","link":"../../core_flows/core_flows.Steps_Fulfillment/page.mdx#createfulfillmentstep","depth":2}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -5012,7 +5012,7 @@ This workflow creates a fulfillment for a return.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"createReturnFulfillmentWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"createReturnFulfillmentStep","description":"This step creates a fulfillment for a return.","link":"../../core_flows/core_flows.Steps_Fulfillment/page.mdx#createreturnfulfillmentstep","depth":2}]}} />
|
||||
<undefined workflow={{"name":"createReturnFulfillmentWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"createReturnFulfillmentStep","description":"This step creates a fulfillment for a return.","link":"../../core_flows/core_flows.Steps_Fulfillment/page.mdx#createreturnfulfillmentstep","depth":2}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -5092,7 +5092,7 @@ This workflow deletes one or more fulfillment sets.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"deleteFulfillmentSetsWorkflow","steps":[{"type":"step","name":"deleteFulfillmentSetsStep","description":"This step deletes one or more fulfillment sets.","link":"../../core_flows/core_flows.Steps_Fulfillment/page.mdx#deletefulfillmentsetsstep","depth":1},{"type":"step","name":"removeRemoteLinkStep","description":"This step deletes linked records of a record.\n\nLearn more in the [Remote Link documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#removeremotelinkstep","depth":2}]}} />
|
||||
<undefined workflow={{"name":"deleteFulfillmentSetsWorkflow","steps":[{"type":"step","name":"deleteFulfillmentSetsStep","description":"This step deletes one or more fulfillment sets.","link":"../../core_flows/core_flows.Steps_Fulfillment/page.mdx#deletefulfillmentsetsstep","depth":1},{"type":"step","name":"removeRemoteLinkStep","description":"This step deletes linked records of a record.\n\nLearn more in the [Remote Link documentation](https://docs.medusajs.com/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#removeremotelinkstep","depth":2}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -5116,7 +5116,7 @@ This workflow deletes one or more shipping options.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"deleteShippingOptionsWorkflow","steps":[{"type":"step","name":"deleteShippingOptionsStep","description":"This step deletes one or more shipping options.","link":"../../core_flows/core_flows.Steps_Fulfillment/page.mdx#deleteshippingoptionsstep","depth":1},{"type":"step","name":"removeRemoteLinkStep","description":"This step deletes linked records of a record.\n\nLearn more in the [Remote Link documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#removeremotelinkstep","depth":2}]}} />
|
||||
<undefined workflow={{"name":"deleteShippingOptionsWorkflow","steps":[{"type":"step","name":"deleteShippingOptionsStep","description":"This step deletes one or more shipping options.","link":"../../core_flows/core_flows.Steps_Fulfillment/page.mdx#deleteshippingoptionsstep","depth":1},{"type":"step","name":"removeRemoteLinkStep","description":"This step deletes linked records of a record.\n\nLearn more in the [Remote Link documentation](https://docs.medusajs.com/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#removeremotelinkstep","depth":2}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -5136,7 +5136,7 @@ This workflow marks fulfillment as delivered.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"markFulfillmentAsDeliveredWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"validateFulfillmentDeliverabilityStep","description":"This step validates that if a fulfillment can be marked delivered","link":"../../core_flows/core_flows.Workflows_Fulfillment/page.mdx#validatefulfillmentdeliverabilitystep","depth":2},{"type":"workflow","name":"updateFulfillmentWorkflow","description":"This workflow updates a fulfillment.","link":"../../core_flows/core_flows.Workflows_Fulfillment/page.mdx#updatefulfillmentworkflow","depth":3}]}} />
|
||||
<undefined workflow={{"name":"markFulfillmentAsDeliveredWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"validateFulfillmentDeliverabilityStep","description":"This step validates that if a fulfillment can be marked delivered","link":"../../core_flows/core_flows.Workflows_Fulfillment/page.mdx#validatefulfillmentdeliverabilitystep","depth":2},{"type":"workflow","name":"updateFulfillmentWorkflow","description":"This workflow updates a fulfillment.","link":"../../core_flows/core_flows.Workflows_Fulfillment/page.mdx#updatefulfillmentworkflow","depth":3}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -5374,7 +5374,7 @@ This workflow deletes one or more inventory items.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"deleteInventoryItemWorkflow","steps":[{"type":"step","name":"useQueryGraphStep","description":"","link":"../../core_flows/core_flows.Steps_Common/page.mdx#usequerygraphstep","depth":1},{"type":"step","name":"validateInventoryDeleteStep","description":"","link":"../../core_flows/core_flows.Steps_Inventory/page.mdx#validateinventorydeletestep","depth":2},{"type":"step","name":"deleteInventoryItemStep","description":"This step deletes one or more inventory items.","link":"../../core_flows/core_flows.Steps_Inventory/page.mdx#deleteinventoryitemstep","depth":3},{"type":"step","name":"removeRemoteLinkStep","description":"This step deletes linked records of a record.\n\nLearn more in the [Remote Link documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#removeremotelinkstep","depth":4}]}} />
|
||||
<undefined workflow={{"name":"deleteInventoryItemWorkflow","steps":[{"type":"step","name":"useQueryGraphStep","description":"","link":"../../core_flows/core_flows.Steps_Common/page.mdx#usequerygraphstep","depth":1},{"type":"step","name":"validateInventoryDeleteStep","description":"","link":"../../core_flows/core_flows.Steps_Inventory/page.mdx#validateinventorydeletestep","depth":2},{"type":"step","name":"deleteInventoryItemStep","description":"This step deletes one or more inventory items.","link":"../../core_flows/core_flows.Steps_Inventory/page.mdx#deleteinventoryitemstep","depth":3},{"type":"step","name":"removeRemoteLinkStep","description":"This step deletes linked records of a record.\n\nLearn more in the [Remote Link documentation](https://docs.medusajs.com/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#removeremotelinkstep","depth":4}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -5398,7 +5398,7 @@ This workflow deletes one or more inventory levels.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"deleteInventoryLevelsWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"validateInventoryLevelsDelete","description":"This step validates that inventory levels are deletable.","link":"../../core_flows/core_flows.Workflows_Inventory/page.mdx#validateinventorylevelsdelete","depth":2}]}} />
|
||||
<undefined workflow={{"name":"deleteInventoryLevelsWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"validateInventoryLevelsDelete","description":"This step validates that inventory levels are deletable.","link":"../../core_flows/core_flows.Workflows_Inventory/page.mdx#validateinventorylevelsdelete","depth":2}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -5991,7 +5991,7 @@ This workflow adds line items to an order.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"addOrderLineItemsWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"findSalesChannelStep","description":"This step either retrieves a sales channel either using the ID provided as an input, or, if no ID\nis provided, the default sales channel of the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findsaleschannelstep","depth":2},{"type":"step","name":"findOneOrAnyRegionStep","description":"This step retrieves a region either by the provided ID or the first region in the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findoneoranyregionstep","depth":2},{"type":"step","name":"findOrCreateCustomerStep","description":"This step either finds a customer matching the specified ID, or finds / create a customer\nmatching the specified email. If both ID and email are provided, ID takes precedence.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findorcreatecustomerstep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#validatevariantpricesstep","depth":4},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#confirmvariantinventoryworkflow","depth":5},{"type":"step","name":"getVariantPriceSetsStep","description":"This step retrieves the calculated price sets of the specified variants.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#getvariantpricesetsstep","depth":6},{"type":"step","name":"createOrderLineItemsStep","description":"This step creates order line items.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createorderlineitemsstep","depth":7}]}} />
|
||||
<undefined workflow={{"name":"addOrderLineItemsWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"findSalesChannelStep","description":"This step either retrieves a sales channel either using the ID provided as an input, or, if no ID\nis provided, the default sales channel of the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findsaleschannelstep","depth":2},{"type":"step","name":"findOneOrAnyRegionStep","description":"This step retrieves a region either by the provided ID or the first region in the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findoneoranyregionstep","depth":2},{"type":"step","name":"findOrCreateCustomerStep","description":"This step either finds a customer matching the specified ID, or finds / create a customer\nmatching the specified email. If both ID and email are provided, ID takes precedence.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findorcreatecustomerstep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#validatevariantpricesstep","depth":4},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#confirmvariantinventoryworkflow","depth":5},{"type":"step","name":"getVariantPriceSetsStep","description":"This step retrieves the calculated price sets of the specified variants.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#getvariantpricesetsstep","depth":6},{"type":"step","name":"createOrderLineItemsStep","description":"This step creates order line items.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createorderlineitemsstep","depth":7}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6043,7 +6043,7 @@ This workflow cancels an order's fulfillment.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"cancelOrderFulfillmentWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"cancelOrderFulfillmentValidateOrder","description":"This step validates that an order fulfillment can be canceled.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#cancelorderfulfillmentvalidateorder","depth":2},{"type":"step","name":"cancelOrderFulfillmentStep","description":"This step cancels an order's fulfillment.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#cancelorderfulfillmentstep","depth":3},{"type":"step","name":"adjustInventoryLevelsStep","description":"This step adjusts one or more inventory levels.","link":"../../core_flows/core_flows.Steps_Inventory/page.mdx#adjustinventorylevelsstep","depth":3},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":3},{"type":"workflow","name":"cancelFulfillmentWorkflow","description":"This workflow cancels a fulfillment.","link":"../../core_flows/core_flows.Workflows_Fulfillment/page.mdx#cancelfulfillmentworkflow","depth":4},{"type":"hook","name":"orderFulfillmentCanceled","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#orderFulfillmentCanceled","depth":5}]}} />
|
||||
<undefined workflow={{"name":"cancelOrderFulfillmentWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"cancelOrderFulfillmentValidateOrder","description":"This step validates that an order fulfillment can be canceled.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#cancelorderfulfillmentvalidateorder","depth":2},{"type":"step","name":"cancelOrderFulfillmentStep","description":"This step cancels an order's fulfillment.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#cancelorderfulfillmentstep","depth":3},{"type":"step","name":"adjustInventoryLevelsStep","description":"This step adjusts one or more inventory levels.","link":"../../core_flows/core_flows.Steps_Inventory/page.mdx#adjustinventorylevelsstep","depth":3},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":3},{"type":"workflow","name":"cancelFulfillmentWorkflow","description":"This workflow cancels a fulfillment.","link":"../../core_flows/core_flows.Workflows_Fulfillment/page.mdx#cancelfulfillmentworkflow","depth":4},{"type":"hook","name":"orderFulfillmentCanceled","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#orderFulfillmentCanceled","depth":5}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6089,7 +6089,7 @@ This workflow cancels an order.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"cancelOrderWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"cancelValidateOrder","description":"This step validates that an order can be canceled.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#cancelvalidateorder","depth":2},{"type":"step","name":"deleteReservationsByLineItemsStep","description":"This step deletes reservations by their associated line items.","link":"../../core_flows/core_flows.Steps_Reservation/page.mdx#deletereservationsbylineitemsstep","depth":3},{"type":"step","name":"cancelPaymentStep","description":"This step cancels one or more payments.","link":"../../core_flows/core_flows.Steps_Payment/page.mdx#cancelpaymentstep","depth":3},{"type":"step","name":"cancelOrdersStep","description":"This step cancels one or more orders.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#cancelordersstep","depth":3},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":3},{"type":"hook","name":"orderCanceled","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#orderCanceled","depth":4}]}} />
|
||||
<undefined workflow={{"name":"cancelOrderWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"cancelValidateOrder","description":"This step validates that an order can be canceled.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#cancelvalidateorder","depth":2},{"type":"step","name":"deleteReservationsByLineItemsStep","description":"This step deletes reservations by their associated line items.","link":"../../core_flows/core_flows.Steps_Reservation/page.mdx#deletereservationsbylineitemsstep","depth":3},{"type":"step","name":"cancelPaymentStep","description":"This step cancels one or more payments.","link":"../../core_flows/core_flows.Steps_Payment/page.mdx#cancelpaymentstep","depth":3},{"type":"step","name":"cancelOrdersStep","description":"This step cancels one or more orders.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#cancelordersstep","depth":3},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":3},{"type":"hook","name":"orderCanceled","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#orderCanceled","depth":4}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6135,7 +6135,7 @@ This workflow creates an order claim in requested state.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"beginClaimOrderWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"beginClaimOrderValidationStep","description":"This step validates that the order associated with the claim isn't canceled.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#beginclaimordervalidationstep","depth":2},{"type":"step","name":"createOrderClaimsStep","description":"This step creates one or more order claims.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createorderclaimsstep","depth":3},{"type":"step","name":"createOrderChangeStep","description":"This step creates an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createorderchangestep","depth":4}]}} />
|
||||
<undefined workflow={{"name":"beginClaimOrderWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"beginClaimOrderValidationStep","description":"This step validates that the order associated with the claim isn't canceled.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#beginclaimordervalidationstep","depth":2},{"type":"step","name":"createOrderClaimsStep","description":"This step creates one or more order claims.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createorderclaimsstep","depth":3},{"type":"step","name":"createOrderChangeStep","description":"This step creates an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createorderchangestep","depth":4}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6160,7 +6160,7 @@ This workflow cancels a requested order claim.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"cancelBeginOrderClaimWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"cancelBeginOrderClaimValidationStep","description":"This step validates that the requested claim can be canceled by checking that it's not canceled,\nits order isn't canceled, and it hasn't been confirmed.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#cancelbeginorderclaimvalidationstep","depth":4},{"type":"step","name":"deleteReturnsStep","description":"This step deletes one or more returns.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deletereturnsstep","depth":5},{"type":"step","name":"deleteClaimsStep","description":"This step deletes one or more order claims.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteclaimsstep","depth":5},{"type":"step","name":"deleteOrderChangesStep","description":"This step deletes order changes.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangesstep","depth":5},{"type":"step","name":"deleteOrderShippingMethods","description":"This step deletes order shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteordershippingmethods","depth":5}]}} />
|
||||
<undefined workflow={{"name":"cancelBeginOrderClaimWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"cancelBeginOrderClaimValidationStep","description":"This step validates that the requested claim can be canceled by checking that it's not canceled,\nits order isn't canceled, and it hasn't been confirmed.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#cancelbeginorderclaimvalidationstep","depth":4},{"type":"step","name":"deleteReturnsStep","description":"This step deletes one or more returns.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deletereturnsstep","depth":5},{"type":"step","name":"deleteClaimsStep","description":"This step deletes one or more order claims.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteclaimsstep","depth":5},{"type":"step","name":"deleteOrderChangesStep","description":"This step deletes order changes.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangesstep","depth":5},{"type":"step","name":"deleteOrderShippingMethods","description":"This step deletes order shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteordershippingmethods","depth":5}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6180,7 +6180,7 @@ This workflow cancels a confirmed order claim.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"cancelOrderClaimWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"cancelClaimValidateOrderStep","description":"This step validates that a confirmed claim can be canceled.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#cancelclaimvalidateorderstep","depth":2},{"type":"step","name":"cancelOrderClaimStep","description":"This step cancels a claim.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#cancelorderclaimstep","depth":3},{"type":"step","name":"deleteReservationsByLineItemsStep","description":"This step deletes reservations by their associated line items.","link":"../../core_flows/core_flows.Steps_Reservation/page.mdx#deletereservationsbylineitemsstep","depth":3},{"type":"when","condition":"{\n return !!orderClaim.return_id\n }","depth":"4","steps":[{"type":"workflow","name":"cancelReturnWorkflow","description":"This workflow cancels a return.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#cancelreturnworkflow","depth":4}]}]}} />
|
||||
<undefined workflow={{"name":"cancelOrderClaimWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"cancelClaimValidateOrderStep","description":"This step validates that a confirmed claim can be canceled.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#cancelclaimvalidateorderstep","depth":2},{"type":"step","name":"cancelOrderClaimStep","description":"This step cancels a claim.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#cancelorderclaimstep","depth":3},{"type":"step","name":"deleteReservationsByLineItemsStep","description":"This step deletes reservations by their associated line items.","link":"../../core_flows/core_flows.Steps_Reservation/page.mdx#deletereservationsbylineitemsstep","depth":3},{"type":"when","condition":"{\n return !!orderClaim.return_id\n }","depth":"4","steps":[{"type":"workflow","name":"cancelReturnWorkflow","description":"This workflow cancels a return.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#cancelreturnworkflow","depth":4}]}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6200,7 +6200,7 @@ This workflow adds a new item to a claim.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"orderClaimAddNewItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"orderClaimAddNewItemValidationStep","description":"This step validates that a new item can be added to the claim.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#orderclaimaddnewitemvalidationstep","depth":4},{"type":"workflow","name":"addOrderLineItemsWorkflow","description":"This workflow adds line items to an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#addorderlineitemsworkflow","depth":5},{"type":"workflow","name":"updateOrderTaxLinesWorkflow","description":"This workflow updates the tax lines of items and shipping methods in an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateordertaxlinesworkflow","depth":6},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":7},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":8}]}} />
|
||||
<undefined workflow={{"name":"orderClaimAddNewItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"orderClaimAddNewItemValidationStep","description":"This step validates that a new item can be added to the claim.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#orderclaimaddnewitemvalidationstep","depth":4},{"type":"workflow","name":"addOrderLineItemsWorkflow","description":"This workflow adds line items to an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#addorderlineitemsworkflow","depth":5},{"type":"workflow","name":"updateOrderTaxLinesWorkflow","description":"This workflow updates the tax lines of items and shipping methods in an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateordertaxlinesworkflow","depth":6},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":7},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":8}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6224,7 +6224,7 @@ This workflow adds claim items to a claim.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"orderClaimItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"orderClaimItemValidationStep","description":"This step validates that claim items can be added to a claim.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#orderclaimitemvalidationstep","depth":4},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
<undefined workflow={{"name":"orderClaimItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"orderClaimItemValidationStep","description":"This step validates that claim items can be added to a claim.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#orderclaimitemvalidationstep","depth":4},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6248,7 +6248,7 @@ This workflow requests one or more items to be returned as part of a claim.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"orderClaimRequestItemReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"when","condition":"{\n return orderClaim.return_id\n }","depth":"2","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2}]},{"type":"when","condition":"{\n return !orderClaim.return_id\n }","depth":"3","steps":[{"type":"step","name":"createReturnsStep","description":"This step creates returns.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createreturnsstep","depth":3}]},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":4},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":5},{"type":"when","condition":"{\n return !!createdReturn?.length\n }","depth":"6","steps":[{"type":"step","name":"updateOrderChangesStep","description":"This step updates order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangesstep","depth":6}]},{"type":"step","name":"orderClaimRequestItemReturnValidationStep","description":"This step validates that items can be requested to return as part of a claim.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#orderclaimrequestitemreturnvalidationstep","depth":7},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":9},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":10}]}} />
|
||||
<undefined workflow={{"name":"orderClaimRequestItemReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"when","condition":"{\n return orderClaim.return_id\n }","depth":"2","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2}]},{"type":"when","condition":"{\n return !orderClaim.return_id\n }","depth":"3","steps":[{"type":"step","name":"createReturnsStep","description":"This step creates returns.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createreturnsstep","depth":3}]},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":4},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":5},{"type":"when","condition":"{\n return !!createdReturn?.length\n }","depth":"6","steps":[{"type":"step","name":"updateOrderChangesStep","description":"This step updates order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangesstep","depth":6}]},{"type":"step","name":"orderClaimRequestItemReturnValidationStep","description":"This step validates that items can be requested to return as part of a claim.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#orderclaimrequestitemreturnvalidationstep","depth":7},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":9},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":10}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6272,7 +6272,7 @@ This workflow confirms a requested claim.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"confirmClaimRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"confirmClaimRequestValidationStep","description":"This step validates that a requested claim can be confirmed.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#confirmclaimrequestvalidationstep","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":5},{"type":"step","name":"createOrderClaimItemsFromActionsStep","description":"This step creates claim items from a change action.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createorderclaimitemsfromactionsstep","depth":6},{"type":"when","condition":"{\n return !!returnId\n }","depth":"7","steps":[{"type":"step","name":"updateReturnsStep","description":"This step updates one or more returns.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updatereturnsstep","depth":7}]},{"type":"when","condition":"{\n return !!claimShippingMethod\n }","depth":"8","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":8},{"type":"step","name":"reserveInventoryStep","description":"This step reserves the quantity of line items from the associated\nvariant's inventory.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#reserveinventorystep","depth":8}]},{"type":"when","condition":"{\n return !!returnShippingMethod && !!returnId\n }","depth":"9","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":9},{"type":"workflow","name":"createReturnFulfillmentWorkflow","description":"This workflow creates a fulfillment for a return.","link":"../../core_flows/core_flows.Workflows_Fulfillment/page.mdx#createreturnfulfillmentworkflow","depth":9},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#create-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#createremotelinkstep","depth":9}]},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":10}]}} />
|
||||
<undefined workflow={{"name":"confirmClaimRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"confirmClaimRequestValidationStep","description":"This step validates that a requested claim can be confirmed.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#confirmclaimrequestvalidationstep","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":5},{"type":"step","name":"createOrderClaimItemsFromActionsStep","description":"This step creates claim items from a change action.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createorderclaimitemsfromactionsstep","depth":6},{"type":"when","condition":"{\n return !!returnId\n }","depth":"7","steps":[{"type":"step","name":"updateReturnsStep","description":"This step updates one or more returns.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updatereturnsstep","depth":7}]},{"type":"when","condition":"{\n return !!claimShippingMethod\n }","depth":"8","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":8},{"type":"step","name":"reserveInventoryStep","description":"This step reserves the quantity of line items from the associated\nvariant's inventory.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#reserveinventorystep","depth":8}]},{"type":"when","condition":"{\n return !!returnShippingMethod && !!returnId\n }","depth":"9","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":9},{"type":"workflow","name":"createReturnFulfillmentWorkflow","description":"This workflow creates a fulfillment for a return.","link":"../../core_flows/core_flows.Workflows_Fulfillment/page.mdx#createreturnfulfillmentworkflow","depth":9},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/advanced-development/modules/remote-link#create-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#createremotelinkstep","depth":9}]},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":10}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6296,7 +6296,7 @@ This workflow creates a shipping method for a claim.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"createClaimShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":4},{"type":"step","name":"createClaimShippingMethodValidationStep","description":"This step confirms that a shipping method can be created for a claim.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createclaimshippingmethodvalidationstep","depth":5},{"type":"workflow","name":"updateOrderTaxLinesWorkflow","description":"This workflow updates the tax lines of items and shipping methods in an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateordertaxlinesworkflow","depth":6},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":7},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":8}]}} />
|
||||
<undefined workflow={{"name":"createClaimShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":4},{"type":"step","name":"createClaimShippingMethodValidationStep","description":"This step confirms that a shipping method can be created for a claim.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createclaimshippingmethodvalidationstep","depth":5},{"type":"workflow","name":"updateOrderTaxLinesWorkflow","description":"This workflow updates the tax lines of items and shipping methods in an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateordertaxlinesworkflow","depth":6},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":7},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":8}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6320,7 +6320,7 @@ This workflow removes new items from a claim.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"removeAddItemClaimActionWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"removeClaimAddItemActionValidationStep","description":"This step validates that new items can be removed from a claim.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#removeclaimadditemactionvalidationstep","depth":4},{"type":"step","name":"deleteOrderChangeActionsStep","description":"This step deletes order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangeactionsstep","depth":5},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":6},{"type":"when","condition":"{\n return !!actionIdToDelete\n }","depth":"7","steps":[{"type":"workflow","name":"removeClaimShippingMethodWorkflow","description":"This workflow removes the shipping method of a claim.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#removeclaimshippingmethodworkflow","depth":7}]},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":8}]}} />
|
||||
<undefined workflow={{"name":"removeAddItemClaimActionWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"removeClaimAddItemActionValidationStep","description":"This step validates that new items can be removed from a claim.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#removeclaimadditemactionvalidationstep","depth":4},{"type":"step","name":"deleteOrderChangeActionsStep","description":"This step deletes order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangeactionsstep","depth":5},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":6},{"type":"when","condition":"{\n return !!actionIdToDelete\n }","depth":"7","steps":[{"type":"workflow","name":"removeClaimShippingMethodWorkflow","description":"This workflow removes the shipping method of a claim.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#removeclaimshippingmethodworkflow","depth":7}]},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":8}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6344,7 +6344,7 @@ This workflow removes claim items.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"removeItemClaimActionWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"removeClaimItemActionValidationStep","description":"This step confirms that a claim's items can be removed.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#removeclaimitemactionvalidationstep","depth":4},{"type":"step","name":"deleteOrderChangeActionsStep","description":"This step deletes order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangeactionsstep","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
<undefined workflow={{"name":"removeItemClaimActionWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"removeClaimItemActionValidationStep","description":"This step confirms that a claim's items can be removed.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#removeclaimitemactionvalidationstep","depth":4},{"type":"step","name":"deleteOrderChangeActionsStep","description":"This step deletes order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangeactionsstep","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6368,7 +6368,7 @@ This workflow removes the shipping method of a claim.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"removeClaimShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"removeClaimShippingMethodValidationStep","description":"This step validates that a claim's shipping method can be removed.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#removeclaimshippingmethodvalidationstep","depth":3},{"type":"step","name":"deleteOrderChangeActionsStep","description":"This step deletes order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangeactionsstep","depth":4},{"type":"step","name":"deleteOrderShippingMethods","description":"This step deletes order shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteordershippingmethods","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":5}]}} />
|
||||
<undefined workflow={{"name":"removeClaimShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"removeClaimShippingMethodValidationStep","description":"This step validates that a claim's shipping method can be removed.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#removeclaimshippingmethodvalidationstep","depth":3},{"type":"step","name":"deleteOrderChangeActionsStep","description":"This step deletes order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangeactionsstep","depth":4},{"type":"step","name":"deleteOrderShippingMethods","description":"This step deletes order shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteordershippingmethods","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":5}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6392,7 +6392,7 @@ This workflow updates a claim's new item.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"updateClaimAddItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"updateClaimAddItemValidationStep","description":"This step validates that a claim's new item can be updated.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateclaimadditemvalidationstep","depth":4},{"type":"step","name":"updateOrderChangeActionsStep","description":"This step updates order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangeactionsstep","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
<undefined workflow={{"name":"updateClaimAddItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"updateClaimAddItemValidationStep","description":"This step validates that a claim's new item can be updated.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateclaimadditemvalidationstep","depth":4},{"type":"step","name":"updateOrderChangeActionsStep","description":"This step updates order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangeactionsstep","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6416,7 +6416,7 @@ This workflow updates a claim item.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"updateClaimItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"updateClaimItemValidationStep","description":"This step validates that a claim's item can be updated.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateclaimitemvalidationstep","depth":4},{"type":"step","name":"updateOrderChangeActionsStep","description":"This step updates order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangeactionsstep","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
<undefined workflow={{"name":"updateClaimItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"updateClaimItemValidationStep","description":"This step validates that a claim's item can be updated.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateclaimitemvalidationstep","depth":4},{"type":"step","name":"updateOrderChangeActionsStep","description":"This step updates order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangeactionsstep","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6440,7 +6440,7 @@ This workflow updates a claim's shipping method.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"updateClaimShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"when","condition":"{\n return input.data?.custom_amount === null\n }","depth":"3","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3}]},{"type":"step","name":"updateClaimShippingMethodValidationStep","description":"This step validates that a claim's shipping method can be updated.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateclaimshippingmethodvalidationstep","depth":4},{"type":"step","name":"updateOrderChangeActionsStep","description":"This step updates order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangeactionsstep","depth":5},{"type":"step","name":"updateOrderShippingMethodsStep","description":"This step updates order shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateordershippingmethodsstep","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
<undefined workflow={{"name":"updateClaimShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"when","condition":"{\n return input.data?.custom_amount === null\n }","depth":"3","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3}]},{"type":"step","name":"updateClaimShippingMethodValidationStep","description":"This step validates that a claim's shipping method can be updated.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateclaimshippingmethodvalidationstep","depth":4},{"type":"step","name":"updateOrderChangeActionsStep","description":"This step updates order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangeactionsstep","depth":5},{"type":"step","name":"updateOrderShippingMethodsStep","description":"This step updates order shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateordershippingmethodsstep","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6502,7 +6502,7 @@ This creates a fulfillment for an order.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"createOrderFulfillmentWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"createFulfillmentValidateOrder","description":"This step validates that a fulfillment can be created for an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createfulfillmentvalidateorder","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":4},{"type":"workflow","name":"createFulfillmentWorkflow","description":"This workflow creates a fulfillment.","link":"../../core_flows/core_flows.Workflows_Fulfillment/page.mdx#createfulfillmentworkflow","depth":5},{"type":"step","name":"adjustInventoryLevelsStep","description":"This step adjusts one or more inventory levels.","link":"../../core_flows/core_flows.Steps_Inventory/page.mdx#adjustinventorylevelsstep","depth":6},{"type":"step","name":"registerOrderFulfillmentStep","description":"This step registers a fulfillment for an order.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#registerorderfulfillmentstep","depth":7},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#create-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#createremotelinkstep","depth":7},{"type":"step","name":"updateReservationsStep","description":"This step updates one or more reservations.","link":"../../core_flows/core_flows.Steps_Reservation/page.mdx#updatereservationsstep","depth":7},{"type":"step","name":"deleteReservationsStep","description":"This step deletes one or more reservations.","link":"../../core_flows/core_flows.Steps_Reservation/page.mdx#deletereservationsstep","depth":7},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":7},{"type":"hook","name":"fulfillmentCreated","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#fulfillmentCreated","depth":8}]}} />
|
||||
<undefined workflow={{"name":"createOrderFulfillmentWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"createFulfillmentValidateOrder","description":"This step validates that a fulfillment can be created for an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createfulfillmentvalidateorder","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":4},{"type":"workflow","name":"createFulfillmentWorkflow","description":"This workflow creates a fulfillment.","link":"../../core_flows/core_flows.Workflows_Fulfillment/page.mdx#createfulfillmentworkflow","depth":5},{"type":"step","name":"adjustInventoryLevelsStep","description":"This step adjusts one or more inventory levels.","link":"../../core_flows/core_flows.Steps_Inventory/page.mdx#adjustinventorylevelsstep","depth":6},{"type":"step","name":"registerOrderFulfillmentStep","description":"This step registers a fulfillment for an order.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#registerorderfulfillmentstep","depth":7},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/advanced-development/modules/remote-link#create-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#createremotelinkstep","depth":7},{"type":"step","name":"updateReservationsStep","description":"This step updates one or more reservations.","link":"../../core_flows/core_flows.Steps_Reservation/page.mdx#updatereservationsstep","depth":7},{"type":"step","name":"deleteReservationsStep","description":"This step deletes one or more reservations.","link":"../../core_flows/core_flows.Steps_Reservation/page.mdx#deletereservationsstep","depth":7},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":7},{"type":"hook","name":"fulfillmentCreated","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#fulfillmentCreated","depth":8}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6568,7 +6568,7 @@ This workflow creates a payment collection for an order.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"createOrderPaymentCollectionWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"createPaymentCollectionsStep","description":"This step creates payment collections in a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#createpaymentcollectionsstep","depth":2},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#create-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#createremotelinkstep","depth":3}]}} />
|
||||
<undefined workflow={{"name":"createOrderPaymentCollectionWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"createPaymentCollectionsStep","description":"This step creates payment collections in a cart.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#createpaymentcollectionsstep","depth":2},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/advanced-development/modules/remote-link#create-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#createremotelinkstep","depth":3}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6584,7 +6584,7 @@ This workflow creates an order.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"createOrdersWorkflow","steps":[{"type":"step","name":"findSalesChannelStep","description":"This step either retrieves a sales channel either using the ID provided as an input, or, if no ID\nis provided, the default sales channel of the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findsaleschannelstep","depth":1},{"type":"step","name":"findOneOrAnyRegionStep","description":"This step retrieves a region either by the provided ID or the first region in the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findoneoranyregionstep","depth":1},{"type":"step","name":"findOrCreateCustomerStep","description":"This step either finds a customer matching the specified ID, or finds / create a customer\nmatching the specified email. If both ID and email are provided, ID takes precedence.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findorcreatecustomerstep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#validatevariantpricesstep","depth":3},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#confirmvariantinventoryworkflow","depth":4},{"type":"step","name":"getVariantPriceSetsStep","description":"This step retrieves the calculated price sets of the specified variants.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#getvariantpricesetsstep","depth":5},{"type":"step","name":"createOrdersStep","description":"This step creates one or more orders.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createordersstep","depth":6},{"type":"workflow","name":"updateOrderTaxLinesWorkflow","description":"This workflow updates the tax lines of items and shipping methods in an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateordertaxlinesworkflow","depth":7},{"type":"hook","name":"orderCreated","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#orderCreated","depth":8}]}} />
|
||||
<undefined workflow={{"name":"createOrdersWorkflow","steps":[{"type":"step","name":"findSalesChannelStep","description":"This step either retrieves a sales channel either using the ID provided as an input, or, if no ID\nis provided, the default sales channel of the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findsaleschannelstep","depth":1},{"type":"step","name":"findOneOrAnyRegionStep","description":"This step retrieves a region either by the provided ID or the first region in the first store.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findoneoranyregionstep","depth":1},{"type":"step","name":"findOrCreateCustomerStep","description":"This step either finds a customer matching the specified ID, or finds / create a customer\nmatching the specified email. If both ID and email are provided, ID takes precedence.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#findorcreatecustomerstep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"validateVariantPricesStep","description":"This step validates the specified variant objects to ensure they have prices.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#validatevariantpricesstep","depth":3},{"type":"workflow","name":"confirmVariantInventoryWorkflow","description":"This workflow confirms for one or more variants that their inventory has a required quantity.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#confirmvariantinventoryworkflow","depth":4},{"type":"step","name":"getVariantPriceSetsStep","description":"This step retrieves the calculated price sets of the specified variants.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#getvariantpricesetsstep","depth":5},{"type":"step","name":"createOrdersStep","description":"This step creates one or more orders.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createordersstep","depth":6},{"type":"workflow","name":"updateOrderTaxLinesWorkflow","description":"This workflow updates the tax lines of items and shipping methods in an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateordertaxlinesworkflow","depth":7},{"type":"hook","name":"orderCreated","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#orderCreated","depth":8}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6630,7 +6630,7 @@ This workflow creates a shipment for an order.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"createOrderShipmentWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"createShipmentValidateOrder","description":"This step validates that a shipment can be created for an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createshipmentvalidateorder","depth":2},{"type":"workflow","name":"createShipmentWorkflow","description":"This workflow creates shipments for a fulfillment.","link":"../../core_flows/core_flows.Workflows_Fulfillment/page.mdx#createshipmentworkflow","depth":3},{"type":"step","name":"registerOrderShipmentStep","description":"This step registers a shipment for an order.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#registerordershipmentstep","depth":3},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":4},{"type":"hook","name":"shipmentCreated","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#shipmentCreated","depth":5}]}} />
|
||||
<undefined workflow={{"name":"createOrderShipmentWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"createShipmentValidateOrder","description":"This step validates that a shipment can be created for an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createshipmentvalidateorder","depth":2},{"type":"workflow","name":"createShipmentWorkflow","description":"This workflow creates shipments for a fulfillment.","link":"../../core_flows/core_flows.Workflows_Fulfillment/page.mdx#createshipmentworkflow","depth":3},{"type":"step","name":"registerOrderShipmentStep","description":"This step registers a shipment for an order.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#registerordershipmentstep","depth":3},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":4},{"type":"hook","name":"shipmentCreated","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#shipmentCreated","depth":5}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6712,7 +6712,7 @@ This workflow deletes one or more invites.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"deleteOrderPaymentCollections","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"throwUnlessStatusIsNotPaid","description":"This step validates that the order doesn't have an active payment collection.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#throwunlessstatusisnotpaid","depth":2},{"type":"step","name":"removeRemoteLinkStep","description":"This step deletes linked records of a record.\n\nLearn more in the [Remote Link documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#removeremotelinkstep","depth":3}]}} />
|
||||
<undefined workflow={{"name":"deleteOrderPaymentCollections","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"throwUnlessStatusIsNotPaid","description":"This step validates that the order doesn't have an active payment collection.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#throwunlessstatusisnotpaid","depth":2},{"type":"step","name":"removeRemoteLinkStep","description":"This step deletes linked records of a record.\n\nLearn more in the [Remote Link documentation](https://docs.medusajs.com/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#removeremotelinkstep","depth":3}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6732,7 +6732,7 @@ This workflow requests an order exchange.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"beginExchangeOrderWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"beginOrderExchangeValidationStep","description":"This step validates that an exchange can be requested for an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#beginorderexchangevalidationstep","depth":2},{"type":"step","name":"createOrderExchangesStep","description":"This step creates one or more order exchanges.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createorderexchangesstep","depth":3},{"type":"step","name":"createOrderChangeStep","description":"This step creates an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createorderchangestep","depth":4}]}} />
|
||||
<undefined workflow={{"name":"beginExchangeOrderWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"beginOrderExchangeValidationStep","description":"This step validates that an exchange can be requested for an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#beginorderexchangevalidationstep","depth":2},{"type":"step","name":"createOrderExchangesStep","description":"This step creates one or more order exchanges.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createorderexchangesstep","depth":3},{"type":"step","name":"createOrderChangeStep","description":"This step creates an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createorderchangestep","depth":4}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6756,7 +6756,7 @@ This workflow cancels a requested order exchange.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"cancelBeginOrderExchangeWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"cancelBeginOrderExchangeValidationStep","description":"This step validates that a requested exchange can be canceled.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#cancelbeginorderexchangevalidationstep","depth":4},{"type":"step","name":"deleteReturnsStep","description":"This step deletes one or more returns.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deletereturnsstep","depth":5},{"type":"step","name":"deleteExchangesStep","description":"This step deletes one or more exchanges.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteexchangesstep","depth":5},{"type":"step","name":"deleteOrderChangesStep","description":"This step deletes order changes.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangesstep","depth":5},{"type":"step","name":"deleteOrderShippingMethods","description":"This step deletes order shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteordershippingmethods","depth":5}]}} />
|
||||
<undefined workflow={{"name":"cancelBeginOrderExchangeWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"cancelBeginOrderExchangeValidationStep","description":"This step validates that a requested exchange can be canceled.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#cancelbeginorderexchangevalidationstep","depth":4},{"type":"step","name":"deleteReturnsStep","description":"This step deletes one or more returns.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deletereturnsstep","depth":5},{"type":"step","name":"deleteExchangesStep","description":"This step deletes one or more exchanges.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteexchangesstep","depth":5},{"type":"step","name":"deleteOrderChangesStep","description":"This step deletes order changes.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangesstep","depth":5},{"type":"step","name":"deleteOrderShippingMethods","description":"This step deletes order shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteordershippingmethods","depth":5}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6776,7 +6776,7 @@ This workflow cancels a confirmed exchange.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"cancelOrderExchangeWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"cancelExchangeValidateOrder","description":"This step validates that an exchange can be canceled.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#cancelexchangevalidateorder","depth":2},{"type":"step","name":"cancelOrderExchangeStep","description":"This step cancels an exchange.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#cancelorderexchangestep","depth":3},{"type":"step","name":"deleteReservationsByLineItemsStep","description":"This step deletes reservations by their associated line items.","link":"../../core_flows/core_flows.Steps_Reservation/page.mdx#deletereservationsbylineitemsstep","depth":3},{"type":"when","condition":"{\n return !!orderExchange.return_id\n }","depth":"4","steps":[{"type":"workflow","name":"cancelReturnWorkflow","description":"This workflow cancels a return.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#cancelreturnworkflow","depth":4}]}]}} />
|
||||
<undefined workflow={{"name":"cancelOrderExchangeWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"cancelExchangeValidateOrder","description":"This step validates that an exchange can be canceled.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#cancelexchangevalidateorder","depth":2},{"type":"step","name":"cancelOrderExchangeStep","description":"This step cancels an exchange.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#cancelorderexchangestep","depth":3},{"type":"step","name":"deleteReservationsByLineItemsStep","description":"This step deletes reservations by their associated line items.","link":"../../core_flows/core_flows.Steps_Reservation/page.mdx#deletereservationsbylineitemsstep","depth":3},{"type":"when","condition":"{\n return !!orderExchange.return_id\n }","depth":"4","steps":[{"type":"workflow","name":"cancelReturnWorkflow","description":"This workflow cancels a return.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#cancelreturnworkflow","depth":4}]}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6796,7 +6796,7 @@ This workflow confirms an exchange request.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"confirmExchangeRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"confirmExchangeRequestValidationStep","description":"This step validates that a requested exchange can be confirmed.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#confirmexchangerequestvalidationstep","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":5},{"type":"step","name":"createOrderExchangeItemsFromActionsStep","description":"This step creates exchange items from change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createorderexchangeitemsfromactionsstep","depth":6},{"type":"when","condition":"{\n return !!returnId\n }","depth":"7","steps":[{"type":"step","name":"updateReturnsStep","description":"This step updates one or more returns.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updatereturnsstep","depth":7}]},{"type":"when","condition":"{\n return !!exchangeShippingMethod\n }","depth":"8","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":8},{"type":"step","name":"reserveInventoryStep","description":"This step reserves the quantity of line items from the associated\nvariant's inventory.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#reserveinventorystep","depth":8}]},{"type":"when","condition":"{\n return !!returnShippingMethod && !!returnId\n }","depth":"9","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":9},{"type":"workflow","name":"createReturnFulfillmentWorkflow","description":"This workflow creates a fulfillment for a return.","link":"../../core_flows/core_flows.Workflows_Fulfillment/page.mdx#createreturnfulfillmentworkflow","depth":9},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#create-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#createremotelinkstep","depth":9}]},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":10}]}} />
|
||||
<undefined workflow={{"name":"confirmExchangeRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"confirmExchangeRequestValidationStep","description":"This step validates that a requested exchange can be confirmed.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#confirmexchangerequestvalidationstep","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":5},{"type":"step","name":"createOrderExchangeItemsFromActionsStep","description":"This step creates exchange items from change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createorderexchangeitemsfromactionsstep","depth":6},{"type":"when","condition":"{\n return !!returnId\n }","depth":"7","steps":[{"type":"step","name":"updateReturnsStep","description":"This step updates one or more returns.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updatereturnsstep","depth":7}]},{"type":"when","condition":"{\n return !!exchangeShippingMethod\n }","depth":"8","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":8},{"type":"step","name":"reserveInventoryStep","description":"This step reserves the quantity of line items from the associated\nvariant's inventory.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#reserveinventorystep","depth":8}]},{"type":"when","condition":"{\n return !!returnShippingMethod && !!returnId\n }","depth":"9","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":9},{"type":"workflow","name":"createReturnFulfillmentWorkflow","description":"This workflow creates a fulfillment for a return.","link":"../../core_flows/core_flows.Workflows_Fulfillment/page.mdx#createreturnfulfillmentworkflow","depth":9},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/advanced-development/modules/remote-link#create-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#createremotelinkstep","depth":9}]},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":10}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6820,7 +6820,7 @@ This workflow creates a shipping method for an exchange.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"createExchangeShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":4},{"type":"step","name":"createExchangeShippingMethodValidationStep","description":"This step validates that a shipping method can be created for an exchange.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createexchangeshippingmethodvalidationstep","depth":5},{"type":"workflow","name":"updateOrderTaxLinesWorkflow","description":"This workflow updates the tax lines of items and shipping methods in an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateordertaxlinesworkflow","depth":6},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":7},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":8}]}} />
|
||||
<undefined workflow={{"name":"createExchangeShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":4},{"type":"step","name":"createExchangeShippingMethodValidationStep","description":"This step validates that a shipping method can be created for an exchange.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createexchangeshippingmethodvalidationstep","depth":5},{"type":"workflow","name":"updateOrderTaxLinesWorkflow","description":"This workflow updates the tax lines of items and shipping methods in an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateordertaxlinesworkflow","depth":6},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":7},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":8}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6844,7 +6844,7 @@ This workflow adds new items to an exchange.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"orderExchangeAddNewItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"exchangeAddNewItemValidationStep","description":"This step validates that new items can be added to an exchange.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#exchangeaddnewitemvalidationstep","depth":4},{"type":"workflow","name":"addOrderLineItemsWorkflow","description":"This workflow adds line items to an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#addorderlineitemsworkflow","depth":5},{"type":"workflow","name":"updateOrderTaxLinesWorkflow","description":"This workflow updates the tax lines of items and shipping methods in an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateordertaxlinesworkflow","depth":6},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":7},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":8}]}} />
|
||||
<undefined workflow={{"name":"orderExchangeAddNewItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"exchangeAddNewItemValidationStep","description":"This step validates that new items can be added to an exchange.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#exchangeaddnewitemvalidationstep","depth":4},{"type":"workflow","name":"addOrderLineItemsWorkflow","description":"This workflow adds line items to an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#addorderlineitemsworkflow","depth":5},{"type":"workflow","name":"updateOrderTaxLinesWorkflow","description":"This workflow updates the tax lines of items and shipping methods in an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateordertaxlinesworkflow","depth":6},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":7},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":8}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6868,7 +6868,7 @@ This workflow adds items to be retuned as part of the exchange.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"orderExchangeRequestItemReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"when","condition":"{\n return orderExchange.return_id\n }","depth":"2","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2}]},{"type":"when","condition":"{\n return !orderExchange.return_id\n }","depth":"3","steps":[{"type":"step","name":"createReturnsStep","description":"This step creates returns.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createreturnsstep","depth":3}]},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":4},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":5},{"type":"when","condition":"{\n return !!createdReturn?.length\n }","depth":"6","steps":[{"type":"step","name":"updateOrderChangesStep","description":"This step updates order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangesstep","depth":6}]},{"type":"step","name":"exchangeRequestItemReturnValidationStep","description":"This step validates that items can be returned as part of an exchange.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#exchangerequestitemreturnvalidationstep","depth":7},{"type":"when","condition":"{\n return !orderExchange.return_id\n }","depth":"8","steps":[{"type":"step","name":"updateOrderExchangesStep","description":"This step update order changes.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderexchangesstep","depth":8}]},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":9},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":10}]}} />
|
||||
<undefined workflow={{"name":"orderExchangeRequestItemReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"when","condition":"{\n return orderExchange.return_id\n }","depth":"2","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2}]},{"type":"when","condition":"{\n return !orderExchange.return_id\n }","depth":"3","steps":[{"type":"step","name":"createReturnsStep","description":"This step creates returns.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createreturnsstep","depth":3}]},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":4},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":5},{"type":"when","condition":"{\n return !!createdReturn?.length\n }","depth":"6","steps":[{"type":"step","name":"updateOrderChangesStep","description":"This step updates order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangesstep","depth":6}]},{"type":"step","name":"exchangeRequestItemReturnValidationStep","description":"This step validates that items can be returned as part of an exchange.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#exchangerequestitemreturnvalidationstep","depth":7},{"type":"when","condition":"{\n return !orderExchange.return_id\n }","depth":"8","steps":[{"type":"step","name":"updateOrderExchangesStep","description":"This step update order changes.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderexchangesstep","depth":8}]},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":9},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":10}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6892,7 +6892,7 @@ This workflow removes a new item in an exchange.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"removeItemExchangeActionWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"removeExchangeItemActionValidationStep","description":"This step validates that a new item can be removed from an exchange.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#removeexchangeitemactionvalidationstep","depth":4},{"type":"step","name":"deleteOrderChangeActionsStep","description":"This step deletes order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangeactionsstep","depth":5},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":6},{"type":"when","condition":"{\n return !!actionIdToDelete\n }","depth":"7","steps":[{"type":"workflow","name":"removeExchangeShippingMethodWorkflow","description":"This workflow removes a shipping method of an exchange.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#removeexchangeshippingmethodworkflow","depth":7}]},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":8}]}} />
|
||||
<undefined workflow={{"name":"removeItemExchangeActionWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"removeExchangeItemActionValidationStep","description":"This step validates that a new item can be removed from an exchange.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#removeexchangeitemactionvalidationstep","depth":4},{"type":"step","name":"deleteOrderChangeActionsStep","description":"This step deletes order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangeactionsstep","depth":5},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":6},{"type":"when","condition":"{\n return !!actionIdToDelete\n }","depth":"7","steps":[{"type":"workflow","name":"removeExchangeShippingMethodWorkflow","description":"This workflow removes a shipping method of an exchange.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#removeexchangeshippingmethodworkflow","depth":7}]},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":8}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6916,7 +6916,7 @@ This workflow removes a shipping method of an exchange.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"removeExchangeShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"removeExchangeShippingMethodValidationStep","description":"This step validates that a shipping method can be removed from an exchange.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#removeexchangeshippingmethodvalidationstep","depth":3},{"type":"step","name":"deleteOrderChangeActionsStep","description":"This step deletes order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangeactionsstep","depth":4},{"type":"step","name":"deleteOrderShippingMethods","description":"This step deletes order shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteordershippingmethods","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":5}]}} />
|
||||
<undefined workflow={{"name":"removeExchangeShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"removeExchangeShippingMethodValidationStep","description":"This step validates that a shipping method can be removed from an exchange.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#removeexchangeshippingmethodvalidationstep","depth":3},{"type":"step","name":"deleteOrderChangeActionsStep","description":"This step deletes order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangeactionsstep","depth":4},{"type":"step","name":"deleteOrderShippingMethods","description":"This step deletes order shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteordershippingmethods","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":5}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6940,7 +6940,7 @@ This workflow updates a new item in the exchange.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"updateExchangeAddItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"updateExchangeAddItemValidationStep","description":"This step validates that a new item can be removed from an exchange.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateexchangeadditemvalidationstep","depth":4},{"type":"step","name":"updateOrderChangeActionsStep","description":"This step updates order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangeactionsstep","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
<undefined workflow={{"name":"updateExchangeAddItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"updateExchangeAddItemValidationStep","description":"This step validates that a new item can be removed from an exchange.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateexchangeadditemvalidationstep","depth":4},{"type":"step","name":"updateOrderChangeActionsStep","description":"This step updates order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangeactionsstep","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6964,7 +6964,7 @@ This workflow updates an exchange's shipping method.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"updateExchangeShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"when","condition":"{\n return input.data?.custom_amount === null\n }","depth":"3","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3}]},{"type":"step","name":"updateExchangeShippingMethodValidationStep","description":"This step validates that an exchange's shipping method can be updated.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateexchangeshippingmethodvalidationstep","depth":4},{"type":"step","name":"updateOrderChangeActionsStep","description":"This step updates order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangeactionsstep","depth":5},{"type":"step","name":"updateOrderShippingMethodsStep","description":"This step updates order shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateordershippingmethodsstep","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
<undefined workflow={{"name":"updateExchangeShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"when","condition":"{\n return input.data?.custom_amount === null\n }","depth":"3","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3}]},{"type":"step","name":"updateExchangeShippingMethodValidationStep","description":"This step validates that an exchange's shipping method can be updated.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateexchangeshippingmethodvalidationstep","depth":4},{"type":"step","name":"updateOrderChangeActionsStep","description":"This step updates order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangeactionsstep","depth":5},{"type":"step","name":"updateOrderShippingMethodsStep","description":"This step updates order shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateordershippingmethodsstep","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6980,7 +6980,7 @@ This workflow retrieves an order's details.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"getOrderDetailWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1}]}} />
|
||||
<undefined workflow={{"name":"getOrderDetailWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -6996,7 +6996,7 @@ This workflow retrieves a list of orders.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"getOrdersListWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1}]}} />
|
||||
<undefined workflow={{"name":"getOrdersListWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7020,7 +7020,7 @@ This workflow marks a fulfillment in an order as delivered.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"markOrderFulfillmentAsDeliveredWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"orderFulfillmentDeliverablilityValidationStep","description":"This step validates that order & fulfillment are valid","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#orderfulfillmentdeliverablilityvalidationstep","depth":3},{"type":"workflow","name":"markFulfillmentAsDeliveredWorkflow","description":"This workflow marks fulfillment as delivered.","link":"../../core_flows/core_flows.Workflows_Fulfillment/page.mdx#markfulfillmentasdeliveredworkflow","depth":4},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":5}]}} />
|
||||
<undefined workflow={{"name":"markOrderFulfillmentAsDeliveredWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"orderFulfillmentDeliverablilityValidationStep","description":"This step validates that order & fulfillment are valid","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#orderfulfillmentdeliverablilityvalidationstep","depth":3},{"type":"workflow","name":"markFulfillmentAsDeliveredWorkflow","description":"This workflow marks fulfillment as delivered.","link":"../../core_flows/core_flows.Workflows_Fulfillment/page.mdx#markfulfillmentasdeliveredworkflow","depth":4},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":5}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7044,7 +7044,7 @@ This workflow marks a payment collection for an order as paid.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"markPaymentCollectionAsPaid","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"throwUnlessPaymentCollectionNotPaid","description":"This step validates that the payment collection is not\\_paid","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#throwunlesspaymentcollectionnotpaid","depth":2},{"type":"workflow","name":"createPaymentSessionsWorkflow","description":"This workflow creates payment sessions.","link":"../../core_flows/core_flows.Workflows_Payment_Collection/page.mdx#createpaymentsessionsworkflow","depth":3},{"type":"step","name":"authorizePaymentSessionStep","description":"This step authorizes a payment session.","link":"../../core_flows/core_flows.Steps_Payment/page.mdx#authorizepaymentsessionstep","depth":4},{"type":"workflow","name":"capturePaymentWorkflow","description":"This workflow captures a payment.","link":"../../core_flows/core_flows.Workflows_Payment/page.mdx#capturepaymentworkflow","depth":5}]}} />
|
||||
<undefined workflow={{"name":"markPaymentCollectionAsPaid","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"throwUnlessPaymentCollectionNotPaid","description":"This step validates that the payment collection is not\\_paid","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#throwunlesspaymentcollectionnotpaid","depth":2},{"type":"workflow","name":"createPaymentSessionsWorkflow","description":"This workflow creates payment sessions.","link":"../../core_flows/core_flows.Workflows_Payment_Collection/page.mdx#createpaymentsessionsworkflow","depth":3},{"type":"step","name":"authorizePaymentSessionStep","description":"This step authorizes a payment session.","link":"../../core_flows/core_flows.Steps_Payment/page.mdx#authorizepaymentsessionstep","depth":4},{"type":"workflow","name":"capturePaymentWorkflow","description":"This workflow captures a payment.","link":"../../core_flows/core_flows.Workflows_Payment/page.mdx#capturepaymentworkflow","depth":5}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7068,7 +7068,7 @@ This workflow requests an order order-edit.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"beginOrderEditOrderWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"beginOrderEditValidationStep","description":"This step validates that an order-edit can be requested for an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#beginordereditvalidationstep","depth":2},{"type":"step","name":"createOrderChangeStep","description":"This step creates an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createorderchangestep","depth":3}]}} />
|
||||
<undefined workflow={{"name":"beginOrderEditOrderWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"beginOrderEditValidationStep","description":"This step validates that an order-edit can be requested for an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#beginordereditvalidationstep","depth":2},{"type":"step","name":"createOrderChangeStep","description":"This step creates an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createorderchangestep","depth":3}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7092,7 +7092,7 @@ This workflow cancels a requested order edit.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"cancelBeginOrderEditWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"cancelBeginOrderEditValidationStep","description":"This step validates that a requested order edit can be canceled.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#cancelbeginordereditvalidationstep","depth":3},{"type":"step","name":"deleteOrderChangesStep","description":"This step deletes order changes.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangesstep","depth":4},{"type":"step","name":"deleteOrderShippingMethods","description":"This step deletes order shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteordershippingmethods","depth":4}]}} />
|
||||
<undefined workflow={{"name":"cancelBeginOrderEditWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"cancelBeginOrderEditValidationStep","description":"This step validates that a requested order edit can be canceled.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#cancelbeginordereditvalidationstep","depth":3},{"type":"step","name":"deleteOrderChangesStep","description":"This step deletes order changes.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangesstep","depth":4},{"type":"step","name":"deleteOrderShippingMethods","description":"This step deletes order shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteordershippingmethods","depth":4}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7112,7 +7112,7 @@ This workflow confirms an order edit request.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"confirmOrderEditRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"confirmOrderEditRequestValidationStep","description":"This step validates that a requested order edit can be confirmed.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#confirmordereditrequestvalidationstep","depth":3},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":4},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":5},{"type":"step","name":"deleteReservationsByLineItemsStep","description":"This step deletes reservations by their associated line items.","link":"../../core_flows/core_flows.Steps_Reservation/page.mdx#deletereservationsbylineitemsstep","depth":6},{"type":"step","name":"reserveInventoryStep","description":"This step reserves the quantity of line items from the associated\nvariant's inventory.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#reserveinventorystep","depth":7}]}} />
|
||||
<undefined workflow={{"name":"confirmOrderEditRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"confirmOrderEditRequestValidationStep","description":"This step validates that a requested order edit can be confirmed.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#confirmordereditrequestvalidationstep","depth":3},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":4},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":5},{"type":"step","name":"deleteReservationsByLineItemsStep","description":"This step deletes reservations by their associated line items.","link":"../../core_flows/core_flows.Steps_Reservation/page.mdx#deletereservationsbylineitemsstep","depth":6},{"type":"step","name":"reserveInventoryStep","description":"This step reserves the quantity of line items from the associated\nvariant's inventory.","link":"../../core_flows/core_flows.Steps_Cart/page.mdx#reserveinventorystep","depth":7}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7136,7 +7136,7 @@ This workflow creates a shipping method for an order edit.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"createOrderEditShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"workflow","name":"updateOrderTaxLinesWorkflow","description":"This workflow updates the tax lines of items and shipping methods in an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateordertaxlinesworkflow","depth":4},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
<undefined workflow={{"name":"createOrderEditShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"workflow","name":"updateOrderTaxLinesWorkflow","description":"This workflow updates the tax lines of items and shipping methods in an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateordertaxlinesworkflow","depth":4},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7160,7 +7160,7 @@ This workflow adds new items to an order edit.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"orderEditAddNewItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"orderEditAddNewItemValidationStep","description":"This step validates that new items can be added to an order edit.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#ordereditaddnewitemvalidationstep","depth":3},{"type":"workflow","name":"addOrderLineItemsWorkflow","description":"This workflow adds line items to an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#addorderlineitemsworkflow","depth":4},{"type":"workflow","name":"updateOrderTaxLinesWorkflow","description":"This workflow updates the tax lines of items and shipping methods in an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateordertaxlinesworkflow","depth":5},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":7}]}} />
|
||||
<undefined workflow={{"name":"orderEditAddNewItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"orderEditAddNewItemValidationStep","description":"This step validates that new items can be added to an order edit.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#ordereditaddnewitemvalidationstep","depth":3},{"type":"workflow","name":"addOrderLineItemsWorkflow","description":"This workflow adds line items to an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#addorderlineitemsworkflow","depth":4},{"type":"workflow","name":"updateOrderTaxLinesWorkflow","description":"This workflow updates the tax lines of items and shipping methods in an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateordertaxlinesworkflow","depth":5},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":6},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":7}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7184,7 +7184,7 @@ This workflow update item's quantity of an order.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"orderEditUpdateItemQuantityWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"orderEditUpdateItemQuantityValidationStep","description":"This step validates that item quantity updated can be added to an order edit.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#ordereditupdateitemquantityvalidationstep","depth":3},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":5}]}} />
|
||||
<undefined workflow={{"name":"orderEditUpdateItemQuantityWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"orderEditUpdateItemQuantityValidationStep","description":"This step validates that item quantity updated can be added to an order edit.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#ordereditupdateitemquantityvalidationstep","depth":3},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":5}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7208,7 +7208,7 @@ This workflow removes a new item in an order edit.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"removeItemOrderEditActionWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"removeOrderEditItemActionValidationStep","description":"This step validates that a new item can be removed from an order edit.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#removeorderedititemactionvalidationstep","depth":3},{"type":"step","name":"deleteOrderChangeActionsStep","description":"This step deletes order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangeactionsstep","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":5}]}} />
|
||||
<undefined workflow={{"name":"removeItemOrderEditActionWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"removeOrderEditItemActionValidationStep","description":"This step validates that a new item can be removed from an order edit.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#removeorderedititemactionvalidationstep","depth":3},{"type":"step","name":"deleteOrderChangeActionsStep","description":"This step deletes order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangeactionsstep","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":5}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7232,7 +7232,7 @@ This workflow removes a shipping method of an order edit.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"removeOrderEditShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"removeOrderEditShippingMethodValidationStep","description":"This step validates that a shipping method can be removed from an order edit.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#removeordereditshippingmethodvalidationstep","depth":2},{"type":"step","name":"deleteOrderChangeActionsStep","description":"This step deletes order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangeactionsstep","depth":3},{"type":"step","name":"deleteOrderShippingMethods","description":"This step deletes order shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteordershippingmethods","depth":3},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":4}]}} />
|
||||
<undefined workflow={{"name":"removeOrderEditShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"removeOrderEditShippingMethodValidationStep","description":"This step validates that a shipping method can be removed from an order edit.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#removeordereditshippingmethodvalidationstep","depth":2},{"type":"step","name":"deleteOrderChangeActionsStep","description":"This step deletes order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangeactionsstep","depth":3},{"type":"step","name":"deleteOrderShippingMethods","description":"This step deletes order shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteordershippingmethods","depth":3},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":4}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7256,7 +7256,7 @@ This workflow requests an order edit request.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"requestOrderEditRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"requestOrderEditRequestValidationStep","description":"This step validates that a order edit can be requested.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#requestordereditrequestvalidationstep","depth":3},{"type":"step","name":"updateOrderChangesStep","description":"This step updates order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangesstep","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":5}]}} />
|
||||
<undefined workflow={{"name":"requestOrderEditRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"requestOrderEditRequestValidationStep","description":"This step validates that a order edit can be requested.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#requestordereditrequestvalidationstep","depth":3},{"type":"step","name":"updateOrderChangesStep","description":"This step updates order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangesstep","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":5}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7280,7 +7280,7 @@ This workflow updates a new item in the order edit.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"updateOrderEditAddItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"updateOrderEditAddItemValidationStep","description":"This step validates that a new item can be updated from an order edit.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateordereditadditemvalidationstep","depth":3},{"type":"step","name":"updateOrderChangeActionsStep","description":"This step updates order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangeactionsstep","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":5}]}} />
|
||||
<undefined workflow={{"name":"updateOrderEditAddItemWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"updateOrderEditAddItemValidationStep","description":"This step validates that a new item can be updated from an order edit.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateordereditadditemvalidationstep","depth":3},{"type":"step","name":"updateOrderChangeActionsStep","description":"This step updates order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangeactionsstep","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":5}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7304,7 +7304,7 @@ This workflow updates a new item in the order edit.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"updateOrderEditItemQuantityWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"updateOrderEditItemQuantityValidationStep","description":"This step validates that an item can be updated from an order edit.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateorderedititemquantityvalidationstep","depth":3},{"type":"step","name":"updateOrderChangeActionsStep","description":"This step updates order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangeactionsstep","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":5}]}} />
|
||||
<undefined workflow={{"name":"updateOrderEditItemQuantityWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"updateOrderEditItemQuantityValidationStep","description":"This step validates that an item can be updated from an order edit.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateorderedititemquantityvalidationstep","depth":3},{"type":"step","name":"updateOrderChangeActionsStep","description":"This step updates order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangeactionsstep","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":5}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7328,7 +7328,7 @@ This workflow updates an order edit's shipping method.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"updateOrderEditShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"when","condition":"{\n return input.data?.custom_amount === null\n }","depth":"3","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3}]},{"type":"step","name":"updateOrderEditShippingMethodValidationStep","description":"This step validates that an order edit's shipping method can be updated.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateordereditshippingmethodvalidationstep","depth":4},{"type":"step","name":"updateOrderChangeActionsStep","description":"This step updates order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangeactionsstep","depth":5},{"type":"step","name":"updateOrderShippingMethodsStep","description":"This step updates order shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateordershippingmethodsstep","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
<undefined workflow={{"name":"updateOrderEditShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"when","condition":"{\n return input.data?.custom_amount === null\n }","depth":"3","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3}]},{"type":"step","name":"updateOrderEditShippingMethodValidationStep","description":"This step validates that an order edit's shipping method can be updated.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateordereditshippingmethodvalidationstep","depth":4},{"type":"step","name":"updateOrderChangeActionsStep","description":"This step updates order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangeactionsstep","depth":5},{"type":"step","name":"updateOrderShippingMethodsStep","description":"This step updates order shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateordershippingmethodsstep","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7352,7 +7352,7 @@ This workflow requests return receival.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"beginReceiveReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"beginReceiveReturnValidationStep","description":"This step validates that a return can be received.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#beginreceivereturnvalidationstep","depth":3},{"type":"step","name":"createOrderChangeStep","description":"This step creates an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createorderchangestep","depth":4}]}} />
|
||||
<undefined workflow={{"name":"beginReceiveReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"beginReceiveReturnValidationStep","description":"This step validates that a return can be received.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#beginreceivereturnvalidationstep","depth":3},{"type":"step","name":"createOrderChangeStep","description":"This step creates an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createorderchangestep","depth":4}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7376,7 +7376,7 @@ This workflow requests a return.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"beginReturnOrderWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"beginReturnOrderValidationStep","description":"This step validates that a return can be created for an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#beginreturnordervalidationstep","depth":2},{"type":"step","name":"createReturnsStep","description":"This step creates returns.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createreturnsstep","depth":3},{"type":"step","name":"createOrderChangeStep","description":"This step creates an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createorderchangestep","depth":4}]}} />
|
||||
<undefined workflow={{"name":"beginReturnOrderWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"beginReturnOrderValidationStep","description":"This step validates that a return can be created for an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#beginreturnordervalidationstep","depth":2},{"type":"step","name":"createReturnsStep","description":"This step creates returns.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createreturnsstep","depth":3},{"type":"step","name":"createOrderChangeStep","description":"This step creates an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createorderchangestep","depth":4}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7400,7 +7400,7 @@ This workflow cancels a return receival.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"cancelReturnReceiveWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"cancelReceiveReturnValidationStep","description":"This step validates that a return receival can be canceled.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#cancelreceivereturnvalidationstep","depth":4},{"type":"step","name":"deleteOrderChangesStep","description":"This step deletes order changes.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangesstep","depth":5}]}} />
|
||||
<undefined workflow={{"name":"cancelReturnReceiveWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"cancelReceiveReturnValidationStep","description":"This step validates that a return receival can be canceled.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#cancelreceivereturnvalidationstep","depth":4},{"type":"step","name":"deleteOrderChangesStep","description":"This step deletes order changes.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangesstep","depth":5}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7420,7 +7420,7 @@ This workflow cancels a requested return.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"cancelReturnRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"cancelRequestReturnValidationStep","description":"This step validates that a requested return can be canceled.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#cancelrequestreturnvalidationstep","depth":4},{"type":"step","name":"deleteReturnsStep","description":"This step deletes one or more returns.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deletereturnsstep","depth":5},{"type":"step","name":"deleteOrderChangesStep","description":"This step deletes order changes.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangesstep","depth":5},{"type":"step","name":"deleteOrderShippingMethods","description":"This step deletes order shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteordershippingmethods","depth":5}]}} />
|
||||
<undefined workflow={{"name":"cancelReturnRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"cancelRequestReturnValidationStep","description":"This step validates that a requested return can be canceled.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#cancelrequestreturnvalidationstep","depth":4},{"type":"step","name":"deleteReturnsStep","description":"This step deletes one or more returns.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deletereturnsstep","depth":5},{"type":"step","name":"deleteOrderChangesStep","description":"This step deletes order changes.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangesstep","depth":5},{"type":"step","name":"deleteOrderShippingMethods","description":"This step deletes order shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteordershippingmethods","depth":5}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7440,7 +7440,7 @@ This workflow cancels a return.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"cancelReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"cancelReturnValidateOrder","description":"This step validates that a return can be canceled.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#cancelreturnvalidateorder","depth":2},{"type":"step","name":"cancelOrderReturnStep","description":"This step cancels a return.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#cancelorderreturnstep","depth":3}]}} />
|
||||
<undefined workflow={{"name":"cancelReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"cancelReturnValidateOrder","description":"This step validates that a return can be canceled.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#cancelreturnvalidateorder","depth":2},{"type":"step","name":"cancelOrderReturnStep","description":"This step cancels a return.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#cancelorderreturnstep","depth":3}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7460,7 +7460,7 @@ This workflow confirms a return receival request.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"confirmReturnReceiveWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"confirmReceiveReturnValidationStep","description":"This step validates that a return receival can be confirmed.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#confirmreceivereturnvalidationstep","depth":4},{"type":"step","name":"updateReturnsStep","description":"This step updates one or more returns.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updatereturnsstep","depth":5},{"type":"step","name":"updateReturnItemsStep","description":"This step updates return items.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updatereturnitemsstep","depth":5},{"type":"step","name":"adjustInventoryLevelsStep","description":"This step adjusts one or more inventory levels.","link":"../../core_flows/core_flows.Steps_Inventory/page.mdx#adjustinventorylevelsstep","depth":5},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
<undefined workflow={{"name":"confirmReturnReceiveWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"confirmReceiveReturnValidationStep","description":"This step validates that a return receival can be confirmed.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#confirmreceivereturnvalidationstep","depth":4},{"type":"step","name":"updateReturnsStep","description":"This step updates one or more returns.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updatereturnsstep","depth":5},{"type":"step","name":"updateReturnItemsStep","description":"This step updates return items.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updatereturnitemsstep","depth":5},{"type":"step","name":"adjustInventoryLevelsStep","description":"This step adjusts one or more inventory levels.","link":"../../core_flows/core_flows.Steps_Inventory/page.mdx#adjustinventorylevelsstep","depth":5},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7484,7 +7484,7 @@ This workflow confirms a return request.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"confirmReturnRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"confirmReturnRequestValidationStep","description":"This step validates that a return request can be confirmed.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#confirmreturnrequestvalidationstep","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":5},{"type":"when","condition":"{\n return !!returnShippingOptionId\n }","depth":"6","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":6},{"type":"workflow","name":"createReturnFulfillmentWorkflow","description":"This workflow creates a fulfillment for a return.","link":"../../core_flows/core_flows.Workflows_Fulfillment/page.mdx#createreturnfulfillmentworkflow","depth":6},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#create-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#createremotelinkstep","depth":6}]},{"type":"step","name":"updateReturnsStep","description":"This step updates one or more returns.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updatereturnsstep","depth":7},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":7}]}} />
|
||||
<undefined workflow={{"name":"confirmReturnRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"confirmReturnRequestValidationStep","description":"This step validates that a return request can be confirmed.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#confirmreturnrequestvalidationstep","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":5},{"type":"when","condition":"{\n return !!returnShippingOptionId\n }","depth":"6","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":6},{"type":"workflow","name":"createReturnFulfillmentWorkflow","description":"This workflow creates a fulfillment for a return.","link":"../../core_flows/core_flows.Workflows_Fulfillment/page.mdx#createreturnfulfillmentworkflow","depth":6},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/advanced-development/modules/remote-link#create-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#createremotelinkstep","depth":6}]},{"type":"step","name":"updateReturnsStep","description":"This step updates one or more returns.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updatereturnsstep","depth":7},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":7}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7508,7 +7508,7 @@ This workflow creates and completes a return.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"createAndCompleteReturnOrderWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"createCompleteReturnValidationStep","description":"This step validates that a return can be created and completed for an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createcompletereturnvalidationstep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"workflow","name":"createReturnFulfillmentWorkflow","description":"This workflow creates a fulfillment for a return.","link":"../../core_flows/core_flows.Workflows_Fulfillment/page.mdx#createreturnfulfillmentworkflow","depth":4},{"type":"step","name":"createCompleteReturnStep","description":"This step creates a return.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createcompletereturnstep","depth":5},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#create-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#createremotelinkstep","depth":6},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":7},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":7}]}} />
|
||||
<undefined workflow={{"name":"createAndCompleteReturnOrderWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"createCompleteReturnValidationStep","description":"This step validates that a return can be created and completed for an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createcompletereturnvalidationstep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"workflow","name":"createReturnFulfillmentWorkflow","description":"This workflow creates a fulfillment for a return.","link":"../../core_flows/core_flows.Workflows_Fulfillment/page.mdx#createreturnfulfillmentworkflow","depth":4},{"type":"step","name":"createCompleteReturnStep","description":"This step creates a return.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#createcompletereturnstep","depth":5},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/advanced-development/modules/remote-link#create-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#createremotelinkstep","depth":6},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":7},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":7}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7528,7 +7528,7 @@ This workflow creates a shipping method for a return.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"createReturnShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":4},{"type":"step","name":"createReturnShippingMethodValidationStep","description":"This step validates that a shipping method can be created for a return.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createreturnshippingmethodvalidationstep","depth":5},{"type":"workflow","name":"updateOrderTaxLinesWorkflow","description":"This workflow updates the tax lines of items and shipping methods in an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateordertaxlinesworkflow","depth":6},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":7},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":8}]}} />
|
||||
<undefined workflow={{"name":"createReturnShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":4},{"type":"step","name":"createReturnShippingMethodValidationStep","description":"This step validates that a shipping method can be created for a return.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createreturnshippingmethodvalidationstep","depth":5},{"type":"workflow","name":"updateOrderTaxLinesWorkflow","description":"This workflow updates the tax lines of items and shipping methods in an order.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updateordertaxlinesworkflow","depth":6},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":7},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":8}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7552,7 +7552,7 @@ This workflow dismisses items from a return request.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"dismissItemReturnRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"dismissItemReturnRequestValidationStep","description":"This step validates that a return request can have its items dismissed.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#dismissitemreturnrequestvalidationstep","depth":4},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
<undefined workflow={{"name":"dismissItemReturnRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"dismissItemReturnRequestValidationStep","description":"This step validates that a return request can have its items dismissed.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#dismissitemreturnrequestvalidationstep","depth":4},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7576,7 +7576,7 @@ This workflow marks a return as received and completes it.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"receiveAndCompleteReturnOrderWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"receiveCompleteReturnValidationStep","description":"This step validates that a return can be received and completed.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#receivecompletereturnvalidationstep","depth":2}]}} />
|
||||
<undefined workflow={{"name":"receiveAndCompleteReturnOrderWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"receiveCompleteReturnValidationStep","description":"This step validates that a return can be received and completed.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#receivecompletereturnvalidationstep","depth":2}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7600,7 +7600,7 @@ This workflow marks return items as received.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"receiveItemReturnRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"receiveItemReturnRequestValidationStep","description":"This step validates that a return's items can be marked as received.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#receiveitemreturnrequestvalidationstep","depth":4},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
<undefined workflow={{"name":"receiveItemReturnRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"receiveItemReturnRequestValidationStep","description":"This step validates that a return's items can be marked as received.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#receiveitemreturnrequestvalidationstep","depth":4},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7624,7 +7624,7 @@ This workflow removes an item from a return receival.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"removeItemReceiveReturnActionWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"removeItemReceiveReturnActionValidationStep","description":"This step validates that a return receival's item can be removed.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#removeitemreceivereturnactionvalidationstep","depth":4},{"type":"step","name":"deleteOrderChangeActionsStep","description":"This step deletes order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangeactionsstep","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
<undefined workflow={{"name":"removeItemReceiveReturnActionWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"removeItemReceiveReturnActionValidationStep","description":"This step validates that a return receival's item can be removed.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#removeitemreceivereturnactionvalidationstep","depth":4},{"type":"step","name":"deleteOrderChangeActionsStep","description":"This step deletes order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangeactionsstep","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7648,7 +7648,7 @@ This workflow removes a return item.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"removeItemReturnActionWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"removeReturnItemActionValidationStep","description":"This step validates that a return item can be removed.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#removereturnitemactionvalidationstep","depth":4},{"type":"step","name":"deleteOrderChangeActionsStep","description":"This step deletes order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangeactionsstep","depth":5},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":6},{"type":"when","condition":"{\n return !!actionIdToDelete\n }","depth":"7","steps":[{"type":"workflow","name":"removeReturnShippingMethodWorkflow","description":"This workflow removes a shipping method from a return.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#removereturnshippingmethodworkflow","depth":7},{"type":"workflow","name":"updateReturnWorkflow","description":"This workflow updates a return.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updatereturnworkflow","depth":7}]},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":8}]}} />
|
||||
<undefined workflow={{"name":"removeItemReturnActionWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"removeReturnItemActionValidationStep","description":"This step validates that a return item can be removed.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#removereturnitemactionvalidationstep","depth":4},{"type":"step","name":"deleteOrderChangeActionsStep","description":"This step deletes order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangeactionsstep","depth":5},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":6},{"type":"when","condition":"{\n return !!actionIdToDelete\n }","depth":"7","steps":[{"type":"workflow","name":"removeReturnShippingMethodWorkflow","description":"This workflow removes a shipping method from a return.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#removereturnshippingmethodworkflow","depth":7},{"type":"workflow","name":"updateReturnWorkflow","description":"This workflow updates a return.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updatereturnworkflow","depth":7}]},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":8}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7672,7 +7672,7 @@ This workflow removes a shipping method from a return.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"removeReturnShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"removeReturnShippingMethodValidationStep","description":"This step validates that a shipping method can be removed from a return.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#removereturnshippingmethodvalidationstep","depth":3},{"type":"step","name":"deleteOrderChangeActionsStep","description":"This step deletes order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangeactionsstep","depth":4},{"type":"step","name":"deleteOrderShippingMethods","description":"This step deletes order shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteordershippingmethods","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":5}]}} />
|
||||
<undefined workflow={{"name":"removeReturnShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"removeReturnShippingMethodValidationStep","description":"This step validates that a shipping method can be removed from a return.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#removereturnshippingmethodvalidationstep","depth":3},{"type":"step","name":"deleteOrderChangeActionsStep","description":"This step deletes order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteorderchangeactionsstep","depth":4},{"type":"step","name":"deleteOrderShippingMethods","description":"This step deletes order shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#deleteordershippingmethods","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":5}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7696,7 +7696,7 @@ This workflow adds items to a return.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"requestItemReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"requestItemReturnValidationStep","description":"This step validates that itens can be added to a return.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#requestitemreturnvalidationstep","depth":4},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
<undefined workflow={{"name":"requestItemReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"requestItemReturnValidationStep","description":"This step validates that itens can be added to a return.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#requestitemreturnvalidationstep","depth":4},{"type":"workflow","name":"createOrderChangeActionsWorkflow","description":"This workflow creates order change actions.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#createorderchangeactionsworkflow","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7720,7 +7720,7 @@ This workflow updates an item in a return receival request.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"updateReceiveItemReturnRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"updateReceiveItemReturnRequestValidationStep","description":"This step validates that an item can be updated in a return receival request.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updatereceiveitemreturnrequestvalidationstep","depth":4},{"type":"step","name":"updateOrderChangeActionsStep","description":"This step updates order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangeactionsstep","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
<undefined workflow={{"name":"updateReceiveItemReturnRequestWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"updateReceiveItemReturnRequestValidationStep","description":"This step validates that an item can be updated in a return receival request.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updatereceiveitemreturnrequestvalidationstep","depth":4},{"type":"step","name":"updateOrderChangeActionsStep","description":"This step updates order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangeactionsstep","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7744,7 +7744,7 @@ This workflow updates an item in a return.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"updateRequestItemReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"updateRequestItemReturnValidationStep","description":"This step validates that an item in a return can be updated.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updaterequestitemreturnvalidationstep","depth":4},{"type":"step","name":"updateOrderChangeActionsStep","description":"This step updates order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangeactionsstep","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
<undefined workflow={{"name":"updateRequestItemReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"updateRequestItemReturnValidationStep","description":"This step validates that an item in a return can be updated.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updaterequestitemreturnvalidationstep","depth":4},{"type":"step","name":"updateOrderChangeActionsStep","description":"This step updates order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangeactionsstep","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7768,7 +7768,7 @@ This workflow updates the shipping method of a return.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"updateReturnShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"when","condition":"{\n return input.data?.custom_amount === null\n }","depth":"3","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3}]},{"type":"step","name":"updateReturnShippingMethodValidationStep","description":"This step validates that a return's shipping method can be updated.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updatereturnshippingmethodvalidationstep","depth":4},{"type":"step","name":"updateOrderChangeActionsStep","description":"This step updates order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangeactionsstep","depth":5},{"type":"step","name":"updateOrderShippingMethodsStep","description":"This step updates order shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateordershippingmethodsstep","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
<undefined workflow={{"name":"updateReturnShippingMethodWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"when","condition":"{\n return input.data?.custom_amount === null\n }","depth":"3","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3}]},{"type":"step","name":"updateReturnShippingMethodValidationStep","description":"This step validates that a return's shipping method can be updated.","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updatereturnshippingmethodvalidationstep","depth":4},{"type":"step","name":"updateOrderChangeActionsStep","description":"This step updates order change actions.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateorderchangeactionsstep","depth":5},{"type":"step","name":"updateOrderShippingMethodsStep","description":"This step updates order shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updateordershippingmethodsstep","depth":5},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":6}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7792,7 +7792,7 @@ This workflow updates a return.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"updateReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"updateReturnValidationStep","description":"This step validates that a return can be updated","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updatereturnvalidationstep","depth":3},{"type":"step","name":"updateReturnsStep","description":"This step updates one or more returns.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updatereturnsstep","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":5}]}} />
|
||||
<undefined workflow={{"name":"updateReturnWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"updateReturnValidationStep","description":"This step validates that a return can be updated","link":"../../core_flows/core_flows.Workflows_Order/page.mdx#updatereturnvalidationstep","depth":3},{"type":"step","name":"updateReturnsStep","description":"This step updates one or more returns.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#updatereturnsstep","depth":4},{"type":"step","name":"previewOrderChangeStep","description":"This step retrieves a preview of an order change.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#previeworderchangestep","depth":5}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7840,7 +7840,7 @@ This workflow updates the tax lines of items and shipping methods in an order.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"updateOrderTaxLinesWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"when","condition":"{\n return input.item_ids!?.length > 0\n }","depth":"2","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2}]},{"type":"when","condition":"{\n return input.shipping_method_ids!?.length > 0\n }","depth":"3","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3}]},{"type":"step","name":"getOrderItemTaxLinesStep","description":"This step retrieves the tax lines for an order's line items and shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#getorderitemtaxlinesstep","depth":4},{"type":"step","name":"setOrderTaxLinesForItemsStep","description":"This step sets the tax lines of an order's items and shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#setordertaxlinesforitemsstep","depth":5}]}} />
|
||||
<undefined workflow={{"name":"updateOrderTaxLinesWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"when","condition":"{\n return input.item_ids!?.length > 0\n }","depth":"2","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2}]},{"type":"when","condition":"{\n return input.shipping_method_ids!?.length > 0\n }","depth":"3","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3}]},{"type":"step","name":"getOrderItemTaxLinesStep","description":"This step retrieves the tax lines for an order's line items and shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#getorderitemtaxlinesstep","depth":4},{"type":"step","name":"setOrderTaxLinesForItemsStep","description":"This step sets the tax lines of an order's items and shipping methods.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#setordertaxlinesforitemsstep","depth":5}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -7931,7 +7931,7 @@ This workflow creates payment sessions.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"createPaymentSessionsWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"createPaymentSessionStep","description":"This step creates a payment session.","link":"../../core_flows/core_flows.Steps_Payment_Collection/page.mdx#createpaymentsessionstep","depth":2},{"type":"workflow","name":"deletePaymentSessionsWorkflow","description":"This workflow deletes one or more payment sessions.","link":"../../core_flows/core_flows.Workflows_Payment_Collection/page.mdx#deletepaymentsessionsworkflow","depth":2}]}} />
|
||||
<undefined workflow={{"name":"createPaymentSessionsWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"createPaymentSessionStep","description":"This step creates a payment session.","link":"../../core_flows/core_flows.Steps_Payment_Collection/page.mdx#createpaymentsessionstep","depth":2},{"type":"workflow","name":"deletePaymentSessionsWorkflow","description":"This workflow deletes one or more payment sessions.","link":"../../core_flows/core_flows.Workflows_Payment_Collection/page.mdx#deletepaymentsessionsworkflow","depth":2}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -8039,7 +8039,7 @@ This workflow captures a payment.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"capturePaymentWorkflow","steps":[{"type":"step","name":"capturePaymentStep","description":"This step captures a payment.","link":"../../core_flows/core_flows.Steps_Payment/page.mdx#capturepaymentstep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"when","condition":"{\n return !!orderPayment?.order?.id\n }","depth":"3","steps":[{"type":"step","name":"addOrderTransactionStep","description":"This step creates an order transaction.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#addordertransactionstep","depth":3}]},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":4}]}} />
|
||||
<undefined workflow={{"name":"capturePaymentWorkflow","steps":[{"type":"step","name":"capturePaymentStep","description":"This step captures a payment.","link":"../../core_flows/core_flows.Steps_Payment/page.mdx#capturepaymentstep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"when","condition":"{\n return !!orderPayment?.order?.id\n }","depth":"3","steps":[{"type":"step","name":"addOrderTransactionStep","description":"This step creates an order transaction.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#addordertransactionstep","depth":3}]},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":4}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -8053,7 +8053,7 @@ This workflow captures a payment.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"onPaymentProcessedWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"when","condition":"{\n return !!cartPaymentCollection.data.length\n }","depth":"2","steps":[{"type":"workflow","name":"completeCartWorkflow","description":"This workflow completes a cart.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#completecartworkflow","depth":2}]}]}} />
|
||||
<undefined workflow={{"name":"onPaymentProcessedWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"when","condition":"{\n return !!cartPaymentCollection.data.length\n }","depth":"2","steps":[{"type":"workflow","name":"completeCartWorkflow","description":"This workflow completes a cart.","link":"../../core_flows/core_flows.Workflows_Cart/page.mdx#completecartworkflow","depth":2}]}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -8083,7 +8083,7 @@ This workflow refunds a payment.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"refundPaymentWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"validateRefundStep","description":"This step validates that the refund is valid for the order","link":"../../core_flows/core_flows.Workflows_Payment/page.mdx#validaterefundstep","depth":4},{"type":"step","name":"refundPaymentStep","description":"This step refunds a payment.","link":"../../core_flows/core_flows.Steps_Payment/page.mdx#refundpaymentstep","depth":5},{"type":"when","condition":"{\n return !!orderPaymentCollection?.order?.id\n }","depth":"6","steps":[{"type":"step","name":"addOrderTransactionStep","description":"This step creates an order transaction.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#addordertransactionstep","depth":6}]},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":7}]}} />
|
||||
<undefined workflow={{"name":"refundPaymentWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"step","name":"validateRefundStep","description":"This step validates that the refund is valid for the order","link":"../../core_flows/core_flows.Workflows_Payment/page.mdx#validaterefundstep","depth":4},{"type":"step","name":"refundPaymentStep","description":"This step refunds a payment.","link":"../../core_flows/core_flows.Steps_Payment/page.mdx#refundpaymentstep","depth":5},{"type":"when","condition":"{\n return !!orderPaymentCollection?.order?.id\n }","depth":"6","steps":[{"type":"step","name":"addOrderTransactionStep","description":"This step creates an order transaction.","link":"../../core_flows/core_flows.Steps_Order/page.mdx#addordertransactionstep","depth":6}]},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":7}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -9179,7 +9179,7 @@ This workflow deletes one or more product variants.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"deleteProductVariantsWorkflow","steps":[{"type":"step","name":"removeRemoteLinkStep","description":"This step deletes linked records of a record.\n\nLearn more in the [Remote Link documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#removeremotelinkstep","depth":1},{"type":"step","name":"useQueryGraphStep","description":"","link":"../../core_flows/core_flows.Steps_Common/page.mdx#usequerygraphstep","depth":2},{"type":"workflow","name":"deleteInventoryItemWorkflow","description":"This workflow deletes one or more inventory items.","link":"../../core_flows/core_flows.Workflows_Inventory/page.mdx#deleteinventoryitemworkflow","depth":3},{"type":"step","name":"deleteProductVariantsStep","description":"This step deletes one or more product variants.","link":"../../core_flows/core_flows.Steps_Product/page.mdx#deleteproductvariantsstep","depth":4},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":5},{"type":"hook","name":"productVariantsDeleted","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#productVariantsDeleted","depth":6}]}} />
|
||||
<undefined workflow={{"name":"deleteProductVariantsWorkflow","steps":[{"type":"step","name":"removeRemoteLinkStep","description":"This step deletes linked records of a record.\n\nLearn more in the [Remote Link documentation](https://docs.medusajs.com/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#removeremotelinkstep","depth":1},{"type":"step","name":"useQueryGraphStep","description":"","link":"../../core_flows/core_flows.Steps_Common/page.mdx#usequerygraphstep","depth":2},{"type":"workflow","name":"deleteInventoryItemWorkflow","description":"This workflow deletes one or more inventory items.","link":"../../core_flows/core_flows.Workflows_Inventory/page.mdx#deleteinventoryitemworkflow","depth":3},{"type":"step","name":"deleteProductVariantsStep","description":"This step deletes one or more product variants.","link":"../../core_flows/core_flows.Steps_Product/page.mdx#deleteproductvariantsstep","depth":4},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":5},{"type":"hook","name":"productVariantsDeleted","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#productVariantsDeleted","depth":6}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -9213,7 +9213,7 @@ This workflow deletes one or more products.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"deleteProductsWorkflow","steps":[{"type":"step","name":"getProductsStep","description":"This step retrieves products.","link":"../../core_flows/core_flows.Steps_Product/page.mdx#getproductsstep","depth":1},{"type":"step","name":"useQueryGraphStep","description":"","link":"../../core_flows/core_flows.Steps_Common/page.mdx#usequerygraphstep","depth":2},{"type":"workflow","name":"deleteInventoryItemWorkflow","description":"This workflow deletes one or more inventory items.","link":"../../core_flows/core_flows.Workflows_Inventory/page.mdx#deleteinventoryitemworkflow","depth":3},{"type":"step","name":"removeRemoteLinkStep","description":"This step deletes linked records of a record.\n\nLearn more in the [Remote Link documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#removeremotelinkstep","depth":4},{"type":"step","name":"deleteProductsStep","description":"This step deletes one or more products.","link":"../../core_flows/core_flows.Steps_Product/page.mdx#deleteproductsstep","depth":4},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":5},{"type":"hook","name":"productsDeleted","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#productsDeleted","depth":6}]}} />
|
||||
<undefined workflow={{"name":"deleteProductsWorkflow","steps":[{"type":"step","name":"getProductsStep","description":"This step retrieves products.","link":"../../core_flows/core_flows.Steps_Product/page.mdx#getproductsstep","depth":1},{"type":"step","name":"useQueryGraphStep","description":"","link":"../../core_flows/core_flows.Steps_Common/page.mdx#usequerygraphstep","depth":2},{"type":"workflow","name":"deleteInventoryItemWorkflow","description":"This workflow deletes one or more inventory items.","link":"../../core_flows/core_flows.Workflows_Inventory/page.mdx#deleteinventoryitemworkflow","depth":3},{"type":"step","name":"removeRemoteLinkStep","description":"This step deletes linked records of a record.\n\nLearn more in the [Remote Link documentation](https://docs.medusajs.com/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#removeremotelinkstep","depth":4},{"type":"step","name":"deleteProductsStep","description":"This step deletes one or more products.","link":"../../core_flows/core_flows.Steps_Product/page.mdx#deleteproductsstep","depth":4},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":5},{"type":"hook","name":"productsDeleted","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#productsDeleted","depth":6}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -9247,7 +9247,7 @@ This workflow exports products matching the specified filters.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"exportProductsWorkflow","steps":[{"type":"step","name":"getAllProductsStep","description":"This step retrieves all products.","link":"../../core_flows/core_flows.Steps_Product/page.mdx#getallproductsstep","depth":1},{"type":"step","name":"generateProductCsvStep","description":"This step generates a CSV file to be exported.","link":"../../core_flows/core_flows.Steps_Product/page.mdx#generateproductcsvstep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3}]}} />
|
||||
<undefined workflow={{"name":"exportProductsWorkflow","steps":[{"type":"step","name":"getAllProductsStep","description":"This step retrieves all products.","link":"../../core_flows/core_flows.Steps_Product/page.mdx#getallproductsstep","depth":1},{"type":"step","name":"generateProductCsvStep","description":"This step generates a CSV file to be exported.","link":"../../core_flows/core_flows.Steps_Product/page.mdx#generateproductcsvstep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -9465,7 +9465,7 @@ This workflow updates one or more products.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"updateProductsWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"updateProductsStep","description":"This step updates one or more products.","link":"../../core_flows/core_flows.Steps_Product/page.mdx#updateproductsstep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"workflow","name":"upsertVariantPricesWorkflow","description":"This workflow creates or updates variants' prices.","link":"../../core_flows/core_flows.Workflows_Product/page.mdx#upsertvariantpricesworkflow","depth":4},{"type":"step","name":"dismissRemoteLinkStep","description":"This step removes remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#dismiss-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#dismissremotelinkstep","depth":5},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#create-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#createremotelinkstep","depth":6},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":6},{"type":"hook","name":"productsUpdated","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#productsUpdated","depth":7}]}} />
|
||||
<undefined workflow={{"name":"updateProductsWorkflow","steps":[{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"updateProductsStep","description":"This step updates one or more products.","link":"../../core_flows/core_flows.Steps_Product/page.mdx#updateproductsstep","depth":2},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"workflow","name":"upsertVariantPricesWorkflow","description":"This workflow creates or updates variants' prices.","link":"../../core_flows/core_flows.Workflows_Product/page.mdx#upsertvariantpricesworkflow","depth":4},{"type":"step","name":"dismissRemoteLinkStep","description":"This step removes remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/advanced-development/modules/remote-link#dismiss-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#dismissremotelinkstep","depth":5},{"type":"step","name":"createRemoteLinkStep","description":"This step creates remote links between two records of linked data models.\n\nLearn more in the [Remote Link documentation.](https://docs.medusajs.com/advanced-development/modules/remote-link#create-link).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#createremotelinkstep","depth":6},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":6},{"type":"hook","name":"productsUpdated","description":"This step is a hook that you can inject custom functionality into.\n\n","link":"#productsUpdated","depth":7}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -9503,7 +9503,7 @@ This workflow creates or updates variants' prices.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"upsertVariantPricesWorkflow","steps":[{"type":"step","name":"removeRemoteLinkStep","description":"This step deletes linked records of a record.\n\nLearn more in the [Remote Link documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#removeremotelinkstep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"updatePriceSetsStep","description":"This step updates price sets.","link":"../../core_flows/core_flows.Steps_Pricing/page.mdx#updatepricesetsstep","depth":3},{"type":"step","name":"createPriceSetsStep","description":"This step creates one or more price sets.","link":"../../core_flows/core_flows.Steps_Pricing/page.mdx#createpricesetsstep","depth":4},{"type":"step","name":"createVariantPricingLinkStep","description":"This step creates links between variant and price set records.","link":"../../core_flows/core_flows.Steps_Product/page.mdx#createvariantpricinglinkstep","depth":5}]}} />
|
||||
<undefined workflow={{"name":"upsertVariantPricesWorkflow","steps":[{"type":"step","name":"removeRemoteLinkStep","description":"This step deletes linked records of a record.\n\nLearn more in the [Remote Link documentation](https://docs.medusajs.com/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#removeremotelinkstep","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"step","name":"updatePriceSetsStep","description":"This step updates price sets.","link":"../../core_flows/core_flows.Steps_Pricing/page.mdx#updatepricesetsstep","depth":3},{"type":"step","name":"createPriceSetsStep","description":"This step creates one or more price sets.","link":"../../core_flows/core_flows.Steps_Pricing/page.mdx#createpricesetsstep","depth":4},{"type":"step","name":"createVariantPricingLinkStep","description":"This step creates links between variant and price set records.","link":"../../core_flows/core_flows.Steps_Product/page.mdx#createvariantpricinglinkstep","depth":5}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -10271,7 +10271,7 @@ This workflow deletes one or more sales channels.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"deleteSalesChannelsWorkflow","steps":[{"type":"step","name":"deleteSalesChannelsStep","description":"This step deletes one or more sales channels.","link":"../../core_flows/core_flows.Steps_Sales_Channel/page.mdx#deletesaleschannelsstep","depth":1},{"type":"step","name":"removeRemoteLinkStep","description":"This step deletes linked records of a record.\n\nLearn more in the [Remote Link documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#removeremotelinkstep","depth":2},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":3}]}} />
|
||||
<undefined workflow={{"name":"deleteSalesChannelsWorkflow","steps":[{"type":"step","name":"deleteSalesChannelsStep","description":"This step deletes one or more sales channels.","link":"../../core_flows/core_flows.Steps_Sales_Channel/page.mdx#deletesaleschannelsstep","depth":1},{"type":"step","name":"removeRemoteLinkStep","description":"This step deletes linked records of a record.\n\nLearn more in the [Remote Link documentation](https://docs.medusajs.com/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#removeremotelinkstep","depth":2},{"type":"step","name":"emitEventStep","description":"Emit an event.\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#emiteventstep","depth":3}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -10331,7 +10331,7 @@ This workflow deletes one or more shipping profiles.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"deleteShippingProfileWorkflow","steps":[{"type":"step","name":"deleteShippingProfilesStep","description":"This step deletes one or more shipping profiles.","link":"../../core_flows/core_flows.Steps_Shipping_Profile/page.mdx#deleteshippingprofilesstep","depth":1},{"type":"step","name":"removeRemoteLinkStep","description":"This step deletes linked records of a record.\n\nLearn more in the [Remote Link documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#removeremotelinkstep","depth":2}]}} />
|
||||
<undefined workflow={{"name":"deleteShippingProfileWorkflow","steps":[{"type":"step","name":"deleteShippingProfilesStep","description":"This step deletes one or more shipping profiles.","link":"../../core_flows/core_flows.Steps_Shipping_Profile/page.mdx#deleteshippingprofilesstep","depth":1},{"type":"step","name":"removeRemoteLinkStep","description":"This step deletes linked records of a record.\n\nLearn more in the [Remote Link documentation](https://docs.medusajs.com/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#removeremotelinkstep","depth":2}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -10407,7 +10407,7 @@ This workflow deletes one or more stock locations.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"deleteStockLocationsWorkflow","steps":[{"type":"step","name":"deleteStockLocationsStep","description":"This step deletes one or more stock locations.","link":"../../core_flows/core_flows.Steps_Stock_Location/page.mdx#deletestocklocationsstep","depth":1},{"type":"step","name":"removeRemoteLinkStep","description":"This step deletes linked records of a record.\n\nLearn more in the [Remote Link documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#removeremotelinkstep","depth":2}]}} />
|
||||
<undefined workflow={{"name":"deleteStockLocationsWorkflow","steps":[{"type":"step","name":"deleteStockLocationsStep","description":"This step deletes one or more stock locations.","link":"../../core_flows/core_flows.Steps_Stock_Location/page.mdx#deletestocklocationsstep","depth":1},{"type":"step","name":"removeRemoteLinkStep","description":"This step deletes linked records of a record.\n\nLearn more in the [Remote Link documentation](https://docs.medusajs.com/advanced-development/modules/remote-link#cascade-delete-linked-records)\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#removeremotelinkstep","depth":2}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -10527,7 +10527,7 @@ This step creates one or more tax rate rules.
|
||||
|
||||
#### Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRateRuleDTO[]","type":"[TaxRateRuleDTO](../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateRuleDTO","type":"[TaxRateRuleDTO](../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate rule details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"The associated tax rate's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the user\nthat created the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"[TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)","description":"The associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTaxRateRulesStep"/>
|
||||
<TypeList types={[{"name":"TaxRateRuleDTO[]","type":"[TaxRateRuleDTO](../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateRuleDTO","type":"[TaxRateRuleDTO](../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate rule details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"The associated tax rate's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the user\nthat created the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"[TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)","description":"The associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTaxRateRulesStep"/>
|
||||
|
||||
### createTaxRatesStep
|
||||
|
||||
@@ -10539,7 +10539,7 @@ This step creates one or more tax rates.
|
||||
|
||||
#### Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRateDTO[]","type":"[TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateDTO","type":"[TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTaxRatesStep"/>
|
||||
<TypeList types={[{"name":"TaxRateDTO[]","type":"[TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateDTO","type":"[TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTaxRatesStep"/>
|
||||
|
||||
### createTaxRegionsStep
|
||||
|
||||
@@ -10607,11 +10607,11 @@ This step updates tax rates matching the specified filters.
|
||||
|
||||
#### Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateTaxRatesStepInput","type":"[UpdateTaxRatesStepInput](../../core_flows/types/core_flows.UpdateTaxRatesStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find tax rates based on name and code properties through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the tax rates by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string` \\| `string`[]","description":"Filter the tax rates by their associated tax regions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<number> \\| `number`[]","description":"Filter the tax rates by their rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/Line truncated
|
||||
<TypeList types={[{"name":"UpdateTaxRatesStepInput","type":"[UpdateTaxRatesStepInput](../../core_flows/types/core_flows.UpdateTaxRatesStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find tax rates based on name and code properties through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the tax rates by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string` \\| `string`[]","description":"Filter the tax rates by their associated tax regions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<number> \\| `number`[]","description":"Filter the tax rates by their rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/Line truncated
|
||||
|
||||
#### Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRateDTO[]","type":"[TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateDTO","type":"[TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateTaxRatesStep"/>
|
||||
<TypeList types={[{"name":"TaxRateDTO[]","type":"[TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateDTO","type":"[TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateTaxRatesStep"/>
|
||||
|
||||
### createTaxRateRulesWorkflow
|
||||
|
||||
@@ -10627,7 +10627,7 @@ This workflow creates one or more tax rate rules.
|
||||
|
||||
#### Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRateRuleDTO[]","type":"[TaxRateRuleDTO](../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateRuleDTO","type":"[TaxRateRuleDTO](../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate rule details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"The associated tax rate's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the user\nthat created the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"[TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)","description":"The associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTaxRateRulesWorkflow"/>
|
||||
<TypeList types={[{"name":"TaxRateRuleDTO[]","type":"[TaxRateRuleDTO](../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateRuleDTO","type":"[TaxRateRuleDTO](../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate rule details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"The associated tax rate's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the user\nthat created the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"[TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)","description":"The associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTaxRateRulesWorkflow"/>
|
||||
|
||||
### createTaxRatesWorkflow
|
||||
|
||||
@@ -10643,7 +10643,7 @@ This workflow creates one or more tax rates.
|
||||
|
||||
#### Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRateDTO[]","type":"[TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateDTO","type":"[TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTaxRatesWorkflow"/>
|
||||
<TypeList types={[{"name":"TaxRateDTO[]","type":"[TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateDTO","type":"[TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createTaxRatesWorkflow"/>
|
||||
|
||||
### createTaxRegionsWorkflow
|
||||
|
||||
@@ -10711,7 +10711,7 @@ This workflow sets the rules of tax rates.
|
||||
|
||||
#### Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRateRuleDTO[]","type":"[TaxRateRuleDTO](../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateRuleDTO","type":"[TaxRateRuleDTO](../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate rule details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"The associated tax rate's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the user\nthat created the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"[TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)","description":"The associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="setTaxRateRulesWorkflow"/>
|
||||
<TypeList types={[{"name":"TaxRateRuleDTO[]","type":"[TaxRateRuleDTO](../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateRuleDTO","type":"[TaxRateRuleDTO](../../tax/interfaces/tax.TaxRateRuleDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate rule details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate_id","type":"`string`","description":"The associated tax rate's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the user\nthat created the tax rate rule.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"[TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)","description":"The associated tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="setTaxRateRulesWorkflow"/>
|
||||
|
||||
### maybeListTaxRateRuleIdsStep
|
||||
|
||||
@@ -10719,7 +10719,7 @@ This step lists the rules to update in a tax rate update object.
|
||||
|
||||
#### Input
|
||||
|
||||
<TypeList types={[{"name":"MaybeListTaxRateRuleIdsStepInput","type":"[MaybeListTaxRateRuleIdsStepInput](../../core_flows/types/core_flows.MaybeListTaxRateRuleIdsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"tax_rate_ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"update","type":"[UpdateTaxRateDTO](../../tax/interfaces/tax.UpdateTaxRateDTO/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code of the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"Omit<[CreateTaxRateRuleDTO](../../tax/interfaces/tax.CreateTaxRateRuleDTO/page.mdx), \"tax_rate_id\">[]","description":"The rules of the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../tax/types/tax.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the\nuser that created it.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is default.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate is combinable.\n\nLearn more [here](https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../tax/types/tax.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="maybeListTaxRateRuleIdsStep"/>
|
||||
<TypeList types={[{"name":"MaybeListTaxRateRuleIdsStepInput","type":"[MaybeListTaxRateRuleIdsStepInput](../../core_flows/types/core_flows.MaybeListTaxRateRuleIdsStepInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"tax_rate_ids","type":"`string`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"update","type":"[UpdateTaxRateDTO](../../tax/interfaces/tax.UpdateTaxRateDTO/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code of the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rules","type":"Omit<[CreateTaxRateRuleDTO](../../tax/interfaces/tax.CreateTaxRateRuleDTO/page.mdx), \"tax_rate_id\">[]","description":"The rules of the tax rate.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"reference","type":"`string`","description":"The snake-case name of the data model that the tax rule references.\nFor example, `product`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reference_id","type":"`string`","description":"The ID of the record of the data model that the tax rule references.\nFor example, `prod_123`.\n\nLearn more in [this guide](https://docs.medusajs.com/experimental/tax/tax-rates-and-rules/#what-are-tax-rules).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../tax/types/tax.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate rule. For example, the ID of the\nuser that created it.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is default.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate is combinable.\n\nLearn more [here](https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"[MetadataType](../../tax/types/tax.MetadataType/page.mdx)","description":"Holds custom data in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="maybeListTaxRateRuleIdsStep"/>
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -10735,11 +10735,11 @@ This workflow updates tax rates matching specified filters.
|
||||
|
||||
#### Input
|
||||
|
||||
<TypeList types={[{"name":"UpdateTaxRatesWorkflowInput","type":"[UpdateTaxRatesWorkflowInput](../../core_flows/types/core_flows.UpdateTaxRatesWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find tax rates based on name and code properties through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the tax rates by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string` \\| `string`[]","description":"Filter the tax rates by their associated tax regions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<number> \\| `number`[]","description":"Filter the tax rates by their rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTLine truncated
|
||||
<TypeList types={[{"name":"UpdateTaxRatesWorkflowInput","type":"[UpdateTaxRatesWorkflowInput](../../core_flows/types/core_flows.UpdateTaxRatesWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"selector","type":"[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Find tax rates based on name and code properties through this search term.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"The IDs to filter the tax rates by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string` \\| `string`[]","description":"Filter the tax rates by their associated tax regions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`number` \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<number> \\| `number`[]","description":"Filter the tax rates by their rate.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string` \\| `string`[] \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their code.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string` \\| `string`[] \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their creation date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by their update date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `string`[] \\| [OperatorMap](../../tax/types/tax.OperatorMap/page.mdx)<string>","description":"Filter the tax rates by who created it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<T> \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx) \\| [BaseFilterable](../../tax/interfaces/tax.BaseFilterable/page.mdx)<[FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTaxRateProps/page.mdx)>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"([FilterableTaxRateProps](../../tax/interfaces/tax.FilterableTLine truncated
|
||||
|
||||
#### Output
|
||||
|
||||
<TypeList types={[{"name":"TaxRateDTO[]","type":"[TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateDTO","type":"[TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateTaxRatesWorkflow"/>
|
||||
<TypeList types={[{"name":"TaxRateDTO[]","type":"[TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"TaxRateDTO","type":"[TaxRateDTO](../../tax/interfaces/tax.TaxRateDTO/page.mdx)","optional":false,"defaultValue":"","description":"The tax rate details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rate","type":"`null` \\| `number`","description":"The rate to charge.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`null` \\| `string`","description":"The code the tax rate is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the Tax Rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record<string, unknown>`","description":"Holds custom data in key-value pairs.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_region_id","type":"`string`","description":"The ID of the associated tax region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_combinable","type":"`boolean`","description":"Whether the tax rate should be combined with parent rates.\n\nLearn more [here](https://docs.medusajs.com/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_default","type":"`boolean`","description":"Whether the tax rate is the default rate for the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The creation date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The update date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"Who created the tax rate. For example, the ID of the user that created the tax rate.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateTaxRatesWorkflow"/>
|
||||
|
||||
### updateTaxRegionsWorkflow
|
||||
|
||||
@@ -10835,7 +10835,7 @@ This workflow deletes a user and remove the association in the auth identity.
|
||||
|
||||
#### Steps
|
||||
|
||||
<undefined workflow={{"name":"removeUserAccountWorkflow","steps":[{"type":"workflow","name":"deleteUsersWorkflow","description":"This workflow deletes one or more users.","link":"../../core_flows/core_flows.Workflows_User/page.mdx#deleteusersworkflow","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/v2/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"when","condition":"{\n return !!authIdentity\n }","depth":"3","steps":[{"type":"step","name":"setAuthAppMetadataStep","description":"This step sets the `app_metadata` property of an auth identity.","link":"../../core_flows/core_flows.Steps_Auth/page.mdx#setauthappmetadatastep","depth":3}]}]}} />
|
||||
<undefined workflow={{"name":"removeUserAccountWorkflow","steps":[{"type":"workflow","name":"deleteUsersWorkflow","description":"This workflow deletes one or more users.","link":"../../core_flows/core_flows.Workflows_User/page.mdx#deleteusersworkflow","depth":1},{"type":"step","name":"useRemoteQueryStep","description":"This step fetches data across modules using the remote query.\n\nLearn more in the [Remote Query documentation](https://docs.medusajs.com/advanced-development/modules/remote-query).\n\n","link":"../../core_flows/core_flows.Steps_Common/page.mdx#useremotequerystep","depth":2},{"type":"when","condition":"{\n return !!authIdentity\n }","depth":"3","steps":[{"type":"step","name":"setAuthAppMetadataStep","description":"This step sets the `app_metadata` property of an auth identity.","link":"../../core_flows/core_flows.Steps_Auth/page.mdx#setauthappmetadatastep","depth":3}]}]}} />
|
||||
|
||||
#### Input
|
||||
|
||||
|
||||
Reference in new issue
Block a user