validateInventoryLocationsStep - Medusa Core Workflows Reference

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

This step ensures that the inventory levels exist for each specified pair of inventory item and location. If not, the step will throw an error.

src/workflows/my-workflow.ts
1import { createWorkflow } from "@medusajs/framework/workflows-sdk"2import { validateInventoryLocationsStep } from "@medusajs/medusa/core-flows"3
4const myWorkflow = createWorkflow(5  "my-workflow",6  () => {7    const data = validateInventoryLocationsStep({8      "inventory_item_id": "{value}",9      "location_id": "{value}"10    })11  }12)

Input#

ValidateInventoryLocationsStepInputValidateInventoryLocationsStepInput
The data to validate the inventory levels.
inventory_item_idstring
The ID of the associated inventory item.
location_idstring
The ID of the associated location.
stocked_quantitynumberOptional
The stocked quantity of the associated inventory item in the associated location.
incoming_quantitynumberOptional
The incoming quantity of the associated inventory item in the associated location.
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break