updateInventoryLevelsWorkflow - Medusa Core Workflows Reference

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

This workflow updates one or more inventory levels. It's used by the Update Inventory Level Admin API Route.

You can use this workflow within your own customizations or custom workflows, allowing you to update inventory levels in your custom flows.

Examples#

updateInventoryLevelsStep

Workflow Hook

Step conditioned by when

UpdateInventoryLevelsWorkflowInputUpdateInventoryLevelsWorkflowInput

The data to update the inventory levels.

The inventory levels to update.

UpdateInventoryLevelsWorkflowOutputUpdateInventoryLevelsWorkflowOutput

The updated inventory levels.

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?