listPriceListRules - Pricing Module Reference

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

This method is used to retrieve a paginated list of price list rules based on optional filters and configuration.

Example

To retrieve a list of price list vs using their IDs:

const priceListRules =
  await pricingModuleService.listPriceListRules({
    id: ["plrule_123", "plrule_321"],
  })

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

const priceListRules =
  await pricingModuleService.listPriceListRules(
    {
      id: ["plrule_123", "plrule_321"],
    },
    {
      relations: ["price_list_rule_values"],
    }
  )

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 priceListRules =
  await pricingModuleService.listPriceListRules(
    {
      id: ["plrule_123", "plrule_321"],
    },
    {
      relations: ["price_list_rule_values"],
      take: 20,
      skip: 2,
    }
  )

Parameters

filtersFilterablePriceListRuleProps

The filters to apply on the retrieved price list rules.

configFindConfig<PriceListRuleDTO>

The configurations determining how the price list rules are 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 list of price list rules.