docs: generate events reference (#12341)
* docs: generate events reference * change link in navbar * fix redirect
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
332e46d1db
commit
70a99a2434
94 files changed
+31164
-18109
No files matched your search
@@ -1,36 +0,0 @@
|
||||
import { Table } from "docs-ui"
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>Event Name</Table.HeaderCell>
|
||||
<Table.HeaderCell>Description</Table.HeaderCell>
|
||||
<Table.HeaderCell className="w-1/3">Payload</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`auth.password_reset`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when a password of a user, customer, or other actor types is reset.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
entity_id, // The user's identifier, such as their email
|
||||
token, // The reset token
|
||||
actor_type // `user`, `customer`, or custom type
|
||||
}
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
@@ -1,11 +0,0 @@
|
||||
import Content from "./_content.mdx"
|
||||
|
||||
export const metadata = {
|
||||
title: `Auth Module Events Reference`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
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.
|
||||
|
||||
<Content />
|
||||
@@ -1,76 +0,0 @@
|
||||
import { Table } from "docs-ui"
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>Event Name</Table.HeaderCell>
|
||||
<Table.HeaderCell>Description</Table.HeaderCell>
|
||||
<Table.HeaderCell className="w-1/3">Payload</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`cart.created`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when a cart is created.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
id, // The ID of the cart
|
||||
}
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`cart.updated`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when a cart is updated. This includes updates to its items, shipping methods, or information.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
id, // The ID of the cart
|
||||
}
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`cart.region_updated`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when the region of a cart is updated.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
id, // The ID of the cart
|
||||
}
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
@@ -1,11 +0,0 @@
|
||||
import Content from "./_content.mdx"
|
||||
|
||||
export const metadata = {
|
||||
title: `Cart Module Events Reference`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
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.
|
||||
|
||||
<Content />
|
||||
@@ -1,76 +0,0 @@
|
||||
import { Table } from "docs-ui"
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>Event Name</Table.HeaderCell>
|
||||
<Table.HeaderCell>Description</Table.HeaderCell>
|
||||
<Table.HeaderCell className="w-1/3">Payload</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`customer.created`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when customers are created.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the customer
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`customer.updated`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when customers are updated.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the customer
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`customer.deleted`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when customers are deleted.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the customer
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
@@ -1,11 +0,0 @@
|
||||
import Content from "./_content.mdx"
|
||||
|
||||
export const metadata = {
|
||||
title: `Customer Module Events Reference`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
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.
|
||||
|
||||
<Content />
|
||||
@@ -1,55 +0,0 @@
|
||||
import { Table } from "docs-ui"
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>Event Name</Table.HeaderCell>
|
||||
<Table.HeaderCell>Description</Table.HeaderCell>
|
||||
<Table.HeaderCell className="w-1/3">Payload</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`shipment.created`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when an admin user creates a shipment.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
id, // The ID of the shipment
|
||||
}
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`delivery.created`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when the admin user marks an order fulfillment as delivered.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
id, // The ID of the fulfillment
|
||||
}
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
@@ -1,11 +0,0 @@
|
||||
import Content from "./_content.mdx"
|
||||
|
||||
export const metadata = {
|
||||
title: `Fulfillment Module Events Reference`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
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.
|
||||
|
||||
<Content />
|
||||
@@ -1,272 +0,0 @@
|
||||
import { Table } from "docs-ui"
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>Event Name</Table.HeaderCell>
|
||||
<Table.HeaderCell>Description</Table.HeaderCell>
|
||||
<Table.HeaderCell className="w-1/3">Payload</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`order.updated`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when an admin user updates an order's details.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
id, // The ID of the order
|
||||
}
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`order.placed`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when the customer completes a cart and an order is placed.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
id, // The ID of the order
|
||||
}
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`order.canceled`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when an order is canceled.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
id, // The ID of the order
|
||||
}
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`order.completed`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when orders are completed.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the order
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`order.archived`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when orders are archived.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the order
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`order.fulfillment_created`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when a fulfillment is created for an order.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
fulfillment_id, // The ID of the fulfillment
|
||||
}
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`order.fulfillment_canceled`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when a fulfillment is canceled for an order.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
fulfillment_id, // The ID of the fulfillment
|
||||
}
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`order.return_requested`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when a return is requested.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
return_id, // The ID of the return
|
||||
}
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`order.return_received`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when a return is received.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
return_id, // The ID of the return
|
||||
}
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`order.claim_created`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when a claim is created.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
claim_id, // The ID of the claim
|
||||
}
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`order.exchange_created`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when an exchange is created.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
exchange_id, // The ID of the exchange
|
||||
}
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`order.transfer_requested`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when an order transfer is requested. This is available from [Medusa v2.0.5+](https://github.com/medusajs/medusa/releases/tag/v2.0.5).
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
order_id, // The ID of the order
|
||||
exchange_id, // The ID of the exchange
|
||||
}
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
@@ -1,11 +0,0 @@
|
||||
import Content from "./_content.mdx"
|
||||
|
||||
export const metadata = {
|
||||
title: `Order Module Events Reference`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
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.
|
||||
|
||||
<Content />
|
||||
@@ -1,55 +0,0 @@
|
||||
import { Table } from "docs-ui"
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>Event Name</Table.HeaderCell>
|
||||
<Table.HeaderCell>Description</Table.HeaderCell>
|
||||
<Table.HeaderCell className="w-1/3">Payload</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`payment.captured`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when a payment is captured.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
id, // The ID of the payment
|
||||
}
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`payment.refunded`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when a payment is refunded.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
id, // The ID of the payment
|
||||
}
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
@@ -1,11 +0,0 @@
|
||||
import Content from "./_content.mdx"
|
||||
|
||||
export const metadata = {
|
||||
title: `Payment Module Events Reference`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
This reference shows all the events emitted by the Medusa application related to the Payment Module. If you use the module outside the Medusa application, these events aren't emitted.
|
||||
|
||||
<Content />
|
||||
@@ -1,76 +0,0 @@
|
||||
import { Table } from "docs-ui"
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>Event Name</Table.HeaderCell>
|
||||
<Table.HeaderCell>Description</Table.HeaderCell>
|
||||
<Table.HeaderCell className="w-1/3">Payload</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`product-category.created`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when product categories are created.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the category
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`product-category.updated`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when product categories are updated.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the category
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`product-category.deleted`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when product categories are deleted.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the category
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
-76
@@ -1,76 +0,0 @@
|
||||
import { Table } from "docs-ui"
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>Event Name</Table.HeaderCell>
|
||||
<Table.HeaderCell>Description</Table.HeaderCell>
|
||||
<Table.HeaderCell className="w-1/3">Payload</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`product-collection.created`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when product collections are created.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the collection
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`product-collection.updated`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when product collections are updated.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the collection
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`product-collection.deleted`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when product collections are deleted.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the collection
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
@@ -1,76 +0,0 @@
|
||||
import { Table } from "docs-ui"
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>Event Name</Table.HeaderCell>
|
||||
<Table.HeaderCell>Description</Table.HeaderCell>
|
||||
<Table.HeaderCell className="w-1/3">Payload</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`product-option.created`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when product options are created.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the option
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`product-option.updated`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when product options are updated.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the option
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`product-option.deleted`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when product options are deleted.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the option
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
@@ -1,76 +0,0 @@
|
||||
import { Table } from "docs-ui"
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>Event Name</Table.HeaderCell>
|
||||
<Table.HeaderCell>Description</Table.HeaderCell>
|
||||
<Table.HeaderCell className="w-1/3">Payload</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`product-tag.created`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when product tags are created.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the tag
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`product-tag.updated`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when product tags are updated.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the tag
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`product-tag.deleted`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when product tags are deleted.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the tag
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
@@ -1,76 +0,0 @@
|
||||
import { Table } from "docs-ui"
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>Event Name</Table.HeaderCell>
|
||||
<Table.HeaderCell>Description</Table.HeaderCell>
|
||||
<Table.HeaderCell className="w-1/3">Payload</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`product-type.created`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when product types are created.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the type
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`product-type.updated`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when product types are updated.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the type
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`product-type.deleted`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when product types are deleted.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the type
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
@@ -1,76 +0,0 @@
|
||||
import { Table } from "docs-ui"
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>Event Name</Table.HeaderCell>
|
||||
<Table.HeaderCell>Description</Table.HeaderCell>
|
||||
<Table.HeaderCell className="w-1/3">Payload</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`product-variant.created`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when product variants are created.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the variant
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`product-variant.updated`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when product variants are updated.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the variant
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`product-variant.deleted`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when product variants are deleted.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the variant
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
@@ -1,76 +0,0 @@
|
||||
import { Table } from "docs-ui"
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>Event Name</Table.HeaderCell>
|
||||
<Table.HeaderCell>Description</Table.HeaderCell>
|
||||
<Table.HeaderCell className="w-1/3">Payload</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`product.created`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when products are created.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the product
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`product.updated`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when products are updated.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the product
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`product.deleted`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when products are deleted.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the product
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
@@ -1,55 +0,0 @@
|
||||
import ProductEvents from "./_content/product.mdx"
|
||||
import ProductCategoryEvents from "./_content/product-category.mdx"
|
||||
import ProductCollectionEvents from "./_content/product-collection.mdx"
|
||||
import ProductOptionEvents from "./_content/product-option.mdx"
|
||||
import ProductTagEvents from "./_content/product-tag.mdx"
|
||||
import ProductTypeEvents from "./_content/product-type.mdx"
|
||||
import ProductVariantEvents from "./_content/product-variant.mdx"
|
||||
|
||||
export const metadata = {
|
||||
title: `Product Module Events Reference`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
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 Events
|
||||
|
||||
<ProductEvents />
|
||||
|
||||
---
|
||||
|
||||
## Product Category Events
|
||||
|
||||
<ProductCategoryEvents />
|
||||
|
||||
---
|
||||
|
||||
## Product Collection Events
|
||||
|
||||
<ProductCollectionEvents />
|
||||
|
||||
---
|
||||
|
||||
## Product Option Events
|
||||
|
||||
<ProductOptionEvents />
|
||||
|
||||
---
|
||||
|
||||
## Product Tag Events
|
||||
|
||||
<ProductTagEvents />
|
||||
|
||||
---
|
||||
|
||||
## Product Type Events
|
||||
|
||||
<ProductTypeEvents />
|
||||
|
||||
---
|
||||
|
||||
## Product Variant Events
|
||||
|
||||
<ProductVariantEvents />
|
||||
@@ -1,76 +0,0 @@
|
||||
import { Table } from "docs-ui"
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>Event Name</Table.HeaderCell>
|
||||
<Table.HeaderCell>Description</Table.HeaderCell>
|
||||
<Table.HeaderCell className="w-1/3">Payload</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`region.created`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when regions are created.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the region
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`region.updated`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when regions are updated.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the region
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`region.deleted`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when regions are deleted.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the region
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
@@ -1,11 +0,0 @@
|
||||
import Content from "./_content.mdx"
|
||||
|
||||
export const metadata = {
|
||||
title: `Region Module Events Reference`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
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.
|
||||
|
||||
<Content />
|
||||
@@ -1,76 +0,0 @@
|
||||
import { Table } from "docs-ui"
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>Event Name</Table.HeaderCell>
|
||||
<Table.HeaderCell>Description</Table.HeaderCell>
|
||||
<Table.HeaderCell className="w-1/3">Payload</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`sales-channel.created`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when sales channels are created.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the sales channel
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`sales-channel.updated`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when sales channels are updated.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the sales channel
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`sales-channel.deleted`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when sales channels are deleted.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the sales channel
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
@@ -1,11 +0,0 @@
|
||||
import Content from "./_content.mdx"
|
||||
|
||||
export const metadata = {
|
||||
title: `Sales Channel Module Events Reference`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
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.
|
||||
|
||||
<Content />
|
||||
@@ -1,97 +0,0 @@
|
||||
import { Table } from "docs-ui"
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>Event Name</Table.HeaderCell>
|
||||
<Table.HeaderCell>Description</Table.HeaderCell>
|
||||
<Table.HeaderCell className="w-1/3">Payload</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`invite.accepted`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when an invite is accepted.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
{
|
||||
id, // The ID of the invite
|
||||
}
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`invite.created`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when invites are created.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the invite
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`invite.deleted`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when invites are deleted.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the invite
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`invite.resent`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when invites are resent.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the invite
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
@@ -1,76 +0,0 @@
|
||||
import { Table } from "docs-ui"
|
||||
|
||||
<Table>
|
||||
<Table.Header>
|
||||
<Table.Row>
|
||||
<Table.HeaderCell>Event Name</Table.HeaderCell>
|
||||
<Table.HeaderCell>Description</Table.HeaderCell>
|
||||
<Table.HeaderCell className="w-1/3">Payload</Table.HeaderCell>
|
||||
</Table.Row>
|
||||
</Table.Header>
|
||||
<Table.Body>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`user.created`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when users are created.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the user
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`user.updated`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when users are updated.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the user
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
<Table.Row>
|
||||
<Table.Cell>
|
||||
|
||||
`user.deleted`
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
Emitted when users are deleted.
|
||||
|
||||
</Table.Cell>
|
||||
<Table.Cell>
|
||||
|
||||
```ts blockStyle="inline"
|
||||
[{
|
||||
id, // The ID of the user
|
||||
}]
|
||||
```
|
||||
|
||||
</Table.Cell>
|
||||
</Table.Row>
|
||||
</Table.Body>
|
||||
</Table>
|
||||
@@ -1,20 +0,0 @@
|
||||
import InviteEvents from "./_content/invite.mdx"
|
||||
import UserEvents from "./_content/user.mdx"
|
||||
|
||||
export const metadata = {
|
||||
title: `User Module Events Reference`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
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.
|
||||
|
||||
## Invite Events
|
||||
|
||||
<InviteEvents />
|
||||
|
||||
---
|
||||
|
||||
## User Events
|
||||
|
||||
<UserEvents />
|
||||
@@ -1,126 +0,0 @@
|
||||
import { Table } from "docs-ui"
|
||||
import AuthEvents from "../commerce-modules/auth/events/_content.mdx"
|
||||
import CartEvents from "../commerce-modules/cart/events/_content.mdx"
|
||||
import CustomerEvents from "../commerce-modules/customer/events/_content.mdx"
|
||||
import FulfillmentEvents from "../commerce-modules/fulfillment/events/_content.mdx"
|
||||
import InviteEvents from "../commerce-modules/user/events/_content/invite.mdx"
|
||||
import OrderEvents from "../commerce-modules/order/events/_content.mdx"
|
||||
import PaymentEvents from "../commerce-modules/payment/events/_content.mdx"
|
||||
import ProductEvents from "../commerce-modules/product/events/_content/product.mdx"
|
||||
import ProductCategoryEvents from "../commerce-modules/product/events/_content/product-category.mdx"
|
||||
import ProductCollectionEvents from "../commerce-modules/product/events/_content/product-collection.mdx"
|
||||
import ProductOptionEvents from "../commerce-modules/product/events/_content/product-option.mdx"
|
||||
import ProductTagEvents from "../commerce-modules/product/events/_content/product-tag.mdx"
|
||||
import ProductTypeEvents from "../commerce-modules/product/events/_content/product-type.mdx"
|
||||
import ProductVariantEvents from "../commerce-modules/product/events/_content/product-variant.mdx"
|
||||
import RegionEvents from "../commerce-modules/region/events/_content.mdx"
|
||||
import SalesChannelEvents from "../commerce-modules/sales-channel/events/_content.mdx"
|
||||
import UserEvents from "../commerce-modules/user/events/_content/user.mdx"
|
||||
|
||||
export const metadata = {
|
||||
title: `Events Reference`,
|
||||
}
|
||||
|
||||
# {metadata.title}
|
||||
|
||||
This documentation page includes the list of all events emitted by [Medusa's workflows](../medusa-workflows-reference/page.mdx).
|
||||
|
||||
## Auth Events
|
||||
|
||||
<AuthEvents />
|
||||
|
||||
---
|
||||
|
||||
## Cart Events
|
||||
|
||||
<CartEvents />
|
||||
|
||||
---
|
||||
|
||||
## Customer Events
|
||||
|
||||
<CustomerEvents />
|
||||
|
||||
---
|
||||
|
||||
## Fulfillment Events
|
||||
|
||||
<FulfillmentEvents />
|
||||
|
||||
---
|
||||
|
||||
## Invite Events
|
||||
|
||||
<InviteEvents />
|
||||
|
||||
---
|
||||
|
||||
## Order Events
|
||||
|
||||
<OrderEvents />
|
||||
|
||||
---
|
||||
|
||||
## Payment Events
|
||||
|
||||
<PaymentEvents />
|
||||
|
||||
---
|
||||
|
||||
## Product Events
|
||||
|
||||
<ProductEvents />
|
||||
|
||||
---
|
||||
|
||||
## Product Category Events
|
||||
|
||||
<ProductCategoryEvents />
|
||||
|
||||
---
|
||||
|
||||
## Product Collection Events
|
||||
|
||||
<ProductCollectionEvents />
|
||||
|
||||
---
|
||||
|
||||
## Product Option Events
|
||||
|
||||
<ProductOptionEvents />
|
||||
|
||||
---
|
||||
|
||||
## Product Tag Events
|
||||
|
||||
<ProductTagEvents />
|
||||
|
||||
---
|
||||
|
||||
## Product Type Events
|
||||
|
||||
<ProductTypeEvents />
|
||||
|
||||
---
|
||||
|
||||
## Product Variant Events
|
||||
|
||||
<ProductVariantEvents />
|
||||
|
||||
---
|
||||
|
||||
## Region Events
|
||||
|
||||
<RegionEvents />
|
||||
|
||||
---
|
||||
|
||||
## Sales Channel Events
|
||||
|
||||
<SalesChannelEvents />
|
||||
|
||||
---
|
||||
|
||||
## User Events
|
||||
|
||||
<UserEvents />
|
||||
@@ -2124,7 +2124,7 @@ You can confirm that the loyalty points were deducted either by sending a reques
|
||||
|
||||
You've now implement a loyalty points system in Medusa. There's still more that you can implement based on your use case:
|
||||
|
||||
- Add loyalty points on registration or other events. Refer to the [Events Reference](../../../events-reference/page.mdx) for a full list of available events you can listen to.
|
||||
- Add loyalty points on registration or other events. Refer to the [Events Reference](/references/events) for a full list of available events you can listen to.
|
||||
- Show the customer their loyalty point usage history. This will require adding another data model in the Loyalty Module that records the usage history. You can create records of that data model when an order that has a loyalty promotion is placed, then customize the storefront to show a new page for loyalty points history.
|
||||
- Customize the Medusa Admin to show a new page or [UI Route](!docs!/learn/fundamentals/admin/ui-routes) for loyalty points information and analytics.
|
||||
|
||||
|
||||
@@ -3116,7 +3116,7 @@ You've now integrated Contentful with Medusa and supported localized product det
|
||||
1. Add support for other data types, such as product categories or collections.
|
||||
- Refer to the data model references for each [Commerce Module](../../../commerce-modules/page.mdx) to figure out the content types you need to create in Contentful.
|
||||
2. Listen to other product events and update the Contentful entries accordingly.
|
||||
- Refer to the [Events Reference](../../../events-reference/page.mdx) for details on all events emitted in Medusa.
|
||||
- Refer to the [Events Reference](/references/events) for details on all events emitted in Medusa.
|
||||
3. Add localization for the entire Next.js Starter Storefront. You can either:
|
||||
- Create content types in Contentful for different sections in the storefront, then use them to retrieve the localized content;
|
||||
- Or use the approaches recommended in the [Next.js documentation](https://nextjs.org/docs/app/building-your-application/routing/internationalization).
|
||||
|
||||
@@ -1385,7 +1385,7 @@ If you check the inbox of the email address you specified in the shipping addres
|
||||
|
||||
## Next Steps
|
||||
|
||||
You've now integrated Medusa with Resend. You can add more templates for other emails, such as customer registration confirmation, user invites, and more. Check out the [Events Reference](../../../events-reference/page.mdx) for a list of all events that the Medusa application emits.
|
||||
You've now integrated Medusa with Resend. You can add more templates for other emails, such as customer registration confirmation, user invites, and more. Check out the [Events Reference](/references/events) for a list of all events that the Medusa application emits.
|
||||
|
||||
If you're new to Medusa, check out the [main documentation](!docs!/learn), where you'll get a more in-depth learning of all the concepts you've used in this guide and more.
|
||||
|
||||
|
||||
@@ -915,7 +915,7 @@ Subscribers are useful when you want to perform an action that isn't an integral
|
||||
|
||||
<Note>
|
||||
|
||||
Learn more about events and subscribers in [this documentation](!docs!/learn/fundamentals/events-and-subscribers). You can also find the list of emitted events in [this reference](../../../events-reference/page.mdx).
|
||||
Learn more about events and subscribers in [this documentation](!docs!/learn/fundamentals/events-and-subscribers). You can also find the list of emitted events in [this reference](/references/events).
|
||||
|
||||
</Note>
|
||||
|
||||
|
||||
@@ -20,7 +20,7 @@ You're free to choose the approach that works for your use case, custom requirem
|
||||
|
||||
<Note title="Tip">
|
||||
|
||||
Refer to the [Events Reference](../../../events-reference/page.mdx) for a full list of events that the Medusa application emits.
|
||||
Refer to the [Events Reference](/references/events) for a full list of events that the Medusa application emits.
|
||||
|
||||
</Note>
|
||||
|
||||
|
||||
@@ -37,7 +37,7 @@ You can use the Notification Module to send notifications when an action is trig
|
||||
|
||||
<Note title="Tip">
|
||||
|
||||
The [Events reference](../../events-reference/page.mdx) shows an extensive list of events triggered for each Commerce Module.
|
||||
The [Events reference](/references/events) shows an extensive list of events triggered for each Commerce Module.
|
||||
|
||||
</Note>
|
||||
|
||||
@@ -92,7 +92,7 @@ To handle events within an order flow and automate actions, create a subscriber.
|
||||
icon: AcademicCapSolid,
|
||||
},
|
||||
{
|
||||
href: "/events-reference",
|
||||
href: "/references/events",
|
||||
title: "Events Reference",
|
||||
text: "Check out triggered events by each Commerce Module.",
|
||||
icon: AcademicCapSolid,
|
||||
@@ -162,7 +162,7 @@ For example, to group customers with over twenty orders:
|
||||
icon: AcademicCapSolid,
|
||||
},
|
||||
{
|
||||
href: "/events-reference",
|
||||
href: "/references/events",
|
||||
title: "Events Reference",
|
||||
text: "Check out triggered events by each Commerce Module.",
|
||||
icon: AcademicCapSolid,
|
||||
|
||||
Reference in new issue
Block a user