softDelete - Store Module Reference

This documentation provides a reference to the softDelete method. This belongs to the Store Module.

This method soft deletes a store by its IDs.

Example

await storeModuleService.softDelete([
  "store_123",
  "store_321",
])

Parameters

storeIdsstring[]Required

The IDs of the stores.

configSoftDeleteReturn<TReturnableLinkableKeys>

An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.

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. If there are no related records, the promise resolves to void.