Inventory Module

In this section of the documentation, you will find resources to learn more about the Inventory Module and how to use it in your application.

Medusa has inventory related features available out-of-the-box through the Inventory Module. A module is a standalone package that provides features for a single domain. Each of Medusa's commerce features are placed in commerce modules, such as this Inventory Module.

Inventory Features#

• Inventory Items Management: Store and manage inventory of any stock-kept item, such as product variants.
• Inventory Across Locations: Manage inventory levels across different locations, such as warehouses.
• Reservation Management: Reserve quantities of inventory items at specific locations for orders or other purposes.
• Check Inventory Availability: Check whether an inventory item has the necessary quantity for purchase.

How to Use the Inventory Module#

In your Medusa application, you build flows around commerce modules. A flow is built as a Workflow, which is a special function composed of a series of steps that guarantees data consistency and reliable roll-back mechanism.

You can build custom workflows and steps. You can also re-use Medusa's workflows and steps, which are provided by the @medusajs/medusa/core-flows package.

For example:

src/workflows/create-inventory-item.ts
1import { 2  createWorkflow, 3  WorkflowResponse,4  createStep,5  StepResponse,6} from "@medusajs/framework/workflows-sdk"7import { Modules } from "@medusajs/framework/utils"8
9const createInventoryItemStep = createStep(10  "create-inventory-item",11  async ({}, { container }) => {12    const inventoryModuleService = container.resolve(Modules.INVENTORY)13
14    const inventoryItem = await inventoryModuleService.createInventoryItems({15      sku: "SHIRT",16      title: "Green Medusa Shirt",17      requires_shipping: true,18    })19
20    return new StepResponse({ inventoryItem }, inventoryItem.id)21  },22  async (inventoryItemId, { container }) => {23    if (!inventoryItemId) {24      return25    }26    const inventoryModuleService = container.resolve(Modules.INVENTORY)27
28    await inventoryModuleService.deleteInventoryItems([inventoryItemId])29  }30)31
32export const createInventoryItemWorkflow = createWorkflow(33  "create-inventory-item-workflow",34  () => {35    const { inventoryItem } = createInventoryItemStep()36
37    return new WorkflowResponse({38      inventoryItem,39    })40  }41)

You can then execute the workflow in your custom API routes, scheduled jobs, or subscribers:

Learn more about workflows in this documentation.