reserveInventoryStep - Medusa Core Workflows Reference

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

This step reserves the quantity of line items from the associated variant's inventory.

Example#

Code
1const data = reserveInventoryStep({2  "items": [{3    "inventory_item_id": "iitem_123",4    "required_quantity": 1,5    "allow_backorder": false,6    "quantity": 1,7    "location_ids": [8      "sloc_123"9    ]10  }]11})

Input#

ReserveVariantInventoryStepInputReserveVariantInventoryStepInput
The details of the items and their quantity to reserve.
itemsobject[]

Output#

ReservationItemDTO[]ReservationItemDTO[]
ReservationItemDTOReservationItemDTO
The reservation item details.
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