listAndCountCampaigns - Promotion Module Reference

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

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:

const [campaigns, count] =
  await promotionModuleService.listAndCountCampaigns({
    id: ["procamp_123"],
  })

To specify relations that should be retrieved within the campaigns:

const [campaigns, count] =
  await promotionModuleService.listAndCountCampaigns(
    {
      id: ["procamp_123"],
    },
    {
      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 [campaigns, count] =
  await promotionModuleService.listAndCountCampaigns(
    {
      id: ["procamp_123"],
    },
    {
      relations: ["promotions"],
      take: 20,
      skip: 2,
    }
  )

Parameters

filtersFilterableCampaignProps

The filters to apply on the retrieved campaigns.

configFindConfig<CampaignDTO>

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

sharedContextContext

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

Returns

PromisePromise<[CampaignDTO[], number]>Required

The list of campaigns along with their total count.