retrieveCountry - Region Module Reference

This documentation provides a reference to the retrieveCountry 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 country by its 2 character ISO code.

Example#

A simple example that retrieves a country by its 2 character ISO code:

Code
1const country =2  await regionModuleService.retrieveCountry("us")

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 country = await regionModuleService.retrieveCountry(2  "us",3  {4    relations: ["region"],5  }6)

Parameters#

countryIdstring

The country's ID, which is the 2 character ISO code.

configFindConfig<RegionCountryDTO>Optional

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

sharedContextContextOptional

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

Returns#

PromisePromise<RegionCountryDTO>

The retrieved country.