retrieveReservationItem - Inventory Next Module Reference

This documentation provides a reference to the retrieveReservationItem 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 reservation item by its ID.

Example#

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

Code
1const reservationItem =2  await inventoryModuleService.retrieveReservationItem(3    "resitem"4  )

To specify relations that should be retrieved:

Note: You can only retrieve data models defined in the same module. To retrieve linked data models from other modules, use Query instead.

Code
1const reservationItem =2  await inventoryModuleService.retrieveReservationItem(3    "resitem",4    {5      relations: ["inventory_item"],6    }7  )

Parameters#

reservationIdstring

The reservation's ID.

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 retrieved reservation item.