listReservationItems - Inventory Next Module Reference

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

This method retrieves a paginated list of reservation items based on optional filters and configuration.

Example

To retrieve a list of reservation items using their IDs:

const reservationItems =
  await inventoryModuleService.listReservationItems({
    id: ["resitem_123", "resitem_321"],
  })

To specify relations that should be retrieved within the reservation items:

const reservationItems =
  await inventoryModuleService.listReservationItems(
    {
      id: ["resitem_123", "resitem_321"],
    },
    {
      relations: ["inventory_item"],
    }
  )

By default, only the first 10 records are retrieved. You can control pagination by specifying the skip and take properties of the config parameter:

const reservationItems =
  await inventoryModuleService.listReservationItems(
    {
      id: ["resitem_123", "resitem_321"],
    },
    {
      relations: ["inventory_item"],
      take: 20,
      skip: 2,
    }
  )

Parameters

selectorFilterableReservationItemPropsRequired

The filters to apply on the retrieved reservation items.

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 list of reservation items.