listAndCount - Pricing Module Reference

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

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

Example

To retrieve a list of prices sets using their IDs:

const [priceSets, count] =
  await pricingModuleService.listAndCount({
    id: ["pset_123", "pset_321"],
  })

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

const [priceSets, count] =
  await pricingModuleService.listAndCount(
    {
      id: ["pset_123", "pset_321"],
    },
    {
      relations: ["prices"],
    }
  )

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 [priceSets, count] =
  await pricingModuleService.listAndCount(
    {
      id: ["pset_123", "pset_321"],
    },
    {
      relations: ["prices"],
      take: 20,
      skip: 2,
    }
  )

Parameters

filtersFilterablePriceSetProps

The filters to apply on the retrieved price lists.

configFindConfig<PriceSetDTO>

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

sharedContextContext

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

Returns

PromisePromise<[PriceSetDTO[], number]>Required

The list of price sets along with their total count.