This documentation provides a reference to the createOrderFulfillmentWorkflow
. It belongs to the @medusajs/medusa/core-flows
package.
This workflow creates a fulfillment for an order. It's used by the Create Order Fulfillment Admin API Route.
This workflow has a hook that allows you to perform custom actions on the created fulfillment. For example, you can pass under additional_data
custom data that
allows you to create custom data models linked to the fulfillment.
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around creating a fulfillment.
Source CodeWorkflow hook
Step conditioned by when
View step details
CreateOrderFulfillmentWorkflowInput
CreateOrderFulfillmentWorkflowInputorder_id
stringitems
CreateOrderFulfillmentItem[]created_by
stringOptionalno_notification
booleanOptionallocation_id
null | stringOptionalmetadata
null | Record<string, any>Optionalshipping_option_id
stringOptionalrequires_shipping
booleanOptionaladditional_data
Record<string, unknown>Optionaladditional_data
property in HTTP requests.
Learn more in this documentation.FulfillmentDTO
FulfillmentDTOid
stringlocation_id
stringpacked_at
null | Dateshipped_at
null | Datedelivered_at
null | Datecanceled_at
null | Datedata
null | Record<string, unknown>provider_id
stringshipping_option_id
null | stringmetadata
null | Record<string, unknown>shipping_option
null | ShippingOptionDTOrequires_shipping
booleanprovider
FulfillmentProviderDTOdelivery_address
FulfillmentAddressDTOitems
FulfillmentItemDTO[]labels
FulfillmentLabelDTO[]created_at
Dateupdated_at
Datedeleted_at
null | Datemarked_shipped_by
null | stringOptionalcreated_by
null | stringOptionalHooks allow you to inject custom functionalities into the workflow. You'll receive data from the workflow, as well as additional data sent through an HTTP request.
Learn more about Hooks and Additional Data.
This hook is executed after the fulfillment is created. You can consume this hook to perform custom actions on the created fulfillment.
Handlers consuming this hook accept the following input.
input
inputfulfillment
FulfillmentDTOadditional_data
Record<string, unknown> | undefinedadditional_data
property in HTTP requests.
Learn more in this documentation.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 |
---|---|---|---|
| Emitted when a fulfillment is created for an order. |
|