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

docs: split events reference across modules (#10711)

Browse Source 
* docs: split events reference across modules

* add lint exceptions
This commit is contained in:
Shahed Nasser
2024-12-24 09:54:51 +02:00
committed by GitHub
parent a4335f2a47
commit fd1afa8bc9
38 changed files with 1647 additions and 1301 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/resources/app/commerce-modules/order/events/_content.mdx
+251
View File
@@ -0,0 +1,251 @@
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.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>
www/apps/resources/app/commerce-modules/order/events/page.mdx
+11
View File
@@ -0,0 +1,11 @@
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 />