softDeleteCollections - Product Module Reference

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

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

await productModuleService.softDeleteCollections([
  "pcol_123",
  "pcol_321",
])

Parameters

collectionIdsstring[]Required

The IDs of the collections to soft-delete.

configSoftDeleteReturn<TReturnableLinkableKeys>

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.

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 collection entity's relations. If there are no related records, the promise resolved to void.