www/apps/resources/references/modules/events/page.mdx
import { TypeList } from "docs-ui"
This documentation page includes the list of all events emitted by Medusa's workflows.
<EventHeader headerLvl="3" headerProps={{ id: "authpassword_reset", children: (<>auth.password_reset</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="auth.password_reset" payload={\``ts
{
entity_id, // The identifier of the user or customer. For example, an email address.
actor_type, // The type of actor. For example, "customer", "user", or custom.
token, // The generated token.
metadata, // Optional custom metadata passed from the request.
}
````} />
Emitted when a reset password token is generated. You can listen to this event to send a reset password email to the user or customer, for example.
{
entity_id, // The identifier of the user or customer. For example, an email address.
actor_type, // The type of actor. For example, "customer", "user", or custom.
token, // The generated token.
metadata, // Optional custom metadata passed from the request.
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "cartcreated", children: (<>cart.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="cart.created" payload={\``ts
{
id, // The ID of the cart
}
````} />
Emitted when a cart is created.
{
id, // The ID of the cart
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "cartupdated", children: (<>cart.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="cart.updated" payload={\``ts
{
id, // The ID of the cart
}
````} />
Emitted when a cart's details are updated.
{
id, // The ID of the cart
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "cartregion_updated", children: (<>cart.region_updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="cart.region_updated" payload={\``ts
{
id, // The ID of the cart
}
````} />
Emitted when the cart's region is updated. This
event is emitted alongside the cart.updated event.
{
id, // The ID of the cart
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "cartcustomer_transferred", children: (<>cart.customer_transferred
<Tooltip text="This event was added in version v2.8.0">
<Badge variant="blue">v2.8.0</Badge>
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="cart.customer_transferred" payload={\``ts
{
id, // The ID of the cart
customer_id, // The ID of the customer
}
````} />
Emitted when the customer in the cart is transferred.
{
id, // The ID of the cart
customer_id, // The ID of the customer
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "customercreated", children: (<>customer.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="customer.created" payload={\``ts
{
id, // The ID of the customer
}
````} />
Emitted when a customer is created.
{
id, // The ID of the customer
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "customerupdated", children: (<>customer.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="customer.updated" payload={\``ts
{
id, // The ID of the customer
}
````} />
Emitted when a customer is updated.
{
id, // The ID of the customer
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "customerdeleted", children: (<>customer.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="customer.deleted" payload={\``ts
{
id, // The ID of the customer
}
````} />
Emitted when a customer is deleted.
{
id, // The ID of the customer
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "shipmentcreated", children: (<>shipment.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="shipment.created" payload={\``ts
{
id, // the ID of the fulfillment
no_notification, // (boolean) whether to notify the customer
}
````} />
Emitted when a shipment is created for an order.
{
id, // the ID of the fulfillment
no_notification, // (boolean) whether to notify the customer
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "deliverycreated", children: (<>delivery.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="delivery.created" payload={\``ts
{
id, // the ID of the fulfillment
}
````} />
Emitted when a fulfillment is marked as delivered.
{
id, // the ID of the fulfillment
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "inviteaccepted", children: (<>invite.accepted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="invite.accepted" payload={\``ts
{
id, // The ID of the invite
}
````} />
Emitted when an invite is accepted.
{
id, // The ID of the invite
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "invitecreated", children: (<>invite.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="invite.created" payload={\``ts
{
id, // The ID of the invite
}
````} />
Emitted when invites are created. You can listen to this event to send an email to the invited users, for example.
{
id, // The ID of the invite
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "invitedeleted", children: (<>invite.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="invite.deleted" payload={\``ts
{
id, // The ID of the invite
}
````} />
Emitted when invites are deleted.
{
id, // The ID of the invite
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "inviteresent", children: (<>invite.resent</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="invite.resent" payload={\``ts
{
id, // The ID of the invite
}
````} />
Emitted when invites should be resent because their token was refreshed. You can listen to this event to send an email to the invited users, for example.
{
id, // The ID of the invite
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "order-editrequested", children: (<>order-edit.requested
<Tooltip text="This event was added in version v2.8.0">
<Badge variant="blue">v2.8.0</Badge>
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order-edit.requested" payload={\``ts
{
order_id, // The ID of the order
actions, // (array) The actions to edit the order
}
````} />
Emitted when an order edit is requested.
{
order_id, // The ID of the order
actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "order-editconfirmed", children: (<>order-edit.confirmed
<Tooltip text="This event was added in version v2.8.0">
<Badge variant="blue">v2.8.0</Badge>
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order-edit.confirmed" payload={\``ts
{
order_id, // The ID of the order
actions, // (array) The actions to edit the order
}
````} />
Emitted when an order edit request is confirmed.
{
order_id, // The ID of the order
actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "order-editcanceled", children: (<>order-edit.canceled
<Tooltip text="This event was added in version v2.8.0">
<Badge variant="blue">v2.8.0</Badge>
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order-edit.canceled" payload={\``ts
{
order_id, // The ID of the order
actions, // (array) The actions to edit the order
}
````} />
Emitted when an order edit request is canceled.
{
order_id, // The ID of the order
actions, // (array) The [actions](https://docs.medusajs.com/resources/references/fulfillment/interfaces/fulfillment.OrderChangeActionDTO) to edit the order
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "orderupdated", children: (<>order.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.updated" payload={\``ts
{
id, // The ID of the order
}
````} />
Emitted when the details of an order or draft order is updated. This doesn't include updates made by an edit.
{
id, // The ID of the order
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "orderplaced", children: (<>order.placed</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.placed" payload={\``ts
{
id, // The ID of the order
}
````} />
Emitted when an order is placed, or when a draft order is converted to an order.
{
id, // The ID of the order
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "ordercanceled", children: (<>order.canceled</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.canceled" payload={\``ts
{
id, // The ID of the order
}
````} />
Emitted when an order is canceld.
{
id, // The ID of the order
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "ordercompleted", children: (<>order.completed</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.completed" payload={\``ts
{
id, // The ID of the order
}
````} />
Emitted when orders are completed.
{
id, // The ID of the order
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "orderarchived", children: (<>order.archived</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.archived" payload={\``ts
{
id, // The ID of the order
}
````} />
Emitted when an order is archived.
{
id, // The ID of the order
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "orderfulfillment_created", children: (<>order.fulfillment_created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.fulfillment_created" payload={\``ts
{
order_id, // The ID of the order
fulfillment_id, // The ID of the fulfillment
no_notification, // (boolean) Whether to notify the customer
}
````} />
Emitted when a fulfillment is created for an order.
{
order_id, // The ID of the order
fulfillment_id, // The ID of the fulfillment
no_notification, // (boolean) Whether to notify the customer
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "orderfulfillment_canceled", children: (<>order.fulfillment_canceled</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.fulfillment_canceled" payload={\``ts
{
order_id, // The ID of the order
fulfillment_id, // The ID of the fulfillment
no_notification, // (boolean) Whether to notify the customer
}
````} />
Emitted when an order's fulfillment is canceled.
{
order_id, // The ID of the order
fulfillment_id, // The ID of the fulfillment
no_notification, // (boolean) Whether to notify the customer
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "orderreturn_requested", children: (<>order.return_requested</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.return_requested" payload={\``ts
{
order_id, // The ID of the order
return_id, // The ID of the return
}
````} />
Emitted when a return request is confirmed.
{
order_id, // The ID of the order
return_id, // The ID of the return
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "orderreturn_received", children: (<>order.return_received</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.return_received" payload={\``ts
{
order_id, // The ID of the order
return_id, // The ID of the return
}
````} />
Emitted when a return is marked as received.
{
order_id, // The ID of the order
return_id, // The ID of the return
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "orderclaim_created", children: (<>order.claim_created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.claim_created" payload={\``ts
{
order_id, // The ID of the order
claim_id, // The ID of the claim
}
````} />
Emitted when a claim is created for an order.
{
order_id, // The ID of the order
claim_id, // The ID of the claim
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "orderexchange_created", children: (<>order.exchange_created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.exchange_created" payload={\``ts
{
order_id, // The ID of the order
exchange_id, // The ID of the exchange
}
````} />
Emitted when an exchange is created for an order.
{
order_id, // The ID of the order
exchange_id, // The ID of the exchange
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "ordertransfer_requested", children: (<>order.transfer_requested</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="order.transfer_requested" payload={\``ts
{
id, // The ID of the order
order_change_id, // The ID of the order change created for the transfer
}
````} />
Emitted when an order is requested to be transferred to another customer.
{
id, // The ID of the order
order_change_id, // The ID of the order change created for the transfer
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "paymentcaptured", children: (<>payment.captured</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="payment.captured" payload={\``ts
{
id, // the ID of the payment
}
````} />
Emitted when a payment is captured.
{
id, // the ID of the payment
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "paymentrefunded", children: (<>payment.refunded</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="payment.refunded" payload={\``ts
{
id, // the ID of the payment
}
````} />
Emitted when a payment is refunded.
{
id, // the ID of the payment
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "product-categorycreated", children: (<>product-category.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-category.created" payload={\``ts
{
id, // The ID of the product category
}
````} />
Emitted when product categories are created.
{
id, // The ID of the product category
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "product-categoryupdated", children: (<>product-category.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-category.updated" payload={\``ts
{
id, // The ID of the product category
}
````} />
Emitted when product categories are updated.
{
id, // The ID of the product category
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "product-categorydeleted", children: (<>product-category.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-category.deleted" payload={\``ts
{
id, // The ID of the product category
}
````} />
Emitted when product categories are deleted.
{
id, // The ID of the product category
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "product-collectioncreated", children: (<>product-collection.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-collection.created" payload={\``ts
{
id, // The ID of the product collection
}
````} />
Emitted when product collections are created.
{
id, // The ID of the product collection
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "product-collectionupdated", children: (<>product-collection.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-collection.updated" payload={\``ts
{
id, // The ID of the product collection
}
````} />
Emitted when product collections are updated.
{
id, // The ID of the product collection
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "product-collectiondeleted", children: (<>product-collection.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-collection.deleted" payload={\``ts
{
id, // The ID of the product collection
}
````} />
Emitted when product collections are deleted.
{
id, // The ID of the product collection
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "product-optionupdated", children: (<>product-option.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-option.updated" payload={\``ts
{
id, // The ID of the product option
}
````} />
Emitted when product options are updated.
{
id, // The ID of the product option
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "product-optioncreated", children: (<>product-option.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-option.created" payload={\``ts
{
id, // The ID of the product option
}
````} />
Emitted when product options are created.
{
id, // The ID of the product option
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "product-optiondeleted", children: (<>product-option.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-option.deleted" payload={\``ts
{
id, // The ID of the product option
}
````} />
Emitted when product options are deleted.
{
id, // The ID of the product option
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "product-tagupdated", children: (<>product-tag.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-tag.updated" payload={\``ts
{
id, // The ID of the product tag
}
````} />
Emitted when product tags are updated.
{
id, // The ID of the product tag
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "product-tagcreated", children: (<>product-tag.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-tag.created" payload={\``ts
{
id, // The ID of the product tag
}
````} />
Emitted when product tags are created.
{
id, // The ID of the product tag
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "product-tagdeleted", children: (<>product-tag.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-tag.deleted" payload={\``ts
{
id, // The ID of the product tag
}
````} />
Emitted when product tags are deleted.
{
id, // The ID of the product tag
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "product-typeupdated", children: (<>product-type.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-type.updated" payload={\``ts
{
id, // The ID of the product type
}
````} />
Emitted when product types are updated.
{
id, // The ID of the product type
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "product-typecreated", children: (<>product-type.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-type.created" payload={\``ts
{
id, // The ID of the product type
}
````} />
Emitted when product types are created.
{
id, // The ID of the product type
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "product-typedeleted", children: (<>product-type.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-type.deleted" payload={\``ts
{
id, // The ID of the product type
}
````} />
Emitted when product types are deleted.
{
id, // The ID of the product type
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "product-variantupdated", children: (<>product-variant.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-variant.updated" payload={\``ts
{
id, // The ID of the product variant
}
````} />
Emitted when product variants are updated.
{
id, // The ID of the product variant
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "product-variantcreated", children: (<>product-variant.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-variant.created" payload={\``ts
{
id, // The ID of the product variant
}
````} />
Emitted when product variants are created.
{
id, // The ID of the product variant
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "product-variantdeleted", children: (<>product-variant.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product-variant.deleted" payload={\``ts
{
id, // The ID of the product variant
}
````} />
Emitted when product variants are deleted.
{
id, // The ID of the product variant
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "productupdated", children: (<>product.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product.updated" payload={\``ts
{
id, // The ID of the product
}
````} />
Emitted when products are updated.
{
id, // The ID of the product
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "productcreated", children: (<>product.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product.created" payload={\``ts
{
id, // The ID of the product
}
````} />
Emitted when products are created.
{
id, // The ID of the product
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "productdeleted", children: (<>product.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="product.deleted" payload={\``ts
{
id, // The ID of the product
}
````} />
Emitted when products are deleted.
{
id, // The ID of the product
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "regionupdated", children: (<>region.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="region.updated" payload={\``ts
{
id, // The ID of the region
}
````} />
Emitted when regions are updated.
{
id, // The ID of the region
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "regioncreated", children: (<>region.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="region.created" payload={\``ts
{
id, // The ID of the region
}
````} />
Emitted when regions are created.
{
id, // The ID of the region
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "regiondeleted", children: (<>region.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="region.deleted" payload={\``ts
{
id, // The ID of the region
}
````} />
Emitted when regions are deleted.
{
id, // The ID of the region
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "sales-channelcreated", children: (<>sales-channel.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="sales-channel.created" payload={\``ts
{
id, // The ID of the sales channel
}
````} />
Emitted when sales channels are created.
{
id, // The ID of the sales channel
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "sales-channelupdated", children: (<>sales-channel.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="sales-channel.updated" payload={\``ts
{
id, // The ID of the sales channel
}
````} />
Emitted when sales channels are updated.
{
id, // The ID of the sales channel
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "sales-channeldeleted", children: (<>sales-channel.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="sales-channel.deleted" payload={\``ts
{
id, // The ID of the sales channel
}
````} />
Emitted when sales channels are deleted.
{
id, // The ID of the sales channel
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "shipping-option-typeupdated", children: (<>shipping-option-type.updated
<Tooltip text="This event was added in version v2.10.0">
<Badge variant="blue">v2.10.0</Badge>
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="shipping-option-type.updated" payload={\``ts
{
id, // The ID of the shipping option type
}
````} />
Emitted when shipping option types are updated.
{
id, // The ID of the shipping option type
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "shipping-option-typecreated", children: (<>shipping-option-type.created
<Tooltip text="This event was added in version v2.10.0">
<Badge variant="blue">v2.10.0</Badge>
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="shipping-option-type.created" payload={\``ts
{
id, // The ID of the shipping option type
}
````} />
Emitted when shipping option types are created.
{
id, // The ID of the shipping option type
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "shipping-option-typedeleted", children: (<>shipping-option-type.deleted
<Tooltip text="This event was added in version v2.10.0">
<Badge variant="blue">v2.10.0</Badge>
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="shipping-option-type.deleted" payload={\``ts
{
id, // The ID of the shipping option type
}
````} />
Emitted when shipping option types are deleted.
{
id, // The ID of the shipping option type
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "shipping-optioncreated", children: (<>shipping-option.created
<Tooltip text="This event was added in version v2.12.4">
<Badge variant="blue">v2.12.4</Badge>
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="shipping-option.created" payload={\``ts
{
id, // The ID of the shipping option
}
````} />
Emitted when shipping options are created.
{
id, // The ID of the shipping option
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "shipping-optionupdated", children: (<>shipping-option.updated
<Tooltip text="This event was added in version v2.12.4">
<Badge variant="blue">v2.12.4</Badge>
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="shipping-option.updated" payload={\``ts
{
id, // The ID of the shipping option
}
````} />
Emitted when shipping options are updated.
{
id, // The ID of the shipping option
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "shipping-optiondeleted", children: (<>shipping-option.deleted
<Tooltip text="This event was added in version v2.12.4">
<Badge variant="blue">v2.12.4</Badge>
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="shipping-option.deleted" payload={\``ts
{
id, // The ID of the shipping option
}
````} />
Emitted when shipping options are deleted.
{
id, // The ID of the shipping option
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "translationcreated", children: (<>translation.created
<Tooltip text="This event was added in version v2.12.3">
<Badge variant="blue">v2.12.3</Badge>
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="translation.created" payload={\``ts
{
id, // The ID of the translation
}
````} />
Emitted when translations are created.
{
id, // The ID of the translation
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "translationupdated", children: (<>translation.updated
<Tooltip text="This event was added in version v2.12.3">
<Badge variant="blue">v2.12.3</Badge>
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="translation.updated" payload={\``ts
{
id, // The ID of the translation
}
````} />
Emitted when translations are updated.
{
id, // The ID of the translation
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "translationdeleted", children: (<>translation.deleted
<Tooltip text="This event was added in version v2.12.3">
<Badge variant="blue">v2.12.3</Badge>
</Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="translation.deleted" payload={\``ts
{
id, // The ID of the translation
}
````} />
Emitted when translations are deleted.
{
id, // The ID of the translation
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "usercreated", children: (<>user.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="user.created" payload={\``ts
{
id, // The ID of the user
}
````} />
Emitted when users are created.
{
id, // The ID of the user
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "userupdated", children: (<>user.updated</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="user.updated" payload={\``ts
{
id, // The ID of the user
}
````} />
Emitted when users are updated.
{
id, // The ID of the user
}
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.
<EventHeader headerLvl="3" headerProps={{ id: "userdeleted", children: (<>user.deleted</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="user.deleted" payload={\``ts
{
id, // The ID of the user
}
````} />
Emitted when users are deleted.
{
id, // The ID of the user
}
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.