Get Started
Product
Resources
Tools & SDKs
Framework
Reference

validateInventoryLevelsDelete - Medusa Core Workflows Reference

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

This step validates that inventory levels are deletable. If the inventory levels have reserved or incoming items, or the force flag is not set and the inventory levels have stocked items, the step will throw an error.

Note: You can retrieve an inventory level's details using Query, or useQueryGraphStep.

Example#

Code
1const data = validateInventoryLevelsDelete({2  inventoryLevels: [3    {4      id: "iilev_123",5      // other inventory level details...6    }7  ]8})

Input#

ValidateInventoryLevelsDeleteStepInputValidateInventoryLevelsDeleteStepInput

The data to validate the deletion of inventory levels.

inventoryLevelsInventoryLevelDTO[]

The inventory levels to validate.

forcebooleanOptional

If true, the inventory levels will be deleted even if they have stocked items.

Was this page helpful?