docs: generate events reference (#12341)
* docs: generate events reference * change link in navbar * fix redirect
This commit is contained in:
Shahed Nasser
@@ -0,0 +1,55 @@
|
||||
---
|
||||
slug: /references/auth/events
|
||||
sidebar_label: Events Reference
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Auth Module Events Reference
|
||||
|
||||
This reference shows all the events emitted by the Medusa application related to the Auth Module. If you use the module outside the Medusa application, these events aren't emitted.
|
||||
|
||||
## Summary
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>
|
||||
Event
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Description
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[auth.password_reset](#authpassword_reset)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
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.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
|
||||
## `auth.password_reset`
|
||||
|
||||
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.
|
||||
|
||||
### 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.
|
||||
}
|
||||
```
|
||||
|
||||
### Workflows Emitting this Event
|
||||
|
||||
- [generateResetPasswordTokenWorkflow](/references/medusa-workflows/generateResetPasswordTokenWorkflow)
|
||||
@@ -0,0 +1,134 @@
|
||||
---
|
||||
slug: /references/cart/events
|
||||
sidebar_label: Events Reference
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Cart Module Events Reference
|
||||
|
||||
This reference shows all the events emitted by the Medusa application related to the Cart Module. If you use the module outside the Medusa application, these events aren't emitted.
|
||||
|
||||
## Summary
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>
|
||||
Event
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Description
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[cart.created](#cartcreated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when a cart is created.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[cart.updated](#cartupdated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when a cart's details are updated.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[cart.customer_updated](#cartcustomer_updated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when the customer in the cart is updated.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[cart.region_updated](#cartregion_updated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when the cart's region is updated. This
|
||||
event is emitted alongside the CartWorkflowEvents.UPDATED event.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
|
||||
## `cart.created`
|
||||
|
||||
Emitted when a cart is created.
|
||||
|
||||
### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
id, // The ID of the cart
|
||||
}
|
||||
```
|
||||
|
||||
### Workflows Emitting this Event
|
||||
|
||||
- [createCartWorkflow](/references/medusa-workflows/createCartWorkflow)
|
||||
|
||||
---
|
||||
|
||||
## `cart.updated`
|
||||
|
||||
Emitted when a cart's details are updated.
|
||||
|
||||
### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
id, // The ID of the cart
|
||||
}
|
||||
```
|
||||
|
||||
### Workflows Emitting this Event
|
||||
|
||||
- [updateLineItemInCartWorkflow](/references/medusa-workflows/updateLineItemInCartWorkflow)
|
||||
- [updateCartWorkflow](/references/medusa-workflows/updateCartWorkflow)
|
||||
- [addToCartWorkflow](/references/medusa-workflows/addToCartWorkflow)
|
||||
- [addShippingMethodToCartWorkflow](/references/medusa-workflows/addShippingMethodToCartWorkflow)
|
||||
|
||||
---
|
||||
|
||||
## `cart.customer_updated`
|
||||
|
||||
Emitted when the customer in the cart is updated.
|
||||
|
||||
### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
id, // The ID of the cart
|
||||
}
|
||||
```
|
||||
|
||||
### Workflows Emitting this Event
|
||||
|
||||
- [updateCartWorkflow](/references/medusa-workflows/updateCartWorkflow)
|
||||
|
||||
---
|
||||
|
||||
## `cart.region_updated`
|
||||
|
||||
Emitted when the cart's region is updated. This
|
||||
event is emitted alongside the CartWorkflowEvents.UPDATED event.
|
||||
|
||||
### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
id, // The ID of the cart
|
||||
}
|
||||
```
|
||||
|
||||
### Workflows Emitting this Event
|
||||
|
||||
- [updateCartWorkflow](/references/medusa-workflows/updateCartWorkflow)
|
||||
@@ -0,0 +1,105 @@
|
||||
---
|
||||
slug: /references/customer/events
|
||||
sidebar_label: Events Reference
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Customer Module Events Reference
|
||||
|
||||
This reference shows all the events emitted by the Medusa application related to the Customer Module. If you use the module outside the Medusa application, these events aren't emitted.
|
||||
|
||||
## Summary
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>
|
||||
Event
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Description
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[customer.created](#customercreated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when a customer is created.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[customer.updated](#customerupdated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when a customer is updated.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[customer.deleted](#customerdeleted)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when a customer is deleted.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
|
||||
## `customer.created`
|
||||
|
||||
Emitted when a customer is created.
|
||||
|
||||
### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the customer
|
||||
}]
|
||||
```
|
||||
|
||||
### Workflows Emitting this Event
|
||||
|
||||
- [createCustomersWorkflow](/references/medusa-workflows/createCustomersWorkflow)
|
||||
- [createCustomerAccountWorkflow](/references/medusa-workflows/createCustomerAccountWorkflow)
|
||||
|
||||
---
|
||||
|
||||
## `customer.updated`
|
||||
|
||||
Emitted when a customer is updated.
|
||||
|
||||
### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the customer
|
||||
}]
|
||||
```
|
||||
|
||||
### Workflows Emitting this Event
|
||||
|
||||
- [updateCustomersWorkflow](/references/medusa-workflows/updateCustomersWorkflow)
|
||||
|
||||
---
|
||||
|
||||
## `customer.deleted`
|
||||
|
||||
Emitted when a customer is deleted.
|
||||
|
||||
### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the customer
|
||||
}]
|
||||
```
|
||||
|
||||
### Workflows Emitting this Event
|
||||
|
||||
- [deleteCustomersWorkflow](/references/medusa-workflows/deleteCustomersWorkflow)
|
||||
- [removeCustomerAccountWorkflow](/references/medusa-workflows/removeCustomerAccountWorkflow)
|
||||
@@ -0,0 +1,78 @@
|
||||
---
|
||||
slug: /references/fulfillment/events
|
||||
sidebar_label: Events Reference
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Fulfillment Module Events Reference
|
||||
|
||||
This reference shows all the events emitted by the Medusa application related to the Fulfillment Module. If you use the module outside the Medusa application, these events aren't emitted.
|
||||
|
||||
## Summary
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>
|
||||
Event
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Description
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[shipment.created](#shipmentcreated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when a shipment is created for an order.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[delivery.created](#deliverycreated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when a fulfillment is marked as delivered.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
|
||||
## `shipment.created`
|
||||
|
||||
Emitted when a shipment is created for an order.
|
||||
|
||||
### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
id, // the ID of the shipment
|
||||
no_notification, // whether to notify the customer
|
||||
}
|
||||
```
|
||||
|
||||
### Workflows Emitting this Event
|
||||
|
||||
- [createOrderShipmentWorkflow](/references/medusa-workflows/createOrderShipmentWorkflow)
|
||||
|
||||
---
|
||||
|
||||
## `delivery.created`
|
||||
|
||||
Emitted when a fulfillment is marked as delivered.
|
||||
|
||||
### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
id, // the ID of the fulfillment
|
||||
}
|
||||
```
|
||||
|
||||
### Workflows Emitting this Event
|
||||
|
||||
- [markOrderFulfillmentAsDeliveredWorkflow](/references/medusa-workflows/markOrderFulfillmentAsDeliveredWorkflow)
|
||||
@@ -0,0 +1,459 @@
|
||||
---
|
||||
slug: /references/order/events
|
||||
sidebar_label: Events Reference
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# 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.
|
||||
|
||||
## Order Events
|
||||
|
||||
### Summary
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>
|
||||
Event
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Description
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[order.updated](#orderupdated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when the details of an order or draft order is updated. This
|
||||
doesn't include updates made by an edit.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[order.placed](#orderplaced)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when an order is placed, or when a draft order is converted to an
|
||||
order.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[order.canceled](#ordercanceled)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when an order is canceld.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[order.completed](#ordercompleted)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when orders are completed.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[order.archived](#orderarchived)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when an order is archived.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[order.fulfillment_created](#orderfulfillment_created)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when a fulfillment is created for an order.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[order.fulfillment_canceled](#orderfulfillment_canceled)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when an order's fulfillment is canceled.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[order.return_requested](#orderreturn_requested)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when a return request is confirmed.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[order.return_received](#orderreturn_received)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when a return is marked as received.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[order.claim_created](#orderclaim_created)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when a claim is created for an order.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[order.exchange_created](#orderexchange_created)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when an exchange is created for an order.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[order.transfer_requested](#ordertransfer_requested)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when an order is requested to be transferred to
|
||||
another customer.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
|
||||
### `order.updated`
|
||||
|
||||
Emitted when the details of an order or draft order is updated. This
|
||||
doesn't include updates made by an edit.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
id, // The ID of the order
|
||||
}
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [updateOrderWorkflow](/references/medusa-workflows/updateOrderWorkflow)
|
||||
- [updateDraftOrderWorkflow](/references/medusa-workflows/updateDraftOrderWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `order.placed`
|
||||
|
||||
Emitted when an order is placed, or when a draft order is converted to an
|
||||
order.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
id, // The ID of the order
|
||||
}
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [completeCartWorkflow](/references/medusa-workflows/completeCartWorkflow)
|
||||
- [convertDraftOrderWorkflow](/references/medusa-workflows/convertDraftOrderWorkflow)
|
||||
- [processPaymentWorkflow](/references/medusa-workflows/processPaymentWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `order.canceled`
|
||||
|
||||
Emitted when an order is canceld.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
id, // The ID of the order
|
||||
}
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [cancelOrderWorkflow](/references/medusa-workflows/cancelOrderWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `order.completed`
|
||||
|
||||
Emitted when orders are completed.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the order
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [completeOrderWorkflow](/references/medusa-workflows/completeOrderWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `order.archived`
|
||||
|
||||
Emitted when an order is archived.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the order
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [archiveOrderWorkflow](/references/medusa-workflows/archiveOrderWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `order.fulfillment_created`
|
||||
|
||||
Emitted when a fulfillment is created for an order.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
fulfillment_id, // The ID of the fulfillment
|
||||
no_notification, // Whether to notify the customer
|
||||
}
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [createOrderFulfillmentWorkflow](/references/medusa-workflows/createOrderFulfillmentWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `order.fulfillment_canceled`
|
||||
|
||||
Emitted when an order's fulfillment is canceled.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
fulfillment_id, // The ID of the fulfillment
|
||||
no_notification, // Whether to notify the customer
|
||||
}
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [cancelOrderFulfillmentWorkflow](/references/medusa-workflows/cancelOrderFulfillmentWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `order.return_requested`
|
||||
|
||||
Emitted when a return request is confirmed.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
return_id, // The ID of the return
|
||||
}
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [createAndCompleteReturnOrderWorkflow](/references/medusa-workflows/createAndCompleteReturnOrderWorkflow)
|
||||
- [confirmReturnRequestWorkflow](/references/medusa-workflows/confirmReturnRequestWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `order.return_received`
|
||||
|
||||
Emitted when a return is marked as received.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
return_id, // The ID of the return
|
||||
}
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [createAndCompleteReturnOrderWorkflow](/references/medusa-workflows/createAndCompleteReturnOrderWorkflow)
|
||||
- [confirmReturnReceiveWorkflow](/references/medusa-workflows/confirmReturnReceiveWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `order.claim_created`
|
||||
|
||||
Emitted when a claim is created for an order.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
claim_id, // The ID of the claim
|
||||
}
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [confirmClaimRequestWorkflow](/references/medusa-workflows/confirmClaimRequestWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `order.exchange_created`
|
||||
|
||||
Emitted when an exchange is created for an order.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
exchange_id, // The ID of the exchange
|
||||
}
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [confirmExchangeRequestWorkflow](/references/medusa-workflows/confirmExchangeRequestWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `order.transfer_requested`
|
||||
|
||||
Emitted when an order is requested to be transferred to
|
||||
another customer.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
id, // The ID of the order
|
||||
order_change_id, // The ID of the order change created for the transfer
|
||||
}
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [requestOrderTransferWorkflow](/references/medusa-workflows/requestOrderTransferWorkflow)
|
||||
|
||||
---
|
||||
|
||||
## Order Edit Events
|
||||
|
||||
### Summary
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>
|
||||
Event
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Description
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[order-edit.requested](#order-editrequested)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when an order edit is requested.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[order-edit.confirmed](#order-editconfirmed)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when an order edit request is confirmed.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[order-edit.canceled](#order-editcanceled)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when an order edit request is canceled.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
|
||||
### `order-edit.requested`
|
||||
|
||||
Emitted when an order edit is requested.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
actions, // The actions to edit the order
|
||||
}
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [requestOrderEditRequestWorkflow](/references/medusa-workflows/requestOrderEditRequestWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `order-edit.confirmed`
|
||||
|
||||
Emitted when an order edit request is confirmed.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
actions, // The actions to edit the order
|
||||
}
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [confirmOrderEditRequestWorkflow](/references/medusa-workflows/confirmOrderEditRequestWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `order-edit.canceled`
|
||||
|
||||
Emitted when an order edit request is canceled.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
actions, // The actions to edit the order
|
||||
}
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [cancelBeginOrderEditWorkflow](/references/medusa-workflows/cancelBeginOrderEditWorkflow)
|
||||
@@ -0,0 +1,699 @@
|
||||
---
|
||||
slug: /references/product/events
|
||||
sidebar_label: Events Reference
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Product Module Events Reference
|
||||
|
||||
This reference shows all the events emitted by the Medusa application related to the Product Module. If you use the module outside the Medusa application, these events aren't emitted.
|
||||
|
||||
## Product Category Events
|
||||
|
||||
### Summary
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>
|
||||
Event
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Description
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[product-category.created](#product-categorycreated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when product categories are created.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[product-category.updated](#product-categoryupdated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when product categories are updated.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[product-category.deleted](#product-categorydeleted)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when product categories are deleted.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
|
||||
### `product-category.created`
|
||||
|
||||
Emitted when product categories are created.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the product category
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [createProductCategoriesWorkflow](/references/medusa-workflows/createProductCategoriesWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `product-category.updated`
|
||||
|
||||
Emitted when product categories are updated.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the product category
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [updateProductCategoriesWorkflow](/references/medusa-workflows/updateProductCategoriesWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `product-category.deleted`
|
||||
|
||||
Emitted when product categories are deleted.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the product category
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [deleteProductCategoriesWorkflow](/references/medusa-workflows/deleteProductCategoriesWorkflow)
|
||||
|
||||
---
|
||||
|
||||
## Product Collection Events
|
||||
|
||||
### Summary
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>
|
||||
Event
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Description
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[product-collection.created](#product-collectioncreated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when product collections are created.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[product-collection.updated](#product-collectionupdated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when product collections are updated.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[product-collection.deleted](#product-collectiondeleted)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when product collections are deleted.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
|
||||
### `product-collection.created`
|
||||
|
||||
Emitted when product collections are created.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the product collection
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [createCollectionsWorkflow](/references/medusa-workflows/createCollectionsWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `product-collection.updated`
|
||||
|
||||
Emitted when product collections are updated.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the product collection
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [updateCollectionsWorkflow](/references/medusa-workflows/updateCollectionsWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `product-collection.deleted`
|
||||
|
||||
Emitted when product collections are deleted.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the product collection
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [deleteCollectionsWorkflow](/references/medusa-workflows/deleteCollectionsWorkflow)
|
||||
|
||||
---
|
||||
|
||||
## Product Variant Events
|
||||
|
||||
### Summary
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>
|
||||
Event
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Description
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[product-variant.updated](#product-variantupdated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when product variants are updated.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[product-variant.created](#product-variantcreated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when product variants are created.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[product-variant.deleted](#product-variantdeleted)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when product variants are deleted.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
|
||||
### `product-variant.updated`
|
||||
|
||||
Emitted when product variants are updated.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the product variant
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [updateProductVariantsWorkflow](/references/medusa-workflows/updateProductVariantsWorkflow)
|
||||
- [batchProductVariantsWorkflow](/references/medusa-workflows/batchProductVariantsWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `product-variant.created`
|
||||
|
||||
Emitted when product variants are created.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the product variant
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [createProductVariantsWorkflow](/references/medusa-workflows/createProductVariantsWorkflow)
|
||||
- [createProductsWorkflow](/references/medusa-workflows/createProductsWorkflow)
|
||||
- [batchProductVariantsWorkflow](/references/medusa-workflows/batchProductVariantsWorkflow)
|
||||
- [batchProductsWorkflow](/references/medusa-workflows/batchProductsWorkflow)
|
||||
- [importProductsWorkflow](/references/medusa-workflows/importProductsWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `product-variant.deleted`
|
||||
|
||||
Emitted when product variants are deleted.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the product variant
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [deleteProductVariantsWorkflow](/references/medusa-workflows/deleteProductVariantsWorkflow)
|
||||
- [batchProductVariantsWorkflow](/references/medusa-workflows/batchProductVariantsWorkflow)
|
||||
|
||||
---
|
||||
|
||||
## Product Events
|
||||
|
||||
### Summary
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>
|
||||
Event
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Description
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[product.updated](#productupdated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when products are updated.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[product.created](#productcreated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when products are created.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[product.deleted](#productdeleted)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when products are deleted.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
|
||||
### `product.updated`
|
||||
|
||||
Emitted when products are updated.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the product
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [updateProductsWorkflow](/references/medusa-workflows/updateProductsWorkflow)
|
||||
- [batchProductsWorkflow](/references/medusa-workflows/batchProductsWorkflow)
|
||||
- [importProductsWorkflow](/references/medusa-workflows/importProductsWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `product.created`
|
||||
|
||||
Emitted when products are created.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the product
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [createProductsWorkflow](/references/medusa-workflows/createProductsWorkflow)
|
||||
- [batchProductsWorkflow](/references/medusa-workflows/batchProductsWorkflow)
|
||||
- [importProductsWorkflow](/references/medusa-workflows/importProductsWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `product.deleted`
|
||||
|
||||
Emitted when products are deleted.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the product
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [deleteProductsWorkflow](/references/medusa-workflows/deleteProductsWorkflow)
|
||||
- [batchProductsWorkflow](/references/medusa-workflows/batchProductsWorkflow)
|
||||
- [importProductsWorkflow](/references/medusa-workflows/importProductsWorkflow)
|
||||
|
||||
---
|
||||
|
||||
## Product Type Events
|
||||
|
||||
### Summary
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>
|
||||
Event
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Description
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[product-type.updated](#product-typeupdated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when product types are updated.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[product-type.created](#product-typecreated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when product types are created.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[product-type.deleted](#product-typedeleted)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when product types are deleted.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
|
||||
### `product-type.updated`
|
||||
|
||||
Emitted when product types are updated.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the product type
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [updateProductTypesWorkflow](/references/medusa-workflows/updateProductTypesWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `product-type.created`
|
||||
|
||||
Emitted when product types are created.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the product type
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [createProductTypesWorkflow](/references/medusa-workflows/createProductTypesWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `product-type.deleted`
|
||||
|
||||
Emitted when product types are deleted.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the product type
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [deleteProductTypesWorkflow](/references/medusa-workflows/deleteProductTypesWorkflow)
|
||||
|
||||
---
|
||||
|
||||
## Product Tag Events
|
||||
|
||||
### Summary
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>
|
||||
Event
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Description
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[product-tag.updated](#product-tagupdated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when product tags are updated.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[product-tag.created](#product-tagcreated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when product tags are created.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[product-tag.deleted](#product-tagdeleted)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when product tags are deleted.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
|
||||
### `product-tag.updated`
|
||||
|
||||
Emitted when product tags are updated.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the product tag
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [updateProductTagsWorkflow](/references/medusa-workflows/updateProductTagsWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `product-tag.created`
|
||||
|
||||
Emitted when product tags are created.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the product tag
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [createProductTagsWorkflow](/references/medusa-workflows/createProductTagsWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `product-tag.deleted`
|
||||
|
||||
Emitted when product tags are deleted.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the product tag
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [deleteProductTagsWorkflow](/references/medusa-workflows/deleteProductTagsWorkflow)
|
||||
|
||||
---
|
||||
|
||||
## Product Option Events
|
||||
|
||||
### Summary
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>
|
||||
Event
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Description
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[product-option.updated](#product-optionupdated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when product options are updated.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[product-option.created](#product-optioncreated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when product options are created.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[product-option.deleted](#product-optiondeleted)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when product options are deleted.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
|
||||
### `product-option.updated`
|
||||
|
||||
Emitted when product options are updated.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the product option
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [updateProductOptionsWorkflow](/references/medusa-workflows/updateProductOptionsWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `product-option.created`
|
||||
|
||||
Emitted when product options are created.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the product option
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [createProductOptionsWorkflow](/references/medusa-workflows/createProductOptionsWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `product-option.deleted`
|
||||
|
||||
Emitted when product options are deleted.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the product option
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [deleteProductOptionsWorkflow](/references/medusa-workflows/deleteProductOptionsWorkflow)
|
||||
@@ -0,0 +1,103 @@
|
||||
---
|
||||
slug: /references/region/events
|
||||
sidebar_label: Events Reference
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Region Module Events Reference
|
||||
|
||||
This reference shows all the events emitted by the Medusa application related to the Region Module. If you use the module outside the Medusa application, these events aren't emitted.
|
||||
|
||||
## Summary
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>
|
||||
Event
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Description
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[region.updated](#regionupdated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when regions are updated.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[region.created](#regioncreated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when regions are created.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[region.deleted](#regiondeleted)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when regions are deleted.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
|
||||
## `region.updated`
|
||||
|
||||
Emitted when regions are updated.
|
||||
|
||||
### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the region
|
||||
}]
|
||||
```
|
||||
|
||||
### Workflows Emitting this Event
|
||||
|
||||
- [updateRegionsWorkflow](/references/medusa-workflows/updateRegionsWorkflow)
|
||||
|
||||
---
|
||||
|
||||
## `region.created`
|
||||
|
||||
Emitted when regions are created.
|
||||
|
||||
### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the region
|
||||
}]
|
||||
```
|
||||
|
||||
### Workflows Emitting this Event
|
||||
|
||||
- [createRegionsWorkflow](/references/medusa-workflows/createRegionsWorkflow)
|
||||
|
||||
---
|
||||
|
||||
## `region.deleted`
|
||||
|
||||
Emitted when regions are deleted.
|
||||
|
||||
### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the region
|
||||
}]
|
||||
```
|
||||
|
||||
### Workflows Emitting this Event
|
||||
|
||||
- [deleteRegionsWorkflow](/references/medusa-workflows/deleteRegionsWorkflow)
|
||||
@@ -0,0 +1,103 @@
|
||||
---
|
||||
slug: /references/sales-channel/events
|
||||
sidebar_label: Events Reference
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# Sales Channel Module Events Reference
|
||||
|
||||
This reference shows all the events emitted by the Medusa application related to the Sales Channel Module. If you use the module outside the Medusa application, these events aren't emitted.
|
||||
|
||||
## Summary
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>
|
||||
Event
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Description
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[sales-channel.created](#sales-channelcreated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when sales channels are created.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[sales-channel.updated](#sales-channelupdated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when sales channels are updated.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[sales-channel.deleted](#sales-channeldeleted)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when sales channels are deleted.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
|
||||
## `sales-channel.created`
|
||||
|
||||
Emitted when sales channels are created.
|
||||
|
||||
### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the sales channel
|
||||
}]
|
||||
```
|
||||
|
||||
### Workflows Emitting this Event
|
||||
|
||||
- [createSalesChannelsWorkflow](/references/medusa-workflows/createSalesChannelsWorkflow)
|
||||
|
||||
---
|
||||
|
||||
## `sales-channel.updated`
|
||||
|
||||
Emitted when sales channels are updated.
|
||||
|
||||
### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the sales channel
|
||||
}]
|
||||
```
|
||||
|
||||
### Workflows Emitting this Event
|
||||
|
||||
- [updateSalesChannelsWorkflow](/references/medusa-workflows/updateSalesChannelsWorkflow)
|
||||
|
||||
---
|
||||
|
||||
## `sales-channel.deleted`
|
||||
|
||||
Emitted when sales channels are deleted.
|
||||
|
||||
### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the sales channel
|
||||
}]
|
||||
```
|
||||
|
||||
### Workflows Emitting this Event
|
||||
|
||||
- [deleteSalesChannelsWorkflow](/references/medusa-workflows/deleteSalesChannelsWorkflow)
|
||||
@@ -0,0 +1,237 @@
|
||||
---
|
||||
slug: /references/user/events
|
||||
sidebar_label: Events Reference
|
||||
---
|
||||
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# User Module Events Reference
|
||||
|
||||
This reference shows all the events emitted by the Medusa application related to the User Module. If you use the module outside the Medusa application, these events aren't emitted.
|
||||
|
||||
## User Events
|
||||
|
||||
### Summary
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>
|
||||
Event
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Description
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[user.created](#usercreated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when users are created.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[user.updated](#userupdated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when users are updated.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[user.deleted](#userdeleted)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when users are deleted.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
|
||||
### `user.created`
|
||||
|
||||
Emitted when users are created.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the user
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [createUsersWorkflow](/references/medusa-workflows/createUsersWorkflow)
|
||||
- [createUserAccountWorkflow](/references/medusa-workflows/createUserAccountWorkflow)
|
||||
- [acceptInviteWorkflow](/references/medusa-workflows/acceptInviteWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `user.updated`
|
||||
|
||||
Emitted when users are updated.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the user
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [updateUsersWorkflow](/references/medusa-workflows/updateUsersWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `user.deleted`
|
||||
|
||||
Emitted when users are deleted.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the user
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [deleteUsersWorkflow](/references/medusa-workflows/deleteUsersWorkflow)
|
||||
- [removeUserAccountWorkflow](/references/medusa-workflows/removeUserAccountWorkflow)
|
||||
|
||||
---
|
||||
|
||||
## Invite Events
|
||||
|
||||
### Summary
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>
|
||||
Event
|
||||
</Table.HeaderCell>
|
||||
<Table.HeaderCell>
|
||||
Description
|
||||
</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[invite.accepted](#inviteaccepted)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when an invite is accepted.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[invite.created](#invitecreated)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when invites are created. You can listen to this event
|
||||
to send an email to the invited users, for example.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[invite.deleted](#invitedeleted)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
Emitted when invites are deleted.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
[invite.resent](#inviteresent)
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
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.
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
|
||||
### `invite.accepted`
|
||||
|
||||
Emitted when an invite is accepted.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
{
|
||||
id, // The ID of the invite
|
||||
}
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [acceptInviteWorkflow](/references/medusa-workflows/acceptInviteWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `invite.created`
|
||||
|
||||
Emitted when invites are created. You can listen to this event
|
||||
to send an email to the invited users, for example.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the invite
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [createInvitesWorkflow](/references/medusa-workflows/createInvitesWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `invite.deleted`
|
||||
|
||||
Emitted when invites are deleted.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the invite
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [deleteInvitesWorkflow](/references/medusa-workflows/deleteInvitesWorkflow)
|
||||
|
||||
---
|
||||
|
||||
### `invite.resent`
|
||||
|
||||
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.
|
||||
|
||||
#### Payload
|
||||
|
||||
```ts
|
||||
[{
|
||||
id, // The ID of the invite
|
||||
}]
|
||||
```
|
||||
|
||||
#### Workflows Emitting this Event
|
||||
|
||||
- [refreshInviteTokensWorkflow](/references/medusa-workflows/refreshInviteTokensWorkflow)
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,239 @@
|
||||
import { TypeList } from "docs-ui"
|
||||
|
||||
# module-events
|
||||
|
||||
## Namespaces
|
||||
|
||||
- [Auth](../../module_events/module_events.Auth/page.mdx)
|
||||
- [Cart](../../module_events/module_events.Cart/page.mdx)
|
||||
- [Customer](../../module_events/module_events.Customer/page.mdx)
|
||||
- [Fulfillment](../../module_events/module_events.Fulfillment/page.mdx)
|
||||
- [Order](../../module_events/module_events.Order/page.mdx)
|
||||
- [Product](../../module_events/module_events.Product/page.mdx)
|
||||
- [Region](../../module_events/module_events.Region/page.mdx)
|
||||
- [Sales Channel](../../module_events/module_events.Sales_Channel/page.mdx)
|
||||
- [User](../../module_events/module_events.User/page.mdx)
|
||||
|
||||
## Variables
|
||||
|
||||
- [AuthWorkflowEvents](../../module_events/module_events.Auth/page.mdx#authworkflowevents)
|
||||
- [CartWorkflowEvents](../../module_events/module_events.Cart/page.mdx#cartworkflowevents)
|
||||
- [CustomerWorkflowEvents](../../module_events/module_events.Customer/page.mdx#customerworkflowevents)
|
||||
- [FulfillmentWorkflowEvents](../../module_events/module_events.Fulfillment/page.mdx#fulfillmentworkflowevents)
|
||||
- [InviteWorkflowEvents](../../module_events/module_events.User/page.mdx#inviteworkflowevents)
|
||||
- [OrderEditWorkflowEvents](../../module_events/module_events.Order/page.mdx#ordereditworkflowevents)
|
||||
- [OrderWorkflowEvents](../../module_events/module_events.Order/page.mdx#orderworkflowevents)
|
||||
- [ProductCategoryWorkflowEvents](../../module_events/module_events.Product/page.mdx#productcategoryworkflowevents)
|
||||
- [ProductCollectionWorkflowEvents](../../module_events/module_events.Product/page.mdx#productcollectionworkflowevents)
|
||||
- [ProductOptionWorkflowEvents](../../module_events/module_events.Product/page.mdx#productoptionworkflowevents)
|
||||
- [ProductTagWorkflowEvents](../../module_events/module_events.Product/page.mdx#producttagworkflowevents)
|
||||
- [ProductTypeWorkflowEvents](../../module_events/module_events.Product/page.mdx#producttypeworkflowevents)
|
||||
- [ProductVariantWorkflowEvents](../../module_events/module_events.Product/page.mdx#productvariantworkflowevents)
|
||||
- [ProductWorkflowEvents](../../module_events/module_events.Product/page.mdx#productworkflowevents)
|
||||
- [RegionWorkflowEvents](../../module_events/module_events.Region/page.mdx#regionworkflowevents)
|
||||
- [SalesChannelWorkflowEvents](../../module_events/module_events.Sales_Channel/page.mdx#saleschannelworkflowevents)
|
||||
- [UserWorkflowEvents](../../module_events/module_events.User/page.mdx#userworkflowevents)
|
||||
|
||||
## Auth
|
||||
|
||||
### AuthWorkflowEvents
|
||||
|
||||
`Const` **AuthWorkflowEvents**: `Object`
|
||||
|
||||
#### Properties
|
||||
|
||||
<TypeList types={[{"name":"PASSWORD_RESET","type":"`string`","description":"Emitted when a reset password token is generated. You can listen to this event\nto send a reset password email to the user or customer, for example.","optional":false,"defaultValue":"\"auth.password_reset\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="AuthWorkflowEvents"/>
|
||||
|
||||
___
|
||||
|
||||
## Cart
|
||||
|
||||
### CartWorkflowEvents
|
||||
|
||||
`Const` **CartWorkflowEvents**: `Object`
|
||||
|
||||
#### Properties
|
||||
|
||||
<TypeList types={[{"name":"CREATED","type":"`string`","description":"Emitted when a cart is created.","optional":false,"defaultValue":"\"cart.created\"","expandable":false,"children":[]},{"name":"UPDATED","type":"`string`","description":"Emitted when a cart's details are updated.","optional":false,"defaultValue":"\"cart.updated\"","expandable":false,"children":[]},{"name":"CUSTOMER_UPDATED","type":"`string`","description":"Emitted when the customer in the cart is updated.","optional":false,"defaultValue":"\"cart.customer_updated\"","expandable":false,"children":[]},{"name":"REGION_UPDATED","type":"`string`","description":"Emitted when the cart's region is updated. This\nevent is emitted alongside the [CartWorkflowEvents.UPDATED](../../module_events/module_events.Cart/page.mdx#updated) event.","optional":false,"defaultValue":"\"cart.region_updated\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="CartWorkflowEvents"/>
|
||||
|
||||
___
|
||||
|
||||
## Customer
|
||||
|
||||
### CustomerWorkflowEvents
|
||||
|
||||
`Const` **CustomerWorkflowEvents**: `Object`
|
||||
|
||||
#### Properties
|
||||
|
||||
<TypeList types={[{"name":"CREATED","type":"`string`","description":"Emitted when a customer is created.","optional":false,"defaultValue":"\"customer.created\"","expandable":false,"children":[]},{"name":"UPDATED","type":"`string`","description":"Emitted when a customer is updated.","optional":false,"defaultValue":"\"customer.updated\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when a customer is deleted.","optional":false,"defaultValue":"\"customer.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="CustomerWorkflowEvents"/>
|
||||
|
||||
___
|
||||
|
||||
## Fulfillment
|
||||
|
||||
### FulfillmentWorkflowEvents
|
||||
|
||||
`Const` **FulfillmentWorkflowEvents**: `Object`
|
||||
|
||||
#### Properties
|
||||
|
||||
<TypeList types={[{"name":"SHIPMENT_CREATED","type":"`string`","description":"Emitted when a shipment is created for an order.","optional":false,"defaultValue":"\"shipment.created\"","expandable":false,"children":[]},{"name":"DELIVERY_CREATED","type":"`string`","description":"Emitted when a fulfillment is marked as delivered.","optional":false,"defaultValue":"\"delivery.created\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="FulfillmentWorkflowEvents"/>
|
||||
|
||||
___
|
||||
|
||||
## Invite
|
||||
|
||||
### InviteWorkflowEvents
|
||||
|
||||
`Const` **InviteWorkflowEvents**: `Object`
|
||||
|
||||
#### Properties
|
||||
|
||||
<TypeList types={[{"name":"ACCEPTED","type":"`string`","description":"Emitted when an invite is accepted.","optional":false,"defaultValue":"\"invite.accepted\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"Emitted when invites are created. You can listen to this event\nto send an email to the invited users, for example.","optional":false,"defaultValue":"\"invite.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when invites are deleted.","optional":false,"defaultValue":"\"invite.deleted\"","expandable":false,"children":[]},{"name":"RESENT","type":"`string`","description":"Emitted when invites should be resent because their token was\nrefreshed. You can listen to this event to send an email to the invited users,\nfor example.","optional":false,"defaultValue":"\"invite.resent\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="InviteWorkflowEvents"/>
|
||||
|
||||
___
|
||||
|
||||
## Order
|
||||
|
||||
### OrderWorkflowEvents
|
||||
|
||||
`Const` **OrderWorkflowEvents**: `Object`
|
||||
|
||||
#### Properties
|
||||
|
||||
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"Emitted when the details of an order or draft order is updated. This\ndoesn't include updates made by an edit.","optional":false,"defaultValue":"\"order.updated\"","expandable":false,"children":[]},{"name":"PLACED","type":"`string`","description":"Emitted when an order is placed, or when a draft order is converted to an\norder.","optional":false,"defaultValue":"\"order.placed\"","expandable":false,"children":[]},{"name":"CANCELED","type":"`string`","description":"Emitted when an order is canceld.","optional":false,"defaultValue":"\"order.canceled\"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`string`","description":"Emitted when orders are completed.","optional":false,"defaultValue":"\"order.completed\"","expandable":false,"children":[]},{"name":"ARCHIVED","type":"`string`","description":"Emitted when an order is archived.","optional":false,"defaultValue":"\"order.archived\"","expandable":false,"children":[]},{"name":"FULFILLMENT_CREATED","type":"`string`","description":"Emitted when a fulfillment is created for an order.","optional":false,"defaultValue":"\"order.fulfillment_created\"","expandable":false,"children":[]},{"name":"FULFILLMENT_CANCELED","type":"`string`","description":"Emitted when an order's fulfillment is canceled.","optional":false,"defaultValue":"\"order.fulfillment_canceled\"","expandable":false,"children":[]},{"name":"RETURN_REQUESTED","type":"`string`","description":"Emitted when a return request is confirmed.","optional":false,"defaultValue":"\"order.return_requested\"","expandable":false,"children":[]},{"name":"RETURN_RECEIVED","type":"`string`","description":"Emitted when a return is marked as received.","optional":false,"defaultValue":"\"order.return_received\"","expandable":false,"children":[]},{"name":"CLAIM_CREATED","type":"`string`","description":"Emitted when a claim is created for an order.","optional":false,"defaultValue":"\"order.claim_created\"","expandable":false,"children":[]},{"name":"EXCHANGE_CREATED","type":"`string`","description":"Emitted when an exchange is created for an order.","optional":false,"defaultValue":"\"order.exchange_created\"","expandable":false,"children":[]},{"name":"TRANSFER_REQUESTED","type":"`string`","description":"Emitted when an order is requested to be transferred to\nanother customer.","optional":false,"defaultValue":"\"order.transfer_requested\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="OrderWorkflowEvents"/>
|
||||
|
||||
___
|
||||
|
||||
## Order Edit
|
||||
|
||||
### OrderEditWorkflowEvents
|
||||
|
||||
`Const` **OrderEditWorkflowEvents**: `Object`
|
||||
|
||||
#### Properties
|
||||
|
||||
<TypeList types={[{"name":"REQUESTED","type":"`string`","description":"Emitted when an order edit is requested.","optional":false,"defaultValue":"\"order-edit.requested\"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`string`","description":"Emitted when an order edit request is confirmed.","optional":false,"defaultValue":"\"order-edit.confirmed\"","expandable":false,"children":[]},{"name":"CANCELED","type":"`string`","description":"Emitted when an order edit request is canceled.","optional":false,"defaultValue":"\"order-edit.canceled\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="OrderEditWorkflowEvents"/>
|
||||
|
||||
___
|
||||
|
||||
___
|
||||
|
||||
## Product
|
||||
|
||||
### ProductWorkflowEvents
|
||||
|
||||
`Const` **ProductWorkflowEvents**: `Object`
|
||||
|
||||
#### Properties
|
||||
|
||||
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"Emitted when products are updated.","optional":false,"defaultValue":"\"product.updated\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"Emitted when products are created.","optional":false,"defaultValue":"\"product.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when products are deleted.","optional":false,"defaultValue":"\"product.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductWorkflowEvents"/>
|
||||
|
||||
___
|
||||
|
||||
## Product Category
|
||||
|
||||
### ProductCategoryWorkflowEvents
|
||||
|
||||
`Const` **ProductCategoryWorkflowEvents**: `Object`
|
||||
|
||||
#### Properties
|
||||
|
||||
<TypeList types={[{"name":"CREATED","type":"`string`","description":"Emitted when product categories are created.","optional":false,"defaultValue":"\"product-category.created\"","expandable":false,"children":[]},{"name":"UPDATED","type":"`string`","description":"Emitted when product categories are updated.","optional":false,"defaultValue":"\"product-category.updated\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when product categories are deleted.","optional":false,"defaultValue":"\"product-category.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductCategoryWorkflowEvents"/>
|
||||
|
||||
___
|
||||
|
||||
## Product Collection
|
||||
|
||||
### ProductCollectionWorkflowEvents
|
||||
|
||||
`Const` **ProductCollectionWorkflowEvents**: `Object`
|
||||
|
||||
#### Properties
|
||||
|
||||
<TypeList types={[{"name":"CREATED","type":"`string`","description":"Emitted when product collections are created.","optional":false,"defaultValue":"\"product-collection.created\"","expandable":false,"children":[]},{"name":"UPDATED","type":"`string`","description":"Emitted when product collections are updated.","optional":false,"defaultValue":"\"product-collection.updated\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when product collections are deleted.","optional":false,"defaultValue":"\"product-collection.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductCollectionWorkflowEvents"/>
|
||||
|
||||
___
|
||||
|
||||
## Product Option
|
||||
|
||||
### ProductOptionWorkflowEvents
|
||||
|
||||
`Const` **ProductOptionWorkflowEvents**: `Object`
|
||||
|
||||
#### Properties
|
||||
|
||||
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"Emitted when product options are updated.","optional":false,"defaultValue":"\"product-option.updated\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"Emitted when product options are created.","optional":false,"defaultValue":"\"product-option.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when product options are deleted.","optional":false,"defaultValue":"\"product-option.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductOptionWorkflowEvents"/>
|
||||
|
||||
___
|
||||
|
||||
## Product Tag
|
||||
|
||||
### ProductTagWorkflowEvents
|
||||
|
||||
`Const` **ProductTagWorkflowEvents**: `Object`
|
||||
|
||||
#### Properties
|
||||
|
||||
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"Emitted when product tags are updated.","optional":false,"defaultValue":"\"product-tag.updated\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"Emitted when product tags are created.","optional":false,"defaultValue":"\"product-tag.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when product tags are deleted.","optional":false,"defaultValue":"\"product-tag.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductTagWorkflowEvents"/>
|
||||
|
||||
___
|
||||
|
||||
## Product Type
|
||||
|
||||
### ProductTypeWorkflowEvents
|
||||
|
||||
`Const` **ProductTypeWorkflowEvents**: `Object`
|
||||
|
||||
#### Properties
|
||||
|
||||
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"Emitted when product types are updated.","optional":false,"defaultValue":"\"product-type.updated\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"Emitted when product types are created.","optional":false,"defaultValue":"\"product-type.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when product types are deleted.","optional":false,"defaultValue":"\"product-type.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductTypeWorkflowEvents"/>
|
||||
|
||||
___
|
||||
|
||||
## Product Variant
|
||||
|
||||
### ProductVariantWorkflowEvents
|
||||
|
||||
`Const` **ProductVariantWorkflowEvents**: `Object`
|
||||
|
||||
#### Properties
|
||||
|
||||
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"Emitted when product variants are updated.","optional":false,"defaultValue":"\"product-variant.updated\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"Emitted when product variants are created.","optional":false,"defaultValue":"\"product-variant.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when product variants are deleted.","optional":false,"defaultValue":"\"product-variant.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProductVariantWorkflowEvents"/>
|
||||
|
||||
___
|
||||
|
||||
## Region
|
||||
|
||||
### RegionWorkflowEvents
|
||||
|
||||
`Const` **RegionWorkflowEvents**: `Object`
|
||||
|
||||
#### Properties
|
||||
|
||||
<TypeList types={[{"name":"UPDATED","type":"`string`","description":"Emitted when regions are updated.","optional":false,"defaultValue":"\"region.updated\"","expandable":false,"children":[]},{"name":"CREATED","type":"`string`","description":"Emitted when regions are created.","optional":false,"defaultValue":"\"region.created\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when regions are deleted.","optional":false,"defaultValue":"\"region.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="RegionWorkflowEvents"/>
|
||||
|
||||
___
|
||||
|
||||
## Sales Channel
|
||||
|
||||
### SalesChannelWorkflowEvents
|
||||
|
||||
`Const` **SalesChannelWorkflowEvents**: `Object`
|
||||
|
||||
#### Properties
|
||||
|
||||
<TypeList types={[{"name":"CREATED","type":"`string`","description":"Emitted when sales channels are created.","optional":false,"defaultValue":"\"sales-channel.created\"","expandable":false,"children":[]},{"name":"UPDATED","type":"`string`","description":"Emitted when sales channels are updated.","optional":false,"defaultValue":"\"sales-channel.updated\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when sales channels are deleted.","optional":false,"defaultValue":"\"sales-channel.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="SalesChannelWorkflowEvents"/>
|
||||
|
||||
___
|
||||
|
||||
## User
|
||||
|
||||
### UserWorkflowEvents
|
||||
|
||||
`Const` **UserWorkflowEvents**: `Object`
|
||||
|
||||
#### Properties
|
||||
|
||||
<TypeList types={[{"name":"CREATED","type":"`string`","description":"Emitted when users are created.","optional":false,"defaultValue":"\"user.created\"","expandable":false,"children":[]},{"name":"UPDATED","type":"`string`","description":"Emitted when users are updated.","optional":false,"defaultValue":"\"user.updated\"","expandable":false,"children":[]},{"name":"DELETED","type":"`string`","description":"Emitted when users are deleted.","optional":false,"defaultValue":"\"user.deleted\"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="UserWorkflowEvents"/>
|
||||
Reference in New Issue
Block a user