listCampaigns - Promotion Module Reference

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

This method retrieves a paginated list of campaigns based on optional filters and configuration.

Example

To retrieve a list of campaigns using their IDs:

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

To specify relations that should be retrieved within the campaigns:

const campaigns = await promotionModuleService.listCampaigns(
  {
    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 = await promotionModuleService.listCampaigns(
  {
    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[]>Required

The list of campaigns.