listAndCountPrices - Pricing Module Reference

Beta

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

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

Example

To retrieve a list of prices using their IDs:

const [prices, count] = await pricingModuleService.listPrices(
  {
    id: ["price_123", "price_321"],
  }
)

To specify relations that should be retrieved within the prices:

const [prices, count] = await pricingModuleService.listPrices(
  {
    id: ["price_123", "price_321"],
  },
  {
    relations: ["price_rules"],
  }
)

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 [prices, count] = await pricingModuleService.listPrices(
  {
    id: ["price_123", "price_321"],
  },
  {
    relations: ["price_rules"],
    take: 20,
    skip: 2,
  }
)

Parameters

filtersFilterablePriceProps

The filters to apply on the retrieved prices.

configFindConfig<PriceDTO>

The configurations determining how the prices are retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a price.

sharedContextContext

A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<[PriceDTO[], number]>Required

The list of prices and their total count.