restore - Inventory Next Module Reference

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

This method restores soft deleted inventory items by their IDs.

Example

await inventoryModuleService.restore(
  ["iitem_123", "iitem_321"],
  {
    returnLinkableKeys: ["location_level"],
  }
)

Parameters

inventoryItemIdsstring[]Required

The inventory items' IDs.

configRestoreReturn<TReturnableLinkableKeys>

Configurations determining which relations to restore along with each of the inventory items. You can pass to its returnLinkableKeys property any of the inventory item's relation attribute names, such as location_levels.

sharedContextContext

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

Returns

PromisePromise<void | Record<string, string[]>>Required

An object that includes the IDs of related records that were restored, such as the ID of associated location levels. The object's keys are the ID attribute names of the inventory item entity's relations, such as location_level_id, and its value is an array of strings, each being the ID of the record associated with the inventory item through this relation, such as the IDs of associated location levels. If there are no related records restored, the promise resolves to void.