Loading...
Was this page helpful?
This documentation provides a reference to the createShipmentWorkflow
. It belongs to the @medusajs/medusa/core-flows
package.
This workflow creates shipments for a fulfillment. It's used by the Create Shipment Admin API Route.
You can use this workflow within your own customizations or custom workflows, allowing you to create shipments within your custom flows.
Source CodeCreateShipmentWorkflowInput
CreateShipmentWorkflowInputid
stringmarked_shipped_by
null | stringOptionalFulfillmentDTO
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