restorePrices - Pricing Module Reference

This documentation provides a reference to the restorePrices 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 prices by their IDs.

Example#

Code
1await pricingModuleService.restorePrices([2  "price_123",3  "price_321",4])

Parameters#

priceIdsstring[]

The IDs of the prices.

configRestoreReturn<TReturnableLinkableKeys>Optional

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

. @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module. @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were restored, such as the ID of associated price rules. The object's keys are the ID attribute names of the prices entity's relations, such as

price_rule_id`, and its value is an array of strings, each being the ID of the record associated with the prices through this relation, such as the IDs of associated price rules. If there are no related records restored, the promise resolves to void.

sharedContextContextOptional

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

Returns#

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

This method restores soft deleted prices by their IDs.

Was this page helpful?