restore - Stock Location Next Module Reference

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

This method restores soft deleted stock locations by their IDs.

Example

await stockLocationModuleService.restore([
  "sloc_123",
  "sloc_321",
])

Parameters

stockLocationIdsstring[]Required

The IDs of the stock locations.

configRestoreReturn<TReturnableLinkableKeys>

Configurations determining which relations to restore along with each of the stock location. You can pass to its returnLinkableKeys property any of the stock location's relation attribute names, such as address.

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 address. The object's keys are the ID attribute names of the stock location entity's relations, such as address_id, and its value is an array of strings, each being the ID of the record associated with the stock location through this relation, such as the ID of associated address. If there are no related records restored, the promise resolves to void.