restoreShippingMethods - Cart Module Reference

This documentation provides a reference to the restoreShippingMethods 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 restores soft deleted shipping methods by their IDs.

Example#

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

Parameters#

idsstring[]

The IDs of the shipping methods.

configRestoreReturn<TReturnableLinkableKeys>Optional

Configurations determining which relations to restore along with each of the shipping methods. You can pass to its returnLinkableKeys property any of the shipping method's relation attribute names, such as tax_lines.

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 restored, such as the ID of 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 the record associated with the shipping method through this relation, such as the IDs of associated tax lines. If there are no related records restored, the promise resolves to void.

Was this page helpful?