listAndCountPriceRules - Pricing Module Reference

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

This method is used to retrieve a paginated list of price rules along with the total count of available price rules satisfying the provided filters.

Example

To retrieve a list of price rules using their IDs:

const [priceRules, count] =
  await pricingModuleService.listAndCountPriceListRules({
    id: ["prule_123", "prule_321"],
  })

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

const [priceRules, count] =
  await pricingModuleService.listAndCountPriceListRules(
    {
      id: ["prule_123", "prule_321"],
    },
    {
      relations: ["price_set"],
    }
  )

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

const [priceRules, count] =
  await pricingModuleService.listAndCountPriceListRules(
    {
      id: ["prule_123", "prule_321"],
    },
    {
      relations: ["price_set"],
      take: 20,
      skip: 2,
    }
  )

Parameters

filtersFilterablePriceRuleProps

The filters to apply on the retrieved price rules.

configFindConfig<PriceRuleDTO>

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[], number]>Required

The list of price rules along with their total count.