restoreShippingProfiles - Fulfillment Module Reference

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

This method restores soft deleted shipping profiles by their IDs.

Example

await fulfillmentModuleService.restoreShippingProfiles([
  "sp_123",
  "sp_321",
])

Parameters

shippingProfileIdsstring[]Required

The IDs of the shipping profiles.

configRestoreReturn<TReturnableLinkableKeys>

Configurations determining which relations to restore along with each of the shipping profiles. You can pass to its returnLinkableKeys property any of the shipping profile's relation attribute names, such as {type relation name}.

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.