restore - Fulfillment Module Reference

This documentation provides a reference to the restore method. This belongs to the Fulfillment Module.

This method restores a soft deleted fulfillment by its IDs.

Example

await fulfillmentModuleService.restore([
  "fuset_123",
  "fuset_321",
])

Parameters

fulfillmentIdsstring[]Required

The IDs of the fulfillment sets.

configRestoreReturn<TReturnableLinkableKeys>

Configurations determining which relations to restore along with each of the fulfillment sets. You can pass to its returnLinkableKeys property any of the fulfillment set'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<string, 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.