Loading...
Was this page helpful?
This documentation provides a reference to the createFulfillmentWorkflow
. It belongs to the @medusajs/medusa/core-flows
package.
This workflow creates a fulfillment, which can be used for an order, return, exchanges, and similar concepts. The workflow is used by the Create Fulfillment Admin API Route.
You can use this workflow within your own customizations or custom workflows, allowing you to create a fulfillment within your custom flows.
CreateFulfillmentWorkflowInput
CreateFulfillmentWorkflowInputlocation_id
stringprovider_id
stringdelivery_address
CreateFulfillmentAddressWorkflowDTOpacked_at
Date | nullOptionalshipped_at
Date | nullOptionalcreated_by
string | nullOptionaldelivered_at
Date | nullOptionalcanceled_at
Date | nullOptionaldata
Record<string, unknown> | nullOptionalshipping_option_id
string | nullOptionalmetadata
Record<string, unknown> | nullOptionalFulfillmentDTO
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 | stringOptional