fix(core-flows,utils): move fulfillment workflow events (#12338)

Move fulfillment workflow events to be with other workflow events.

Could be considered a breaking change for users using the previously `FulfillmentEvents` variable
This commit is contained in:
Shahed Nasser
2025-05-01 12:11:17 +03:00
committed by GitHub
parent 2bfe936185
commit a53d645f8a
5 changed files with 41 additions and 4 deletions

View File

@@ -107,3 +107,28 @@ export const RegionWorkflowEvents = {
CREATED: "region.created",
DELETED: "region.deleted",
}
/**
* @category Fulfillment
*/
export const FulfillmentWorkflowEvents = {
/**
* Emitted when a shipment is created for an order.
*
* @eventPayload
* {
* id, // the ID of the shipment
* no_notification, // whether to notify the customer
* }
*/
SHIPMENT_CREATED: "shipment.created",
/**
* Emitted when a fulfillment is marked as delivered.
*
* @eventPayload
* {
* id, // the ID of the fulfillment
* }
*/
DELIVERY_CREATED: "delivery.created",
}

View File

@@ -29,6 +29,12 @@ const eventBaseNames: [
export const FulfillmentEvents = {
...buildEventNamesFromEntityName(eventBaseNames, Modules.FULFILLMENT),
/**
* @deprecated use `FulfillmentWorkflowEvents.SHIPMENT_CREATED` instead
*/
SHIPMENT_CREATED: "shipment.created",
/**
* @deprecated use `FulfillmentWorkflowEvents.DELIVERY_CREATED` instead
*/
DELIVERY_CREATED: "delivery.created",
}