Skip to main content
Skip to main content

retrievePriceListRule - Pricing Module Reference

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

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

Example

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

const priceListRule =
await pricingModuleService.retrievePriceListRule(
"plrule_123"
)

To specify relations that should be retrieved:

const priceListRule =
await pricingModuleService.retrievePriceListRule(
"plrule_123",
{
relations: ["price_list"],
}
)

Parameters

idstringRequired
The ID of the price list rule to retrieve.
The configurations determining how the price list rule is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a price list rule.
sharedContextContext
A context used to share resources, such as transaction manager, between the application and the module.

Returns

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