- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Menu
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
restoreReturns - Order Module Reference
This documentation provides a reference to the restoreReturns
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 returns by their IDs.
Example#
Parameters#
ids
string[]The IDs of the returns.
Configurations determining which relations to restore along with each of the returns. You can pass to its returnLinkableKeys
property any of the return's relation attribute names.
returnLinkableKeys
property any of the return's relation attribute names.Returns#
Promise
Promise<void | Record<string, string[]>>An object that includes the IDs of related records that were restored.
The object's keys are the ID attribute names of the return entity's relations,
and its value is an array of strings, each being the ID of the record associated with the return through this relation.
If there are no related records restored, the promise resolves to void
.
Promise
Promise<void | Record<string, string[]>>void
.Was this page helpful?