softDeletePromotions - Promotion Module Reference

This documentation provides a reference to the softDeletePromotions method. This belongs to the Promotion Module.

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

This method soft deletes a promotion by its IDs.

Example#

Code
await promotionModuleService.softDeletePromotions("promo_123")

Parameters#

promotionIdsstring | string[]

The list of promotions to soft delete.

configSoftDeleteReturn<TReturnableLinkableKeys>Optional

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

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