retrieve - Region Module Reference

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

This method retrieves a region by its ID.

Example

A simple example that retrieves a region by its ID:

const region = await regionModuleService.retrieve("reg_123")

To specify relations that should be retrieved:

const region = await regionModuleService.retrieve("reg_123", {
  relations: ["countries"],
})

Parameters

idstringRequired

The ID of the region.

configFindConfig<RegionDTO>

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

sharedContextContext

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

Returns

PromisePromise<RegionDTO>Required

The retrieved region.