Get Started
Product
Resources
Tools & SDKs
Framework
Reference

restoreOrderAddresses - Order Module Reference

This documentation provides a reference to the restoreOrderAddresses method. This belongs to the Order 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 addresses by their IDs.

Example#

Code
1await orderModuleService.restoreOrderAddresses([2  "123", "321"3])

Parameters#

idsstring[]

The IDs of the addresses.

configRestoreReturn<TReturnableLinkableKeys>Optional

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.

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. The object's keys are the ID attribute names of the address entity's relations, and its value is an array of strings, each being the ID of the record associated with the address through this relation. If there are no related records restored, the promise resolves to void.

Was this page helpful?