restoreAddresses - Cart Module Reference

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

This method restores soft deleted addresses by their IDs.

Example

await cartModuleService.restoreAddresses([
  "caaddr_123",
  "caaddr_321",
])

Parameters

idsstring[]Required

The IDs of the addresses.

configRestoreReturn<TReturnableLinkableKeys>

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

sharedContextContext

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

Returns

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

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