restoreTaxRegions - Tax Module Reference

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

Example#

Code
1await taxModuleService.restoreTaxRegions([2  "txreg_123",3  "txreg_321",4])

Parameters#

taxRegionIdsstring[]

The IDs of the tax regions.

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 region's relation attribute names, such as tax_rates.

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