Skip to main content
Skip to main content

retrievePriceRule - Pricing Module Reference

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

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

Example

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

const priceRule =
await pricingModuleService.retrievePriceRule("prule_123")

To specify relations that should be retrieved:

const priceRule =
await pricingModuleService.retrievePriceRule("prule_123", {
relations: ["price_set"],
})

Parameters

idstringRequired
The ID of the price rule to retrieve.
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.
sharedContextContext
A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<PriceRuleDTO>Required
The retrieved price rule.
Was this section helpful?