Loading...
Was this page helpful?
Loading...
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#
Input#
AdjustInventoryLevelsStepInputAdjustInventoryLevelsStepInputThe data to adjust the inventory levels.
AdjustInventoryLevelsStepInputAdjustInventoryLevelsStepInputinventory_item_idstringThe ID of the associated inventory level.
inventory_item_idstringlocation_idstringThe ID of the associated location.
location_idstringadjustmentBigNumberInputThe 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.
adjustmentBigNumberInputOutput#
InventoryLevelDTO[]InventoryLevelDTO[]
InventoryLevelDTO[]InventoryLevelDTO[]idstringThe ID of the inventory level.
idstringinventory_item_idstringThe associated inventory item's ID.
inventory_item_idstringlocation_idstringThe associated location's ID.
location_idstringstocked_quantitynumberThe stocked quantity of the inventory level.
stocked_quantitynumberreserved_quantitynumberThe reserved quantity of the inventory level.
reserved_quantitynumberincoming_quantitynumberThe incoming quantity of the inventory level.
incoming_quantitynumberavailable_quantitynumberThe available quantity of the inventory level.
available_quantitynumbermetadatanull | Record<string, unknown>Holds custom data in key-value pairs.
metadatanull | Record<string, unknown>created_atstring | DateThe creation date of the inventory level.
created_atstring | Dateupdated_atstring | DateThe update date of the inventory level.
updated_atstring | Datedeleted_atnull | string | DateThe deletion date of the inventory level.
deleted_atnull | string | Date