listAndCountPromotions - Promotion Module Reference

This documentation provides a reference to the listAndCountPromotions 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 promotions along with the total count of available promotions satisfying the provided filters.

Example#

To retrieve a list of promotions using their IDs:

Code
1const [promotions, count] =2  await promotionModuleService.listAndCountPromotions({3    id: ["promo_123", "promo_321"],4  })

To specify relations that should be retrieved within the promotions:

Note: You can only retrieve data models defined in the same module. To retrieve linked data models from other modules, use Query instead.

Code
1const [promotions, count] =2  await promotionModuleService.listAndCountPromotions(3    {4      id: ["promo_123", "promo_321"],5    },6    {7      relations: ["application_method"],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 [promotions, count] =2  await promotionModuleService.listAndCountPromotions(3    {4      id: ["promo_123", "promo_321"],5    },6    {7      relations: ["application_method"],8      take: 20,9      skip: 2,10    }11  )

Parameters#

filtersFilterablePromotionPropsOptional

The filters to apply on the retrieved promotions.

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[], number]>

The list of promotions along with their total count.