restoreProductCollections - Product Module Reference

This documentation provides a reference to the restoreProductCollections method. This belongs to the Product Module.

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

This method is used to restore collections which were deleted using the softDelete method.

Example#

Code
1await productModuleService.restoreProductCollections([2  "pcol_123",3  "pcol_321",4])

Parameters#

collectionIdsstring[]

The IDs of the collections to restore.

configRestoreReturn<TReturnableLinkableKeys>Optional

Configurations determining which relations to restore along with each of the collections. You can pass to its returnLinkableKeys property any of the collection's relation attribute names.

sharedContextContextOptional

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

Returns#

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

An object that includes the IDs of related records that were restored. The object's keys are the ID attribute names of the product entity's relations. If there are no related records that were restored, the promise resolved to void.

Was this page helpful?