createStockLocationsWorkflow - Medusa Core Workflows Reference

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

This workflow creates one or more stock locations. It's used by the Create Stock Location Admin API Route.

You can use this workflow within your own customizations or custom workflows, allowing you to create stock locations in your custom flows.

Source Code

Examples#

Steps#

createStockLocations

stockLocationsCreated

Workflow hook

Step conditioned by when

View step details

Input#

CreateStockLocationsWorkflowInputCreateStockLocationsWorkflowInput

The data to create the stock locations.

locationsCreateStockLocationInput[]

The stock locations to create.

Output#

StockLocationDTO[]StockLocationDTO[]

idstring

The ID of the stock location.

namestring

The name of the stock location.

metadataRecord<string, unknown> | null

Holds custom data in key-value pairs.

address_idstring

The associated address's ID.

fulfillment_setsFulfillmentSetDTO[]

Fulfillment sets for the location

created_atstring | Date

The creation date of the stock location.

updated_atstring | Date

The update date of the stock location.

deleted_atstring | Date | null

The deletion date of the stock location.

addressStockLocationAddressDTOOptional

The address of the stock location.

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.

stockLocationsCreated#

This step is a hook that you can inject custom functionality into.

Example

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

Input

Handlers consuming this hook accept the following input.

inputinput

The input data for the hook.

stockLocationsStockLocationDTO[]