softDeleteProductCollections - Product Module Reference

This documentation provides a reference to the softDeleteProductCollections 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 delete product collections. Unlike the deleteCollections method, this method won't completely remove the collection. It can still be accessed or retrieved using methods like retrieveCollections if you pass the withDeleted property to the config object parameter.

The soft-deleted collections can be restored using the restoreCollections method.

Example#

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

Parameters#

collectionIdsstring[]

The IDs of the collections to soft-delete.

configSoftDeleteReturn<TReturnableLinkableKeys>Optional

Configurations determining which relations to soft delete along with the 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 also soft deleted. The object's keys are the ID attribute names of the collection entity's relations. If there are no related records, the promise resolved to void.