softDeleteShippingMethods - Cart Module Reference

This documentation provides a reference to the softDeleteShippingMethods method. This belongs to the Cart Module.

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

This method soft deletes shipping methods by their IDs.

Example#

Code
1await cartModuleService.softDeleteShippingMethods([2  "casm_123",3  "casm_321",4])

Parameters#

idsstring[]

The IDs of the shipping methods.

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<TReturnableLinkableKeys, string[]>>

An object that includes the IDs of related records that were also soft deleted, such as the ID of the associated tax lines. The object's keys are the ID attribute names of the shipping method entity's relations, such as tax_line_id, and its value is an array of strings, each being the ID of a record associated with the shipping method through this relation, such as the IDs of associated tax line. If there are no related records, the promise resolves to void.

Was this page helpful?