Get Started
Product
Resources
Tools & SDKs
Framework
Reference

validateFulfillmentDeliverabilityStep - Medusa Core Workflows Reference

This documentation provides a reference to the validateFulfillmentDeliverabilityStep. It belongs to the @medusajs/medusa/core-flows package.

This step validates that a fulfillment can be marked delivered. If the fulfillment has already been canceled or delivered, the step will throw an error.

Note: You can retrieve a fulfillment's details using Query, or useQueryGraphStep.

Example#

Code
1const data = validateFulfillmentDeliverabilityStep({2  id: "ful_123",3  // other fulfillment data...4})

Input#

FulfillmentDTOFulfillmentDTO

The fulfillment details.

idstring

The ID of the fulfillment.

location_idstring

The associated location's ID.

packed_atnull | Date

The date the fulfillment was packed.

shipped_atnull | Date

The date the fulfillment was shipped.

delivered_atnull | Date

The date the fulfillment was delivered.

canceled_atnull | Date

The date the fulfillment was canceled.

datanull | Record<string, unknown>

The data necessary for the fulfillment provider to process the fulfillment.

provider_idstring

The associated fulfillment provider's ID.

shipping_option_idnull | string

The associated shipping option's ID.

metadatanull | Record<string, unknown>

Holds custom data in key-value pairs.

shipping_optionnull | ShippingOptionDTO

The associated shipping option.

requires_shippingboolean

Flag to indidcate whether shipping is required

providerFulfillmentProviderDTO

The associated fulfillment provider.

delivery_addressFulfillmentAddressDTO

The associated fulfillment address used for delivery.

itemsFulfillmentItemDTO[]

The items of the fulfillment.

labelsFulfillmentLabelDTO[]

The labels of the fulfillment.

created_atDate

The creation date of the fulfillment.

updated_atDate

The update date of the fulfillment.

deleted_atnull | Date

The deletion date of the fulfillment.

marked_shipped_bynull | stringOptional

The id of the user that marked fulfillment as shipped

created_bynull | stringOptional

The id of the user that created the fulfillment

Was this page helpful?