retrieveReservationItem - Inventory Next Module Reference

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

This method retrieves a reservation item by its ID.

Example

A simple example that retrieves a reservation item by its ID:

const reservationItem =
  await inventoryModuleService.retrieveReservationItem(
    "resitem"
  )

To specify relations that should be retrieved:

const reservationItem =
  await inventoryModuleService.retrieveReservationItem(
    "resitem",
    {
      relations: ["inventory_item"],
    }
  )

Parameters

reservationIdstringRequired

The reservation's ID.

configFindConfig<ReservationItemDTO>

The configurations determining how the reservation item is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a reservation item.

contextContext

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

Returns

PromisePromise<ReservationItemDTO>Required

The retrieved reservation item.