softDeleteProductCategories - Product Module Reference

This documentation provides a reference to the softDeleteProductCategories 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 categories. Unlike the deleteCategories method, this method won't completely remove the category. It can still be accessed or retrieved using methods like retrieveCategories if you pass the withDeleted property to the config object parameter.

The soft-deleted categories can be restored using the restoreCategories method.

Example#

Code
1await productModuleService.softDeleteProductCategories([2  "pcat_123",3  "pcat_321",4])

Parameters#

categoryIdsstring[]

The IDs of the categories to soft-delete.

configSoftDeleteReturn<TReturnableLinkableKeys>Optional

Configurations determining which relations to soft delete along with the each of the categories. You can pass to its returnLinkableKeys property any of the category'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 category entity's relations. If there are no related records, the promise resolved to void.

Was this page helpful?