deleteInventoryLevelsWorkflow - Medusa Core Workflows Reference

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

This workflow deletes one or more inventory levels. It's used by the Delete Inventory Levels Admin API Route.

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

Examples#

useRemoteQueryStep

validateInventoryLevelsDelete

Workflow Hook

Step conditioned by when

DeleteInventoryLevelsWorkflowInputDeleteInventoryLevelsWorkflowInput

The data to delete inventory levels. The inventory levels to be deleted are selected based on the filters that you specify.

forcebooleanOptional

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

An array of filters to apply on the entity, where each item in the array is joined with an "and" condition.

An array of filters to apply on the entity, where each item in the array is joined with an "or" condition.

idstring | string[]Optional

Filter inventory levels by the ID

inventory_item_idstring | string[]Optional

Filter inventory levels by the ID of their associated inventory item.

location_idstring | string[]Optional

Filter inventory levels by the ID of their associated inventory location.

stocked_quantitynumber | OperatorMap<Number>Optional

Filters to apply on inventory levels' stocked_quantity attribute.

reserved_quantitynumber | OperatorMap<Number>Optional

Filters to apply on inventory levels' reserved_quantity attribute.

incoming_quantitynumber | OperatorMap<Number>Optional

Filters to apply on inventory levels' incoming_quantity attribute.

Was this page helpful?