createOrderShipmentWorkflow - Medusa Core Workflows Reference

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

This workflow creates a shipment for an order. It's used by the Create Order Shipment Admin API Route.

This workflow has a hook that allows you to perform custom actions on the created shipment. For example, you can pass under additional_data custom data that allows you to create custom data models linked to the shipment.

You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around creating a shipment.

Examples#

Steps#

Input#

Hooks#

Hooks allow you to inject custom functionalities into the workflow. You'll receive data from the workflow, as well as additional data sent through an HTTP request.

Learn more about Hooks and Additional Data.

shipmentCreated#

This hook is executed after the shipment is created. You can consume this hook to perform custom actions on the created shipment.

Example

Code
1import { createOrderShipmentWorkflow } from "@medusajs/medusa/core-flows"2
3createOrderShipmentWorkflow.hooks.shipmentCreated(4  (async ({ shipment, additional_data }, { container }) => {5    //TODO6  })7)

Input

Handlers consuming this hook accept the following input.