retrievePromotion - Promotion Module Reference

This documentation provides a reference to the retrievePromotion 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 retrieves a promotion by its ID.

Example#

A simple example that retrieves a promotion by its ID:

Code
1const promotion =2  await promotionModuleService.retrievePromotion("promo_123")

To specify relations that should be retrieved:

Code
1const promotion = await promotionModuleService.retrievePromotion(2  "promo_123",3  {4    relations: ["application_method"],5  }6)

Parameters#

idstring

The ID of the promotion.

configFindConfig<PromotionDTO>Optional

The configurations determining how the promotion is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a promotion.

sharedContextContextOptional

A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<PromotionDTO>

The retrieved promotion.

Was this page helpful?