softDeleteProducts - Product Module Reference

This documentation provides a reference to the softDeleteProducts 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 products. Unlike the delete method, this method won't completely remove the product. 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 products can be restored using the restore method.

Example#

Code
1await productModuleService.softDeleteProducts([2  "prod_123",3  "prod_321",4])

Parameters#

productIdsstring[]

The IDs of the products to soft-delete.

configSoftDeleteReturn<TReturnableLinkableKeys>Optional

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

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, such as the ID of associated product variants. The object's keys are the ID attribute names of the product entity's relations, such as variant_id, and its value is an array of strings, each being the ID of a record associated with the product through this relation, such as the IDs of associated product variants. If there are no related records, the promise resolved to void.

Was this page helpful?