retrieveRegion - Region Module Reference

This documentation provides a reference to the retrieveRegion method. This belongs to the Region Module.

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

This method retrieves a region by its ID.

Example#

A simple example that retrieves a region by its ID:

Code
const region = await regionModuleService.retrieveRegion("reg_123")

To specify relations that should be retrieved:

Note: You can only retrieve data models defined in the same module. To retrieve linked data models from other modules, use Query instead.

Code
1const region = await regionModuleService.retrieveRegion("reg_123", {2  relations: ["countries"],3})

Parameters#

idstring

The ID of the region.

configFindConfig<RegionDTO>Optional

The configurations determining how the region is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a region.

sharedContextContextOptional

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

Returns#

PromisePromise<RegionDTO>

The retrieved region.