listReservationItems - Inventory Next Module Reference

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

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

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:

Code
1const reservationItems =2  await inventoryModuleService.listReservationItems({3    id: ["resitem_123", "resitem_321"],4  })

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

Code
1const reservationItems =2  await inventoryModuleService.listReservationItems(3    {4      id: ["resitem_123", "resitem_321"],5    },6    {7      relations: ["inventory_item"],8    }9  )

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

Code
1const reservationItems =2  await inventoryModuleService.listReservationItems(3    {4      id: ["resitem_123", "resitem_321"],5    },6    {7      relations: ["inventory_item"],8      take: 20,9      skip: 2,10    }11  )

Parameters#

selectorFilterableReservationItemProps

The filters to apply on the retrieved reservation items.

configFindConfig<ReservationItemDTO>Optional

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.

contextContextOptional

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

Returns#

PromisePromise<ReservationItemDTO[]>

The list of reservation items.

Was this page helpful?