- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Menu
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
updateFulfillmentWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the updateFulfillmentWorkflow. It belongs to the @medusajs/medusa/core-flows package.
This workflow updates a fulfillment. It's used by other workflows that update a fulfillment, such as markFulfillmentAsDeliveredWorkflow.
You can use this workflow within your own customizations or custom workflows, allowing you to update a fulfillment within your custom flows.
Source CodeExamples#
Steps#
Workflow Hook
Step conditioned by when
Input#
UpdateFulfillmentWorkflowInputUpdateFulfillmentWorkflowInput
UpdateFulfillmentWorkflowInputUpdateFulfillmentWorkflowInputidstringThe ID of the fulfillment
idstringlocation_idstringOptionalThe associated location's ID.
location_idstringOptionalpacked_atnull | DateOptionalThe date the fulfillment was packed.
packed_atnull | DateOptionalshipped_atnull | DateOptionalThe date the fulfillment was shipped.
shipped_atnull | DateOptionalmarked_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 | stringOptionaldelivered_atnull | DateOptionalThe date the fulfillment was delivered.
delivered_atnull | DateOptionaldatanull | Record<string, unknown>OptionalThe data necessary for the associated fulfillment provider to process the fulfillment.
datanull | Record<string, unknown>Optionalmetadatanull | Record<string, unknown>OptionalHolds custom data in key-value pairs.
metadatanull | Record<string, unknown>OptionalOutput#
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?