createShipmentValidateOrder - Medusa Core Workflows Reference

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

This step validates that a shipment can be created for an order. If the order is cancelled, the items don't exist in the order, or the fulfillment doesn't exist in the order, the step will throw an error.

NoteYou can retrieve an order's details using Query, or useQueryGraphStep.

Example#

Code
1const data = createShipmentValidateOrder({2  order: {3    id: "order_123",4    // other order details...5  },6  input: {7    order_id: "order_123",8    fulfillment_id: "ful_123",9    items: [10      {11        id: "orli_123",12        quantity: 113      }14    ]15  }16})

Input#

CreateShipmentValidateOrderStepInputCreateShipmentValidateOrderStepInput
The data to validate the order shipment creation.
The order to create the shipment for.
The shipment creation details.
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break