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# acceptOrderTransferWorkflow
addOrderLineItemsWorkflow
beginExchangeOrderWorkflow
beginOrderEditOrderWorkflow
beginReceiveReturnWorkflow
cancelBeginOrderClaimWorkflow
cancelBeginOrderEditWorkflow
cancelBeginOrderExchangeWorkflow
cancelOrderChangeWorkflow
cancelOrderExchangeWorkflow
cancelOrderFulfillmentWorkflow
cancelOrderTransferRequestWorkflow
cancelReturnReceiveWorkflow
cancelReturnRequestWorkflow
confirmClaimRequestWorkflow
confirmExchangeRequestWorkflow
confirmOrderEditRequestWorkflow
confirmReturnReceiveWorkflow
confirmReturnRequestWorkflow
createAndCompleteReturnOrderWorkflow
createClaimShippingMethodWorkflow
createExchangeShippingMethodWorkflow
createOrderChangeWorkflow
createOrderEditShippingMethodWorkflow
createOrderFulfillmentWorkflow
createOrderShipmentWorkflow
createReturnShippingMethodWorkflow
declineOrderChangeWorkflow
declineOrderTransferRequestWorkflow
deleteOrderChangeActionsWorkflow
deleteOrderChangeWorkflow
dismissItemReturnRequestWorkflow
markPaymentCollectionAsPaid
orderClaimAddNewItemWorkflow
orderClaimRequestItemReturnWorkflow
orderEditAddNewItemWorkflow
orderEditUpdateItemQuantityWorkflow
orderExchangeAddNewItemWorkflow
orderExchangeRequestItemReturnWorkflow
receiveItemReturnRequestWorkflow
removeAddItemClaimActionWorkflow
removeClaimShippingMethodWorkflow
removeExchangeShippingMethodWorkflow
removeItemClaimActionWorkflow
removeItemExchangeActionWorkflow
removeItemOrderEditActionWorkflow
removeItemReceiveReturnActionWorkflow
removeItemReturnActionWorkflow
removeOrderEditShippingMethodWorkflow
removeReturnShippingMethodWorkflow
requestItemReturnWorkflow
requestOrderEditRequestWorkflow
requestOrderTransferWorkflow
updateClaimAddItemWorkflow
updateClaimShippingMethodWorkflow
updateExchangeAddItemWorkflow
updateExchangeShippingMethodWorkflow
updateOrderChangeActionsWorkflow
updateOrderChangesWorkflow
updateOrderEditAddItemWorkflow
updateOrderEditItemQuantityWorkflow
updateOrderEditShippingMethodWorkflow
updateOrderTaxLinesWorkflow
updateReceiveItemReturnRequestWorkflow
updateRequestItemReturnWorkflow
updateReturnShippingMethodWorkflow
createReturnReasonsWorkflow
deleteReturnReasonsWorkflow
updateReturnReasonsWorkflow
Steps# cancelOrderFulfillmentStep
createOrderClaimItemsFromActionsStep
createOrderExchangeItemsFromActionsStep
deleteOrderChangeActionsStep
deleteOrderShippingMethods
registerOrderFulfillmentStep
registerOrderShipmentStep
setOrderTaxLinesForItemsStep
updateOrderChangeActionsStep
updateOrderShippingMethodsStep
Was this page helpful? It was helpful It wasn't helpful Report Issue
Edit this page