softDeleteTaxRateRules - Tax Module Reference

This documentation provides a reference to the softDeleteTaxRateRules 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 soft deletes tax rate rules by their IDs.

Example#

Code
1await taxModuleService.softDeleteTaxRateRules([2  "txrule_123",3  "txrule_321",4])

taxRateRuleIdsstring[]

The IDs of the tax rate rules.

configSoftDeleteReturn<TReturnableLinkableKeys>Optional

An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.

sharedContextContextOptional

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

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

An object that includes the IDs of related records that were also soft deleted. If there are no related records, the promise resolves to void.