retrievePricePreference - Pricing Module Reference

This documentation provides a reference to the retrievePricePreference 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 price preference by its ID.

Example#

A simple example that retrieves a price preference by its ID:

Code
1const pricePreference =2  await pricingModuleService.retrievePricePreference("prpref_123")

Parameters#

idstring

The ID of the price preference to retrieve.

configFindConfig<PricePreferenceDTO>Optional

The configurations determining how the price preference is 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 retrieved price preference.

Was this page helpful?