docs: [6/n] generate core-flows reference (#8787)
This commit is contained in:
Shahed Nasser
GitHub
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/cancelBeginOrderClaimWorkflow
|
||||
sidebar_label: cancelBeginOrderClaimWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# cancelBeginOrderClaimWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `cancelBeginOrderClaimWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow cancels a requested order claim.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram 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.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.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.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.Workflows_Order/page.mdx#cancelbeginorderclaimvalidationstep","depth":4},{"type":"step","name":"deleteReturnsStep","description":"This step deletes one or more returns.","link":"../../../../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.Steps_Order/page.mdx#deleteclaimsstep","depth":5},{"type":"step","name":"deleteOrderChangesStep","description":"This step deletes order changes.","link":"../../../../core_flows.Steps_Order/page.mdx#deleteorderchangesstep","depth":5},{"type":"step","name":"deleteOrderShippingMethods","description":"This step deletes order shipping methods.","link":"../../../../core_flows.Steps_Order/page.mdx#deleteordershippingmethods","depth":5}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CancelBeginOrderClaimWorkflowInput","type":"[CancelBeginOrderClaimWorkflowInput](../../../../types/core_flows.CancelBeginOrderClaimWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"claim_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancelBeginOrderClaimWorkflow"/>
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/cancelBeginOrderEditWorkflow
|
||||
sidebar_label: cancelBeginOrderEditWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# cancelBeginOrderEditWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `cancelBeginOrderEditWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow cancels a requested order edit.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram 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.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.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.Workflows_Order/page.mdx#cancelbeginordereditvalidationstep","depth":3},{"type":"step","name":"deleteOrderChangesStep","description":"This step deletes order changes.","link":"../../../../core_flows.Steps_Order/page.mdx#deleteorderchangesstep","depth":4},{"type":"step","name":"deleteOrderShippingMethods","description":"This step deletes order shipping methods.","link":"../../../../core_flows.Steps_Order/page.mdx#deleteordershippingmethods","depth":4}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CancelBeginOrderEditWorkflowInput","type":"[CancelBeginOrderEditWorkflowInput](../../../../types/core_flows.CancelBeginOrderEditWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"order_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancelBeginOrderEditWorkflow"/>
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/cancelBeginOrderExchangeWorkflow
|
||||
sidebar_label: cancelBeginOrderExchangeWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# cancelBeginOrderExchangeWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `cancelBeginOrderExchangeWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow cancels a requested order exchange.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram 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.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.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.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.Workflows_Order/page.mdx#cancelbeginorderexchangevalidationstep","depth":4},{"type":"step","name":"deleteReturnsStep","description":"This step deletes one or more returns.","link":"../../../../core_flows.Steps_Order/page.mdx#deletereturnsstep","depth":5},{"type":"step","name":"deleteExchangesStep","description":"This step deletes one or more exchanges.","link":"../../../../core_flows.Steps_Order/page.mdx#deleteexchangesstep","depth":5},{"type":"step","name":"deleteOrderChangesStep","description":"This step deletes order changes.","link":"../../../../core_flows.Steps_Order/page.mdx#deleteorderchangesstep","depth":5},{"type":"step","name":"deleteOrderShippingMethods","description":"This step deletes order shipping methods.","link":"../../../../core_flows.Steps_Order/page.mdx#deleteordershippingmethods","depth":5}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CancelBeginOrderExchangeWorkflowInput","type":"[CancelBeginOrderExchangeWorkflowInput](../../../../types/core_flows.CancelBeginOrderExchangeWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"exchange_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancelBeginOrderExchangeWorkflow"/>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/cancelOrderChangeWorkflow
|
||||
sidebar_label: cancelOrderChangeWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# cancelOrderChangeWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `cancelOrderChangeWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow cancels an order change.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram workflow={{"name":"cancelOrderChangeWorkflow","steps":[{"type":"step","name":"cancelOrderChangeStep","description":"This step cancels an order change.","link":"../../../../core_flows.Steps_Order/page.mdx#cancelorderchangestep","depth":1}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CancelOrderChangeDTO","type":"[CancelOrderChangeDTO](../../../../../order/interfaces/order.CancelOrderChangeDTO/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the order change.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`string`","description":"The user or customer that canceled the order change.","optional":true,"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="cancelOrderChangeWorkflow"/>
|
||||
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/cancelOrderClaimWorkflow
|
||||
sidebar_label: cancelOrderClaimWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# cancelOrderClaimWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `cancelOrderClaimWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow cancels a confirmed order claim.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram 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.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.Workflows_Order/page.mdx#cancelclaimvalidateorderstep","depth":2},{"type":"step","name":"cancelOrderClaimStep","description":"This step cancels a claim.","link":"../../../../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.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.Workflows_Order/page.mdx#cancelreturnworkflow","depth":4}]}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CancelOrderClaimWorkflowInput","type":"`CancelOrderClaimWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancelOrderClaimWorkflow"/>
|
||||
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/cancelOrderExchangeWorkflow
|
||||
sidebar_label: cancelOrderExchangeWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# cancelOrderExchangeWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `cancelOrderExchangeWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow cancels a confirmed exchange.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram 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.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"cancelExchangeValidateOrder","description":"This step validates that an exchange can be canceled.","link":"../../../../core_flows.Workflows_Order/page.mdx#cancelexchangevalidateorder","depth":2},{"type":"step","name":"cancelOrderExchangeStep","description":"This step cancels an exchange.","link":"../../../../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.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.Workflows_Order/page.mdx#cancelreturnworkflow","depth":4}]}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CancelOrderExchangeWorkflowInput","type":"`CancelOrderExchangeWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancelOrderExchangeWorkflow"/>
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1,46 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/cancelOrderFulfillmentWorkflow
|
||||
sidebar_label: cancelOrderFulfillmentWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# cancelOrderFulfillmentWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `cancelOrderFulfillmentWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow cancels an order's fulfillment.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram 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.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.Workflows_Order/page.mdx#cancelorderfulfillmentvalidateorder","depth":2},{"type":"step","name":"cancelOrderFulfillmentStep","description":"This step cancels an order's fulfillment.","link":"../../../../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.Steps_Inventory/page.mdx#adjustinventorylevelsstep","depth":3},{"type":"workflow","name":"cancelFulfillmentWorkflow","description":"This workflow cancels a fulfillment.","link":"../../../../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
|
||||
|
||||
<TypeList types={[{"name":"CancelOrderFulfillmentWorkflowInput & AdditionalData","type":"`CancelOrderFulfillmentWorkflowInput` & [AdditionalData](../../../../../types/HttpTypes/types/types.HttpTypes.AdditionalData/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"CancelOrderFulfillmentWorkflowInput","type":"`CancelOrderFulfillmentWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]},{"name":"AdditionalData","type":"[AdditionalData](../../../../../types/HttpTypes/types/types.HttpTypes.AdditionalData/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"additional_data","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancelOrderFulfillmentWorkflow"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"undefined","type":"`undefined`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"undefined","type":"`undefined`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancelOrderFulfillmentWorkflow"/>
|
||||
|
||||
## Hooks
|
||||
|
||||
### orderFulfillmentCanceled
|
||||
|
||||
#### Example
|
||||
|
||||
```ts
|
||||
import { cancelOrderFulfillmentWorkflow } from "@medusajs/core-flows"
|
||||
|
||||
cancelOrderFulfillmentWorkflow.hooks.orderFulfillmentCanceled(
|
||||
async (({ fulfillment, additional_data }, { container }) => {
|
||||
//TODO
|
||||
})
|
||||
)
|
||||
```
|
||||
|
||||
#### Input
|
||||
|
||||
Handlers consuming this hook accept the following input.
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fulfillment","type":"[FulfillmentDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The associated location's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"packed_at","type":"`null` \\| `Date`","description":"The date the fulfillment was packed.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`null` \\| `Date`","description":"The date the fulfillment was shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivered_at","type":"`null` \\| `Date`","description":"The date the fulfillment was delivered.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| `Date`","description":"The date the fulfillment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`null` \\| `Record<string, unknown>`","description":"The data necessary for the fulfillment provider to process\nthe fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The associated fulfillment provider's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_option_id","type":"`null` \\| `string`","description":"The associated shipping option's ID.","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":"shipping_option","type":"`null` \\| [ShippingOptionDTO](../../../../../fulfillment/interfaces/fulfillment.ShippingOptionDTO/page.mdx)","description":"The associated shipping option.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProviderDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentProviderDTO/page.mdx)","description":"The associated fulfillment provider.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"delivery_address","type":"[FulfillmentAddressDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentAddressDTO/page.mdx)","description":"The associated fulfillment address used for delivery.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[FulfillmentItemDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentItemDTO/page.mdx)[]","description":"The items of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"labels","type":"[FulfillmentLabelDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentLabelDTO/page.mdx)[]","description":"The labels of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The creation date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The update date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The deletion date of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"additional_data","type":"`Record<string, unknown> | undefined`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="orderFulfillmentCanceled"/>
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/cancelOrderWorkflow
|
||||
sidebar_label: cancelOrderWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# cancelOrderWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `cancelOrderWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow cancels an order.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram 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.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"cancelValidateOrder","description":"This step validates that an order can be canceled.","link":"../../../../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.Steps_Reservation/page.mdx#deletereservationsbylineitemsstep","depth":3},{"type":"step","name":"cancelPaymentStep","description":"This step cancels one or more payments.","link":"../../../../core_flows.Steps_Payment/page.mdx#cancelpaymentstep","depth":3},{"type":"step","name":"cancelOrdersStep","description":"This step cancels one or more orders.","link":"../../../../core_flows.Steps_Order/page.mdx#cancelordersstep","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
|
||||
|
||||
<TypeList types={[{"name":"CancelOrderWorkflowInput","type":"`CancelOrderWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancelOrderWorkflow"/>
|
||||
|
||||
## Output
|
||||
|
||||
<TypeList types={[{"name":"undefined","type":"`undefined`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"undefined","type":"`undefined`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancelOrderWorkflow"/>
|
||||
|
||||
## Hooks
|
||||
|
||||
### orderCanceled
|
||||
|
||||
#### Example
|
||||
|
||||
```ts
|
||||
import { cancelOrderWorkflow } from "@medusajs/core-flows"
|
||||
|
||||
cancelOrderWorkflow.hooks.orderCanceled(
|
||||
async (({ order }, { container }) => {
|
||||
//TODO
|
||||
})
|
||||
)
|
||||
```
|
||||
|
||||
#### Input
|
||||
|
||||
Handlers consuming this hook accept the following input.
|
||||
|
||||
<TypeList types={[{"name":"input","type":"object","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"fulfillments","type":"[FulfillmentDTO](../../../../../fulfillment/interfaces/fulfillment.FulfillmentDTO/page.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="orderCanceled"/>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/cancelReturnReceiveWorkflow
|
||||
sidebar_label: cancelReturnReceiveWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# cancelReturnReceiveWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `cancelReturnReceiveWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow cancels a return receival.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram 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.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.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.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.Workflows_Order/page.mdx#cancelreceivereturnvalidationstep","depth":4},{"type":"step","name":"deleteOrderChangesStep","description":"This step deletes order changes.","link":"../../../../core_flows.Steps_Order/page.mdx#deleteorderchangesstep","depth":5}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancelReturnReceiveWorkflow"/>
|
||||
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/cancelReturnRequestWorkflow
|
||||
sidebar_label: cancelReturnRequestWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# cancelReturnRequestWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `cancelReturnRequestWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow cancels a requested return.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram 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.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.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.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.Workflows_Order/page.mdx#cancelrequestreturnvalidationstep","depth":4},{"type":"step","name":"deleteReturnsStep","description":"This step deletes one or more returns.","link":"../../../../core_flows.Steps_Order/page.mdx#deletereturnsstep","depth":5},{"type":"step","name":"deleteOrderChangesStep","description":"This step deletes order changes.","link":"../../../../core_flows.Steps_Order/page.mdx#deleteorderchangesstep","depth":5},{"type":"step","name":"deleteOrderShippingMethods","description":"This step deletes order shipping methods.","link":"../../../../core_flows.Steps_Order/page.mdx#deleteordershippingmethods","depth":5}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CancelRequestReturnWorkflowInput","type":"[CancelRequestReturnWorkflowInput](../../../../types/core_flows.CancelRequestReturnWorkflowInput/page.mdx)","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"return_id","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancelReturnRequestWorkflow"/>
|
||||
File diff suppressed because one or more lines are too long
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/cancelReturnWorkflow
|
||||
sidebar_label: cancelReturnWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# cancelReturnWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `cancelReturnWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow cancels a return.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram 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.Steps_Common/page.mdx#useremotequerystep","depth":1},{"type":"step","name":"cancelReturnValidateOrder","description":"This step validates that a return can be canceled.","link":"../../../../core_flows.Workflows_Order/page.mdx#cancelreturnvalidateorder","depth":2},{"type":"step","name":"cancelOrderReturnStep","description":"This step cancels a return.","link":"../../../../core_flows.Steps_Order/page.mdx#cancelorderreturnstep","depth":3}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CancelReturnWorkflowInput","type":"`CancelReturnWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="cancelReturnWorkflow"/>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/createAndCompleteReturnOrderWorkflow
|
||||
sidebar_label: createAndCompleteReturnOrderWorkflow
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createAndCompleteReturnOrderWorkflow - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createAndCompleteReturnOrderWorkflow`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This workflow creates and completes a return.
|
||||
|
||||
## Steps
|
||||
|
||||
<WorkflowDiagram 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.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.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.Steps_Common/page.mdx#useremotequerystep","depth":3},{"type":"workflow","name":"createReturnFulfillmentWorkflow","description":"This workflow creates a fulfillment for a return.","link":"../../../../core_flows.Workflows_Fulfillment/page.mdx#createreturnfulfillmentworkflow","depth":4},{"type":"step","name":"createCompleteReturnStep","description":"This step creates a return.","link":"../../../../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.Steps_Common/page.mdx#createremotelinkstep","depth":6}]}} />
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"CreateOrderReturnWorkflowInput","type":"`CreateOrderReturnWorkflowInput`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createAndCompleteReturnOrderWorkflow"/>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -0,0 +1,16 @@
|
||||
---
|
||||
slug: /references/medusa-workflows/createCompleteReturnValidationStep
|
||||
sidebar_label: createCompleteReturnValidationStep
|
||||
---
|
||||
|
||||
import { TypeList, WorkflowDiagram } from "docs-ui"
|
||||
|
||||
# createCompleteReturnValidationStep - Medusa Workflows API Reference
|
||||
|
||||
This documentation provides a reference to the `createCompleteReturnValidationStep`. It belongs to the `@medusajs/core-flows` package.
|
||||
|
||||
This step validates that a return can be created and completed for an order.
|
||||
|
||||
## Input
|
||||
|
||||
<TypeList types={[{"name":"order","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"input","type":"`CreateOrderReturnWorkflowInput`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createCompleteReturnValidationStep"/>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user