listAndCountCampaigns - Promotion Module Reference

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

Example#

To retrieve a list of campaigns using their IDs:

Code
1const [campaigns, count] =2  await promotionModuleService.listAndCountCampaigns({3    id: ["procamp_123"],4  })

To specify relations that should be retrieved within the campaigns:

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 [campaigns, count] =2  await promotionModuleService.listAndCountCampaigns(3    {4      id: ["procamp_123"],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 [campaigns, count] =2  await promotionModuleService.listAndCountCampaigns(3    {4      id: ["procamp_123"],5    },6    {7      relations: ["promotions"],8      take: 20,9      skip: 2,10    }11  )

Parameters#

filtersFilterableCampaignPropsOptional

The filters to apply on the retrieved campaigns.

configFindConfig<CampaignDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<[CampaignDTO[], number]>

The list of campaigns along with their total count.