Back to Medusa

Fulfillment Module Events Reference

www/apps/resources/references/module_events/module_events.Fulfillment/page.mdx

2.14.210.4 KB
Original Source

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.

Fulfillment 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> [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>

<EventHeader headerLvl="3" headerProps={{ id: "shipmentcreated", children: (<>shipment.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="shipment.created" payload={\``ts { id, // the ID of the fulfillment no_notification, // (boolean) whether to notify the customer } ````} />

Emitted when a shipment is created for an order.

Payload

ts
{
  id, // the ID of the fulfillment
  no_notification, // (boolean) whether to notify the customer
}

Workflows Emitting this Event

The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the Store and Admin API references.


<EventHeader headerLvl="3" headerProps={{ id: "deliverycreated", children: (<>delivery.created</>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="delivery.created" payload={\``ts { id, // the ID of the fulfillment } ````} />

Emitted when a fulfillment is marked as delivered.

Payload

ts
{
  id, // the ID of the fulfillment
}

Workflows Emitting this Event

The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the Store and Admin API references.


Shipping Option 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> [shipping-option-type.updated](#shipping-option-typeupdated) <Tooltip text="This event was added in version v2.10.0"><Badge variant="blue">v2.10.0</Badge></Tooltip> </Table.Cell> <Table.Cell> Emitted when shipping option types are updated. </Table.Cell> </Table.Row> <Table.Row> <Table.Cell> [shipping-option-type.created](#shipping-option-typecreated) <Tooltip text="This event was added in version v2.10.0"><Badge variant="blue">v2.10.0</Badge></Tooltip> </Table.Cell> <Table.Cell> Emitted when shipping option types are created. </Table.Cell> </Table.Row> <Table.Row> <Table.Cell> [shipping-option-type.deleted](#shipping-option-typedeleted) <Tooltip text="This event was added in version v2.10.0"><Badge variant="blue">v2.10.0</Badge></Tooltip> </Table.Cell> <Table.Cell> Emitted when shipping option types are deleted. </Table.Cell> </Table.Row> </Table.Body> </Table>

<EventHeader headerLvl="3" headerProps={{ id: "shipping-option-typeupdated", children: (<>shipping-option-type.updated <Tooltip text="This event was added in version v2.10.0"> <Badge variant="blue">v2.10.0</Badge> </Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="shipping-option-type.updated" payload={\``ts { id, // The ID of the shipping option type } ````} />

Emitted when shipping option types are updated.

Payload

ts
{
  id, // The ID of the shipping option type
}

Workflows Emitting this Event

The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the Store and Admin API references.


<EventHeader headerLvl="3" headerProps={{ id: "shipping-option-typecreated", children: (<>shipping-option-type.created <Tooltip text="This event was added in version v2.10.0"> <Badge variant="blue">v2.10.0</Badge> </Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="shipping-option-type.created" payload={\``ts { id, // The ID of the shipping option type } ````} />

Emitted when shipping option types are created.

Payload

ts
{
  id, // The ID of the shipping option type
}

Workflows Emitting this Event

The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the Store and Admin API references.


<EventHeader headerLvl="3" headerProps={{ id: "shipping-option-typedeleted", children: (<>shipping-option-type.deleted <Tooltip text="This event was added in version v2.10.0"> <Badge variant="blue">v2.10.0</Badge> </Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="shipping-option-type.deleted" payload={\``ts { id, // The ID of the shipping option type } ````} />

Emitted when shipping option types are deleted.

Payload

ts
{
  id, // The ID of the shipping option type
}

Workflows Emitting this Event

The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the Store and Admin API references.


Shipping 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> [shipping-option.created](#shipping-optioncreated) <Tooltip text="This event was added in version v2.12.4"><Badge variant="blue">v2.12.4</Badge></Tooltip> </Table.Cell> <Table.Cell> Emitted when shipping options are created. </Table.Cell> </Table.Row> <Table.Row> <Table.Cell> [shipping-option.updated](#shipping-optionupdated) <Tooltip text="This event was added in version v2.12.4"><Badge variant="blue">v2.12.4</Badge></Tooltip> </Table.Cell> <Table.Cell> Emitted when shipping options are updated. </Table.Cell> </Table.Row> <Table.Row> <Table.Cell> [shipping-option.deleted](#shipping-optiondeleted) <Tooltip text="This event was added in version v2.12.4"><Badge variant="blue">v2.12.4</Badge></Tooltip> </Table.Cell> <Table.Cell> Emitted when shipping options are deleted. </Table.Cell> </Table.Row> </Table.Body> </Table>

<EventHeader headerLvl="3" headerProps={{ id: "shipping-optioncreated", children: (<>shipping-option.created <Tooltip text="This event was added in version v2.12.4"> <Badge variant="blue">v2.12.4</Badge> </Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="shipping-option.created" payload={\``ts { id, // The ID of the shipping option } ````} />

Emitted when shipping options are created.

Payload

ts
{
  id, // The ID of the shipping option
}

Workflows Emitting this Event

The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the Store and Admin API references.


<EventHeader headerLvl="3" headerProps={{ id: "shipping-optionupdated", children: (<>shipping-option.updated <Tooltip text="This event was added in version v2.12.4"> <Badge variant="blue">v2.12.4</Badge> </Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="shipping-option.updated" payload={\``ts { id, // The ID of the shipping option } ````} />

Emitted when shipping options are updated.

Payload

ts
{
  id, // The ID of the shipping option
}

Workflows Emitting this Event

The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the Store and Admin API references.


<EventHeader headerLvl="3" headerProps={{ id: "shipping-optiondeleted", children: (<>shipping-option.deleted <Tooltip text="This event was added in version v2.12.4"> <Badge variant="blue">v2.12.4</Badge> </Tooltip></>), className: "flex flex-wrap justify-center gap-docs_0.25" }} eventName="shipping-option.deleted" payload={\``ts { id, // The ID of the shipping option } ````} />

Emitted when shipping options are deleted.

Payload

ts
{
  id, // The ID of the shipping option
}

Workflows Emitting this Event

The following workflows emit this event when they're executed. These workflows are executed by Medusa's API routes. You can also view the events emitted by API routes in the Store and Admin API references.