listPricePreferences - Pricing Module Reference

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

Example#

To retrieve a list of price preferences using their IDs:

Code
1const pricePreferences = await pricingModuleService.listPricePreferences({2  id: ["prpref_123", "prpref_321"],3})

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

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 pricePreferences = await pricingModuleService.listPricePreferences(2  {3    id: ["prpref_123", "prpref_321"],4  },5  {6    take: 20,7    skip: 2,8  }9)

Parameters#

filtersFilterablePricePreferencePropsOptional

The filters to apply on the retrieved price lists.

configFindConfig<PricePreferenceDTO>Optional

The configurations determining how the price preferences are retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a price preference.

sharedContextContextOptional

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

Returns#

PromisePromise<PricePreferenceDTO[]>

The list of price preferences.

Was this page helpful?