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[]

idstring

The ID of the reservation item.

location_idstring

The associated location's ID.

inventory_item_idstring

The associated inventory item's ID.

quantityBigNumberInput

The quantity of the reservation item.

metadatanull | Record<string, unknown>

Holds custom data in key-value pairs.

created_atstring | Date

The creation date of the reservation item.

updated_atstring | Date

The update date of the reservation item.

deleted_atnull | string | Date

The deletion date of the reservation item.

line_item_idnull | stringOptional

The associated line item's ID.

descriptionnull | stringOptional

The description of the reservation item.

allow_backorderbooleanOptional

Allow backorder of the item. If true, it won't check inventory levels before reserving it.

created_bynull | stringOptional

The created by of the reservation item.