restoreGeoZones - Fulfillment Module Reference

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

This method restores soft deleted geo zones by their IDs.

Example

await fulfillmentModuleService.restoreGeoZones([
  "fgz_123",
  "fgz_321",
])

Parameters

geoZoneIdsstring[]Required

The IDs of the geo zones.

configRestoreReturn<TReturnableLinkableKeys>

Configurations determining which relations to restore along with each of the geo zones. You can pass to its returnLinkableKeys property any of the geo zone'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.