listAndCountPriceSets - Pricing Module Reference

This documentation provides a reference to the listAndCountPriceSets 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 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:

Code
1const [priceSets, count] =2  await pricingModuleService.listAndCountPriceSets({3    id: ["pset_123", "pset_321"],4  })

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

Note: You can only retrieve data models defined in the same module. To retrieve linked data models from other modules, use Query instead.

Code
1const [priceSets, count] =2  await pricingModuleService.listAndCountPriceSets(3    {4      id: ["pset_123", "pset_321"],5    },6    {7      relations: ["prices"],8    }9  )

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 [priceSets, count] =2  await pricingModuleService.listAndCountPriceSets(3    {4      id: ["pset_123", "pset_321"],5    },6    {7      relations: ["prices"],8      take: 20,9      skip: 2,10    }11  )

Parameters#

filtersFilterablePriceSetPropsOptional

The filters to apply on the retrieved price lists.

configFindConfig<PriceSetDTO>Optional

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.

sharedContextContextOptional

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

Returns#

PromisePromise<[PriceSetDTO[], number]>

The list of price sets along with their total count.