listPriceLists - Pricing Module Reference

This documentation provides a reference to the listPriceLists 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 based on optional filters and configuration.

Example#

To retrieve a list of price lists using their IDs:

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

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

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

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[]>

The list of price lists.

Was this page helpful?