restorePromotions - Promotion Module Reference

This documentation provides a reference to the restorePromotions 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 restores soft deleted promotions by their IDs.

Example#

Code
await promotionModuleService.restorePromotions("promo_123")

Parameters#

promotionIdsstring | string[]

The promotions' IDs.

configRestoreReturn<TReturnableLinkableKeys>Optional

Configurations determining which relations to restore along with each of the promotion. You can pass to its returnLinkableKeys property any of the promotion's relation attribute names, such as application_method_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 restored, such as the ID of 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 the record associated with the promotion through this relation, such as the IDs of associated application method. If there are no related records restored, the promise resolves to void.

Was this page helpful?