restoreShippingMethodAdjustments - Cart Module Reference

This documentation provides a reference to the restoreShippingMethodAdjustments 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 method adjustments by their IDs.

Example#

Code
1await cartModuleService.restoreShippingMethodAdjustments([2  "casmadj_123",3  "casmadj_321",4])

Parameters#

idsstring[]

The IDs of the shipping method adjustments.

configRestoreReturn<TReturnableLinkableKeys>Optional

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

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. If there are no related records restored, the promise resolves to void.

Was this page helpful?