Order Module Events Reference

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.

Event NameDescriptionPayload

order.updated

Emitted when an admin user updates an order's details.

{
  id, // The ID of the order
}

order.placed

Emitted when the customer completes a cart and an order is placed.

{
  id, // The ID of the order
}

order.canceled

Emitted when an order is canceled.

{
  id, // The ID of the order
}

order.completed

Emitted when orders are completed.

[{
  id, // The ID of the order
}]

order.archived

Emitted when orders are archived.

[{
  id, // The ID of the order
}]

order.fulfillment_created

Emitted when a fulfillment is created for an order.

{
  order_id, // The ID of the order
  fulfillment_id, // The ID of the fulfillment
}

order.fulfillment_canceled

Emitted when a fulfillment is canceled for an order.

{
  order_id, // The ID of the order
  fulfillment_id, // The ID of the fulfillment
}

order.return_requested

Emitted when a return is requested.

{
  order_id, // The ID of the order
  return_id, // The ID of the return
}

order.return_received

Emitted when a return is received.

{
  order_id, // The ID of the order
  return_id, // The ID of the return
}

order.claim_created

Emitted when a claim is created.

{
  order_id, // The ID of the order
  claim_id, // The ID of the claim
}

order.exchange_created

Emitted when an exchange is created.

{
  order_id, // The ID of the order
  exchange_id, // The ID of the exchange
}

order.transfer_requested

Emitted when an order transfer is requested. This is available from Medusa v2.0.5+.

{
  order_id, // The ID of the order
  exchange_id, // The ID of the exchange
}
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