createOrderWorkflow - Medusa Core Workflows Reference

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

This workflow creates an order. It's used by the Create Draft Order Admin API Route, but you can also use it to create any order.

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

You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around creating an order. For example, you can create a workflow that imports orders from an external system, then uses this workflow to create the orders in Medusa.

Examples#

Steps#

Input#

Output#

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.

setPricingContext#

This hook is executed after the order is retrieved and before the line items are created. You can consume this hook to return any custom context useful for the prices retrieval of the variants to be added to the order.

For example, assuming you have the following custom pricing rule:

Code
1{2  "attribute": "location_id",3  "operator": "eq",4  "value": "sloc_123",5}

You can consume the setPricingContext hook to add the location_id context to the prices calculation:

Code
1import { createOrderWorkflow } from "@medusajs/medusa/core-flows";2import { StepResponse } from "@medusajs/workflows-sdk";3
4createOrderWorkflow.hooks.setPricingContext((5  { variantIds, region, customerData, additional_data }, { container }6) => {7  return new StepResponse({8    location_id: "sloc_123", // Special price for in-store purchases9  });10});

The variants' prices will now be retrieved using the context you return.

Example

Code
1import { createOrderWorkflow } from "@medusajs/medusa/core-flows"2
3createOrderWorkflow.hooks.setPricingContext(4  (async ({ variantIds, region, customerData,5      additional_data }, { container }) => {6    //TODO7  })8)

Input

Handlers consuming this hook accept the following input.

orderCreated#

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

Example

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

Input

Handlers consuming this hook accept the following input.