softDeleteVariants - Product Module Reference

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

This method is used to delete variants. Unlike the delete method, this method won't completely remove the variant. It can still be accessed or retrieved using methods like retrieve if you pass the withDeleted property to the config object parameter.

The soft-deleted variants can be restored using the restore method.

Example

await productModuleService.softDeleteVariants([
  "variant_123",
  "variant_321",
])

Parameters

variantIdsstring[]Required

The IDs of the variants to soft-delete.

configSoftDeleteReturn<TReturnableLinkableKeys>

Configurations determining which relations to soft delete along with the each of the variants. You can pass to its returnLinkableKeys property any of the variant's relation attribute names, such as option_value_id.

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 also soft deleted. 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 a record associated with the variant through this relation. If there are no related records, the promise resolved to void.