Get Started
Product
Resources
Tools & SDKs
Framework
Reference

restoreOrders - Order Module Reference

This documentation provides a reference to the restoreOrders 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 orders by their IDs.

Example#

Code
await orderModuleService.restoreOrders(["123", "321"])

Parameters#

orderIdsstring[]

The list of order IDs.

configRestoreReturn<TReturnableLinkableKeys>Optional

Configurations determining which relations to restore along with each of the orders. You can pass to its returnLinkableKeys property any of the order's relation attribute names, such as items.

sharedContextContextOptional

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

Returns#

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

An object that includes the IDs of related records that were restored, such as the IDs of associated items. The object's keys are the ID attribute names of the order entity's relations, such as item_id, and its value is an array of strings, each being the ID of the record associated with the order through this relation, such as the IDs of associated items. If there are no related records restored, the promise resolves to void.

Was this page helpful?