restoreProductVariants - Product Module Reference

This documentation provides a reference to the restoreProductVariants 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 variants which were deleted using the softDelete method.

Example#

Code
1await productModuleService.restoreProductVariants([2  "variant_123",3  "variant_321",4])

Parameters#

variantIdsstring[]

The IDs of the variants to restore.

configRestoreReturn<TReturnableLinkableKeys>Optional

Configurations determining which relations to restore along with each of the variants. You can pass to its returnLinkableKeys property any of the variant'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 variant entity's relations, and its value is an array of strings, each being the ID of the record associated with the variant through this relation. If there are no related records that were restored, the promise resolved to void.

Was this page helpful?