Skip to main content
Skip to main content

listAndCountPriceLists - Pricing Module Reference

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

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

Example

To retrieve a list of price lists using their IDs:

const [priceLists, count] =
await pricingModuleService.listAndCountPriceLists({
id: ["plist_123", "plist_321"],
})

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

const [priceLists, count] =
await pricingModuleService.listAndCountPriceLists(
{
id: ["plist_123", "plist_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 [priceLists, count] =
await pricingModuleService.listAndCountPriceLists(
{
id: ["plist_123", "plist_321"],
},
{
relations: ["prices"],
take: 20,
skip: 2,
}
)

Parameters

The filters to apply on the retrieved price lists.
The configurations determining how the price lists are retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a price list.
sharedContextContext
A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<[PriceListDTO[], number]>Required
The list of price lists along with their total count.
Was this section helpful?