listAndCountPriceLists - Pricing Module Reference

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

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

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

Code
1const [priceLists, count] =2  await pricingModuleService.listAndCountPriceLists(3    {4      id: ["plist_123", "plist_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 [priceLists, count] =2  await pricingModuleService.listAndCountPriceLists(3    {4      id: ["plist_123", "plist_321"],5    },6    {7      relations: ["prices"],8      take: 20,9      skip: 2,10    }11  )

Parameters#

filtersFilterablePriceListPropsOptional

The filters to apply on the retrieved price lists.

configFindConfig<PriceListDTO>Optional

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.

sharedContextContextOptional

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

Returns#

PromisePromise<[PriceListDTO[], number]>

The list of price lists along with their total count.

Was this page helpful?