retrievePriceRule - Pricing Module Reference

This documentation provides a reference to the retrievePriceRule method. This belongs to the Pricing Module.

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

This method is used to retrieve a price rule by its ID.

Example#

A simple example that retrieves a price rule by its ID:

Code
1const priceRule =2  await pricingModuleService.retrievePriceRule("prule_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 priceRule =2  await pricingModuleService.retrievePriceRule("prule_123", {3    relations: ["price_set"],4  })

Parameters#

idstring

The ID of the price rule to retrieve.

configFindConfig<PriceRuleDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<PriceRuleDTO>

The retrieved price rule.