listPriceLists - Pricing Module Reference
This documentation provides a reference to the listPriceLists
method. This belongs to the Pricing Module.
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:
To specify relations that should be retrieved within the price lists:
By default, only the first 15
records are retrieved. You can control pagination by specifying the skip
and take
properties of the config
parameter:
Parameters
filters
FilterablePriceListPropsThe filters to apply on the retrieved price lists.
filters
FilterablePriceListPropsconfig
FindConfig<PriceListDTO>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.
config
FindConfig<PriceListDTO>select
or relations
, accept the
attributes or relations associated with a price list.Returns
The list of price lists.
Was this section helpful?