- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Menu
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
createShipmentWorkflow - Medusa Core Workflows Reference
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 CodeExamples#
Steps#
Input#
CreateShipmentWorkflowInputCreateShipmentWorkflowInput
CreateShipmentWorkflowInputCreateShipmentWorkflowInputidstringThe ID of the fulfillment
idstringThe labels associated with the fulfillment.
marked_shipped_bynull | stringOptionalThe id of the user that marked fulfillment as shipped
marked_shipped_bynull | stringOptionalOutput#
FulfillmentDTOFulfillmentDTOThe fulfillment details.
FulfillmentDTOFulfillmentDTOidstringThe ID of the fulfillment.
idstringlocation_idstringThe associated location's ID.
location_idstringpacked_atnull | DateThe date the fulfillment was packed.
packed_atnull | Dateshipped_atnull | DateThe date the fulfillment was shipped.
shipped_atnull | Datedelivered_atnull | DateThe date the fulfillment was delivered.
delivered_atnull | Datecanceled_atnull | DateThe date the fulfillment was canceled.
canceled_atnull | Datedatanull | Record<string, unknown>The data necessary for the fulfillment provider to process
the fulfillment.
datanull | Record<string, unknown>provider_idstringThe associated fulfillment provider's ID.
provider_idstringshipping_option_idnull | stringThe associated shipping option's ID.
shipping_option_idnull | stringmetadatanull | Record<string, unknown>Holds custom data in key-value pairs.
metadatanull | Record<string, unknown>shipping_optionnull | ShippingOptionDTOThe associated shipping option.
shipping_optionnull | ShippingOptionDTOrequires_shippingbooleanFlag to indidcate whether shipping is required
requires_shippingbooleanproviderFulfillmentProviderDTOThe associated fulfillment provider.
providerFulfillmentProviderDTOdelivery_addressFulfillmentAddressDTOThe associated fulfillment address used for delivery.
delivery_addressFulfillmentAddressDTOitemsFulfillmentItemDTO[]The items of the fulfillment.
itemsFulfillmentItemDTO[]labelsFulfillmentLabelDTO[]The labels of the fulfillment.
labelsFulfillmentLabelDTO[]created_atDateThe creation date of the fulfillment.
created_atDateupdated_atDateThe update date of the fulfillment.
updated_atDatedeleted_atnull | DateThe deletion date of the fulfillment.
deleted_atnull | Datemarked_shipped_bynull | stringOptionalThe id of the user that marked fulfillment as shipped
marked_shipped_bynull | stringOptionalcreated_bynull | stringOptionalThe id of the user that created the fulfillment
created_bynull | stringOptionalWas this page helpful?