softDelete - Sales Channel Module Reference

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

This method soft deletes sales channels by their IDs.

Example

await salesChannelModuleService.delete(["sc_123", "sc_321"])

Parameters

salesChannelIdsstring[]Required

The sales channels' ID.

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.