createInventoryLevelsStep - Medusa Core Workflows Reference

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

This step creates one or more inventory levels.

src/workflows/my-workflow.ts
1import { createWorkflow } from "@medusajs/framework/workflows-sdk"2import { createInventoryLevelsStep } from "@medusajs/medusa/core-flows"3
4const myWorkflow = createWorkflow(5  "my-workflow",6  () => {7    const data = createInventoryLevelsStep({8      "inventory_item_id": "{value}",9      "location_id": "{value}"10    })11  }12)

Input#

CreateInventoryLevelsStepInputCreateInventoryLevelsStepInput

The data to create the inventory levels.

inventory_item_idstring

The ID of the associated inventory item.

location_idstring

The ID of the associated location.

stocked_quantitynumberOptional

The stocked quantity of the associated inventory item in the associated location.

incoming_quantitynumberOptional

The incoming quantity of the associated inventory item in the associated location.

Output#

InventoryLevelDTO[]InventoryLevelDTO[]

idstring

The ID of the inventory level.

inventory_item_idstring

The associated inventory item's ID.

location_idstring

The associated location's ID.

stocked_quantitynumber

The stocked quantity of the inventory level.

reserved_quantitynumber

The reserved quantity of the inventory level.

incoming_quantitynumber

The incoming quantity of the inventory level.

available_quantitynumber

The available quantity of the inventory level.

metadatanull | Record<string, unknown>

Holds custom data in key-value pairs.

created_atstring | Date

The creation date of the inventory level.

updated_atstring | Date

The update date of the inventory level.

deleted_atnull | string | Date

The deletion date of the inventory level.

Was this page helpful?