deleteReservationItem - Inventory Module Reference

This documentation provides a reference to the deleteReservationItem method. This belongs to the Inventory Module.

This method is used to delete a reservation item or multiple reservation items by their IDs.

Example

import {
  initialize as initializeInventoryModule,
} from "@medusajs/inventory"

async function deleteReservationItems (
  reservationItemIds: string[]
) {
  const inventoryModule = await initializeInventoryModule({})

  await inventoryModule.deleteReservationItem(
    reservationItemIds
  )
}

Parameters

reservationItemIdstring | string[]Required

The ID(s) of the reservation item(s) to delete.

contextSharedContext

A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<void>Required

Resolves when the reservation item(s) are successfully deleted.