listPriceRules - Pricing Module Reference

This documentation provides a reference to the listPriceRules 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 paginated list of price rules based on optional filters and configuration.

Example#

To retrieve a list of price rules using their IDs:

Code
1const priceRules = await pricingModuleService.listPriceRules({2  id: ["prule_123", "prule_321"],3})

To specify relations that should be retrieved within the price rules:

Code
1const priceRules = await pricingModuleService.listPriceRules(2  {3    id: ["prule_123", "prule_321"],4  },5  {6    relations: ["price_set"],7  }8)

By default, only the first 15 records are retrieved. You can control pagination by specifying the skip and take properties of the config parameter:

Code
1const priceRules = await pricingModuleService.listPriceRules(2  {3    id: ["prule_123", "prule_321"],4  },5  {6    relations: ["price_set"],7    take: 20,8    skip: 2,9  }10)

Parameters#

filtersFilterablePriceRulePropsOptional

The filters to apply on the retrieved price rules.

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 list of price rules.

Was this page helpful?