docs: generate events reference (#12341)
* docs: generate events reference * change link in navbar * fix redirect
This commit is contained in:
1 parent
332e46d1db
commit
70a99a2434
94 files changed
+31164
-18109
No files matched your search
@@ -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)
|
||||
Reference in new issue
Block a user