retrieveCampaign - Promotion Module Reference

This documentation provides a reference to the retrieveCampaign 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 campaigns by its ID.

Example#

A simple example that retrieves a promotion by its ID:

Code
1const campaign =2  await promotionModuleService.retrieveCampaign("procamp_123")

To specify relations that should be retrieved:

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

Parameters#

idstring

The ID of the 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 retrieved campaigns.