listPromotionRules - Promotion Module Reference

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

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:

const promotionRules =
  await promotionModuleService.listPromotionRules({
    id: ["prorul_123", "prorul_321"],
  })

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

const promotionRules =
  await promotionModuleService.listPromotionRules(
    {
      id: ["prorul_123", "prorul_321"],
    },
    {
      relations: ["promotions"],
    }
  )

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

const promotionRules =
  await promotionModuleService.listPromotionRules(
    {
      id: ["prorul_123", "prorul_321"],
    },
    {
      relations: ["promotions"],
      take: 20,
      skip: 2,
    }
  )

Parameters

filtersFilterablePromotionRuleProps

The filters to apply on the retrieved promotion rules.

configFindConfig<PromotionRuleDTO>

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.

sharedContextContext

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

Returns

PromisePromise<PromotionRuleDTO[]>Required

The list of promotion rules.