adjustInventoryLevelsStep - Medusa Core Workflows Reference

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

This step adjusts the stocked quantity of one or more inventory levels. You can pass a positive value in adjustment to add to the stocked quantity, or a negative value to subtract from the stocked quantity.

Example#

Code
1const data = adjustInventoryLevelsStep([2  {3    inventory_item_id: "iitem_123",4    location_id: "sloc_123",5    adjustment: 10,6  }7])

Input#

AdjustInventoryLevelsStepInputAdjustInventoryLevelsStepInput

The data to adjust the inventory levels.

inventory_item_idstring

The ID of the associated inventory level.

location_idstring

The ID of the associated location.

adjustmentBigNumberInput

The quantity to adjust the inventory level by. If positive, the quantity will be added to the stocked quantity. If negative, the quantity will be subtracted from the stocked quantity.

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?