This reference shows all the events emitted by the Medusa application related to the Order Module. If you use the module outside the Medusa application, these events aren't emitted.

Order Events#

Summary#

Event	Description
order.updated	Emitted when the details of an order or draft order is updated. This doesn't include updates made by an edit.
order.placed	Emitted when an order is placed, or when a draft order is converted to an order.
order.canceled	Emitted when an order is canceld.
order.completed	Emitted when orders are completed.
order.archived	Emitted when an order is archived.
order.fulfillment_created	Emitted when a fulfillment is created for an order.
order.fulfillment_canceled	Emitted when an order's fulfillment is canceled.
order.return_requested	Emitted when a return request is confirmed.
order.return_received	Emitted when a return is marked as received.
order.claim_created	Emitted when a claim is created for an order.
order.exchange_created	Emitted when an exchange is created for an order.
order.transfer_requested	Emitted when an order is requested to be transferred to another customer.

Emitted when the details of an order or draft order is updated. This doesn't include updates made by an edit.

Payload

Code
1{2  id, // The ID of the order3}

Workflows Emitting this Event

The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the Store and Admin API references.

• updateOrderWorkflow
• updateDraftOrderWorkflow

---

Emitted when an order is placed, or when a draft order is converted to an order.

Payload

Code
1{2  id, // The ID of the order3}

Workflows Emitting this Event

The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the Store and Admin API references.

• convertDraftOrderWorkflow
• completeCartWorkflow
• processPaymentWorkflow

---

Emitted when an order is canceld.

Payload

Code
1{2  id, // The ID of the order3}

Workflows Emitting this Event

The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the Store and Admin API references.

• cancelOrderWorkflow

---

Emitted when orders are completed.

Payload

Code
1[{2  id, // The ID of the order3}]

Workflows Emitting this Event

The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the Store and Admin API references.

• completeOrderWorkflow

---

Emitted when an order is archived.

Payload

Code
1[{2  id, // The ID of the order3}]

Workflows Emitting this Event

The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the Store and Admin API references.

• archiveOrderWorkflow

---

Emitted when a fulfillment is created for an order.

Payload

Code
1{2  order_id, // The ID of the order3  fulfillment_id, // The ID of the fulfillment4  no_notification, // (boolean) Whether to notify the customer5}

Workflows Emitting this Event

The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the Store and Admin API references.

• createOrderFulfillmentWorkflow

---

Emitted when an order's fulfillment is canceled.

Payload

Code
1{2  order_id, // The ID of the order3  fulfillment_id, // The ID of the fulfillment4  no_notification, // (boolean) Whether to notify the customer5}

Workflows Emitting this Event

The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the Store and Admin API references.

• cancelOrderFulfillmentWorkflow

---

Emitted when a return request is confirmed.

Payload

Code
1{2  order_id, // The ID of the order3  return_id, // The ID of the return4}

Workflows Emitting this Event

The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the Store and Admin API references.

• createAndCompleteReturnOrderWorkflow
• confirmReturnRequestWorkflow

---

Emitted when a return is marked as received.

Payload

Code
1{2  order_id, // The ID of the order3  return_id, // The ID of the return4}

Workflows Emitting this Event

The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the Store and Admin API references.

• createAndCompleteReturnOrderWorkflow
• confirmReturnReceiveWorkflow

---

Emitted when a claim is created for an order.

Payload

Code
1{2  order_id, // The ID of the order3  claim_id, // The ID of the claim4}

Workflows Emitting this Event

The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the Store and Admin API references.

• confirmClaimRequestWorkflow

---

Emitted when an exchange is created for an order.

Payload

Code
1{2  order_id, // The ID of the order3  exchange_id, // The ID of the exchange4}

Workflows Emitting this Event

The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the Store and Admin API references.

• confirmExchangeRequestWorkflow

---

Emitted when an order is requested to be transferred to another customer.

Payload

Code
1{2  id, // The ID of the order3  order_change_id, // The ID of the order change created for the transfer4}

Workflows Emitting this Event

The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the Store and Admin API references.

• requestOrderTransferWorkflow

---

Order Edit Events#

Summary#

Event	Description
order-edit.requested v2.8.0	Emitted when an order edit is requested.
order-edit.confirmed v2.8.0	Emitted when an order edit request is confirmed.
order-edit.canceled v2.8.0	Emitted when an order edit request is canceled.

Emitted when an order edit is requested.

Payload

Code
1{2  order_id, // The ID of the order3  actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order4}

Workflows Emitting this Event

The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the Store and Admin API references.

• requestOrderEditRequestWorkflow

---

Emitted when an order edit request is confirmed.

Payload

Code
1{2  order_id, // The ID of the order3  actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order4}

Workflows Emitting this Event

The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the Store and Admin API references.

• confirmOrderEditRequestWorkflow

---

Emitted when an order edit request is canceled.

Payload

Code
1{2  order_id, // The ID of the order3  actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order4}

Workflows Emitting this Event

The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the Store and Admin API references.

• cancelBeginOrderEditWorkflow