restorePricePreferences - Pricing Module Reference

This documentation provides a reference to the restorePricePreferences 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 restores soft deleted price preferences by their IDs.

Example#

Code
1await pricingModuleService.restorePricePreferences([2  "prpref_123",3  "prpref_321",4])

Parameters#

pricePreferenceIdsstring[]

The IDs of the price preferences.

configRestoreReturn<TReturnableLinkableKeys>Optional

Configurations determining which relations to restore along with each of the price preferences.

sharedContextContextOptional

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

Returns#

PromisePromise<void | Record<string, string[]>>

An object that includes the IDs of related records that were restored. The object's keys are the ID attribute names of the price preferences entity's relations, and its value is an array of strings, each being the ID of the record associated with the price preferences through this relation. If there are no related records restored, the promise resolves to void.

Was this page helpful?