markOrderFulfillmentAsDeliveredWorkflow - Medusa Core Workflows Reference

This documentation provides a reference to the markOrderFulfillmentAsDeliveredWorkflow. It belongs to the @medusajs/medusa/core-flows package.

This workflow marks a fulfillment in an order as delivered. It's used by the Mark Fulfillment as Delivered Admin API Route.

You can use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around marking a fulfillment as delivered.

Source Code

Examples#

Steps#

Input#

MarkOrderFulfillmentAsDeliveredWorkflowInputMarkOrderFulfillmentAsDeliveredWorkflowInput
The details to mark a fulfillment in an order as delivered.
orderIdstring
The ID of the order to mark the fulfillment as delivered in.
fulfillmentIdstring
The ID of the fulfillment to mark as delivered.

Emitted Events#

This section lists the events that are either triggered by the emitEventStep in the workflow, or by another workflow executed within this workflow.

You can listen to these events in a subscriber, as explained in the Subscribers documentation.

Event

Description

Payload

Action

delivery.created

Emitted when a fulfillment is marked as delivered.

{
  id, // the ID of the fulfillment
}
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break