listPromotionRules - Promotion Module Reference

This documentation provides a reference to the listPromotionRules 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 paginated list of promotion rules based on optional filters and configuration.

Example#

To retrieve a list of promotion rules using their IDs:

Code
1const promotionRules =2  await promotionModuleService.listPromotionRules({3    id: ["prorul_123", "prorul_321"],4  })

To specify relations that should be retrieved within the promotion rules:

Code
1const promotionRules =2  await promotionModuleService.listPromotionRules(3    {4      id: ["prorul_123", "prorul_321"],5    },6    {7      relations: ["promotions"],8    }9  )

By default, only the first 15 records are retrieved. You can control pagination by specifying the skip and take properties of the config parameter:

Code
1const promotionRules =2  await promotionModuleService.listPromotionRules(3    {4      id: ["prorul_123", "prorul_321"],5    },6    {7      relations: ["promotions"],8      take: 20,9      skip: 2,10    }11  )

Parameters#

filtersFilterablePromotionRulePropsOptional

The filters to apply on the retrieved promotion rules.

configFindConfig<PromotionRuleDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<PromotionRuleDTO[]>

The list of promotion rules.

Was this page helpful?