listCampaigns - Promotion Module Reference

This documentation provides a reference to the listCampaigns 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 based on optional filters and configuration.

Example#

To retrieve a list of campaigns using their IDs:

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

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 = await promotionModuleService.listCampaigns(2  {3    id: ["procamp_123"],4  },5  {6    relations: ["promotions"],7  }8)

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

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

The list of campaigns.