restore - Promotion Module Reference

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

This method restores soft deleted promotions by their IDs.

Example

await promotionModuleService.restore("promo_123")

Parameters

promotionIdsstring | string[]Required

The promotions' IDs.

configRestoreReturn<TReturnableLinkableKeys>

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.

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 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.