Order Workflows

Workflows are a series of queries and actions, called steps, that complete a task. By using workflows, you benefit from features like data consistency and a reliable roll-back mechanism.

When building your customizations, it's highly recommended to re-use Medusa's existing workflows and steps where possible. The following workflows and steps allow you to manage orders and use their features in your Medusa application. They are provided by the @medusajs/medusa/core-flows package.

The following links will take you to the reference documentation for Medusa's Core Workflows.

Workflows#

completeCartWorkflow
acceptOrderTransferWorkflow
addOrderLineItemsWorkflow
archiveOrderWorkflow
beginClaimOrderWorkflow
beginExchangeOrderWorkflow
beginOrderEditOrderWorkflow
beginReceiveReturnWorkflow
beginReturnOrderWorkflow
cancelBeginOrderClaimWorkflow
cancelBeginOrderEditWorkflow
cancelBeginOrderExchangeWorkflow
cancelOrderChangeWorkflow
cancelOrderClaimWorkflow
cancelOrderExchangeWorkflow
cancelOrderFulfillmentWorkflow
cancelOrderTransferRequestWorkflow
cancelOrderWorkflow
cancelReturnReceiveWorkflow
cancelReturnRequestWorkflow
cancelReturnWorkflow
completeOrderWorkflow
confirmClaimRequestWorkflow
confirmExchangeRequestWorkflow
confirmOrderEditRequestWorkflow
confirmReturnReceiveWorkflow
confirmReturnRequestWorkflow
createAndCompleteReturnOrderWorkflow
createClaimShippingMethodWorkflow
createExchangeShippingMethodWorkflow
createOrderChangeWorkflow
createOrderEditShippingMethodWorkflow
createOrderFulfillmentWorkflow
createOrderShipmentWorkflow
createOrderWorkflow
createReturnShippingMethodWorkflow
declineOrderChangeWorkflow
declineOrderTransferRequestWorkflow
deleteOrderChangeActionsWorkflow
deleteOrderChangeWorkflow
dismissItemReturnRequestWorkflow
markPaymentCollectionAsPaid
orderClaimAddNewItemWorkflow
orderClaimItemWorkflow
orderClaimRequestItemReturnWorkflow
orderEditAddNewItemWorkflow
orderEditUpdateItemQuantityWorkflow
orderExchangeAddNewItemWorkflow
orderExchangeRequestItemReturnWorkflow
receiveItemReturnRequestWorkflow
removeAddItemClaimActionWorkflow
removeClaimShippingMethodWorkflow
removeExchangeShippingMethodWorkflow
removeItemClaimActionWorkflow
removeItemExchangeActionWorkflow
removeItemOrderEditActionWorkflow
removeItemReceiveReturnActionWorkflow
removeItemReturnActionWorkflow
removeOrderEditShippingMethodWorkflow
removeReturnShippingMethodWorkflow
requestItemReturnWorkflow
requestOrderEditRequestWorkflow
requestOrderTransferWorkflow
updateClaimAddItemWorkflow
updateClaimItemWorkflow
updateClaimShippingMethodWorkflow
updateExchangeAddItemWorkflow
updateExchangeShippingMethodWorkflow
updateOrderChangeActionsWorkflow
updateOrderChangesWorkflow
updateOrderEditAddItemWorkflow
updateOrderEditItemQuantityWorkflow
updateOrderEditShippingMethodWorkflow
updateOrderTaxLinesWorkflow
updateOrderWorkflow
updateReceiveItemReturnRequestWorkflow
updateRequestItemReturnWorkflow
updateReturnShippingMethodWorkflow
updateReturnWorkflow
capturePaymentWorkflow
processPaymentWorkflow
refundPaymentWorkflow
refundPaymentsWorkflow
createReturnReasonsWorkflow
deleteReturnReasonsWorkflow
updateReturnReasonsWorkflow

Steps#

addOrderTransactionStep
archiveOrdersStep
cancelOrderChangeStep
cancelOrderClaimStep
cancelOrderExchangeStep
cancelOrderFulfillmentStep
cancelOrderReturnStep
cancelOrdersStep
completeOrdersStep
createCompleteReturnStep
createOrderChangeStep
createOrderClaimItemsFromActionsStep
createOrderClaimsStep
createOrderExchangeItemsFromActionsStep
createOrderExchangesStep
createOrderLineItemsStep
createOrdersStep
createReturnsStep
declineOrderChangeStep
deleteClaimsStep
deleteExchangesStep
deleteOrderChangeActionsStep
deleteOrderChangesStep
deleteOrderShippingMethods
deleteReturnsStep
previewOrderChangeStep
registerOrderChangesStep
registerOrderFulfillmentStep
registerOrderShipmentStep
setOrderTaxLinesForItemsStep
updateOrderChangeActionsStep
updateOrderChangesStep
updateOrderShippingMethodsStep
updateOrdersStep
createReturnReasonsStep
deleteReturnReasonStep
updateReturnReasonsStep
Was this page helpful?
Edit this page
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break