asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: update list of events (#10308)

Browse Source
This commit is contained in:
Shahed Nasser
2024-11-27 11:57:11 +02:00
committed by GitHub
parent 01def8e9e4
commit cc79f21c91
1 changed files with 297 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

304
www/apps/resources/app/events-reference/page.mdx
View File

@@ -6,13 +6,7 @@ export const metadata = {
# {metadata.title}
This documentation page includes the list of all events emitted by Medusa's workflows.
<Note type="soon" title="In Development">
Events are still in development and may change.
</Note>
This documentation page includes the list of all events emitted by [Medusa's workflows](../medusa-workflows-reference/page.mdx).
## Auth Events
@@ -52,6 +46,85 @@ Events are still in development and may change.
---
## Cart Events
<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 customer
}
```
</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 customer
}
```
</Table.Cell>
</Table.Row>
</Table.Body>
</Table>
---
## Customer Events
<Table>
@@ -259,6 +332,223 @@ Events are still in development and may change.
{
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>