listAndCountPrices - Pricing Module Reference

This documentation provides a reference to the listAndCountPrices 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 prices along with the total count of available prices satisfying the provided filters.

Example#

To retrieve a list of prices using their IDs:

Code
1const [prices, count] = await pricingModuleService.listPrices(2  {3    id: ["price_123", "price_321"],4  }5)

To specify relations that should be retrieved within the prices:

Code
1const [prices, count] = await pricingModuleService.listPrices(2  {3    id: ["price_123", "price_321"],4  },5  {6    relations: ["price_rules"],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 [prices, count] = await pricingModuleService.listPrices(2  {3    id: ["price_123", "price_321"],4  },5  {6    relations: ["price_rules"],7    take: 20,8    skip: 2,9  }10)

Parameters#

filtersFilterablePricePropsOptional

The filters to apply on the retrieved prices.

configFindConfig<PriceDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<[PriceDTO[], number]>

The list of prices and their total count.

Was this page helpful?