softDeleteTaxRates - Tax Module Reference

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

Example#

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

Parameters#

taxRateIdsstring[]

The IDs of the tax rates.

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.

Returns#

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

An object that includes the IDs of related records that were also soft deleted, such as the ID of the 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 a record associated with the tax rate through this relation, such as the IDs of associated rules. If there are no related records, the promise resolves to void.