restorePriceLists - Pricing Module Reference

This documentation provides a reference to the restorePriceLists 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 a soft deleted price lists by its IDs.

Example#

Code
1await pricingModuleService.restorePriceLists([2  "plist_123",3  "plist_321",4])

Parameters#

priceListIdsstring[]

The list of {summary}

configRestoreReturn<TReturnableLinkableKeys>Optional

Configurations determining which relations to restore along with each of the price lists. You can pass to its returnLinkableKeys property any of the price list's relation attribute names, such as price_list_rules.

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, such as the ID of associated price list rules. The object's keys are the ID attribute names of the price list entity's relations, such as price_list_rule_id, and its value is an array of strings, each being the ID of the record associated with the price list through this relation, such as the IDs of associated price list rules. If there are no related records restored, the promise resolves to void.

Was this page helpful?