restoreTaxRates - Tax Module Reference

This documentation provides a reference to the restoreTaxRates method. This belongs to the Tax 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 tax rates by their IDs.

Example#

Code
await taxModuleService.restoreTaxRates(["txr_123", "txr_321"])

Parameters#

taxRateIdsstring[]

The IDs of the tax rates.

configRestoreReturn<TReturnableLinkableKeys>Optional

Configurations determining which relations to restore along with each of the tax. You can pass to its returnLinkableKeys property any of the tax rate's relation attribute names, such as 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 rules. The object's keys are the ID attribute names of the tax rate entity's relations, such as rule_id, and its value is an array of strings, each being the ID of the record associated with the tax rate through this relation, such as the IDs of associated rules. If there are no related records restored, the promise resolves to void.