Interface IRegionService

Get Region information. See admin settings page to configure regions.

Namespace: DirectScale.Disco.Extension.Services
Assembly: DirectScale.Disco.Extension.Abstractions.dll
Syntax
public interface IRegionService
Remarks

Regions are used to group states/countries together into different areas. These areas are named, numbered, and then used to indicate things like which merchants can be used for payments there, what warehouses and stores can service that area, which discounts are available in that area, and what langages are used there.

Methods

GetRegionId(String, String)

Gets the region id over this countryCode and stateCode.

Declaration
Task<int> GetRegionId(string countryCode, string stateCode)
Parameters
Type Name Description
System.String countryCode

Country.
System.String stateCode

State.
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>

Returns the region id of the region that include this countryCode and stateCode.
See Also

GetRegionIdByAddress(Address)

Gets the region id over this address's country and state.

Declaration
Task<int> GetRegionIdByAddress(Address address)
Parameters
Type Name Description
Address address

Address.
Returns
Type Description
System.Threading.Tasks.Task<System.Int32>

Returns the region id of the region that include this address's country and state.
See Also

GetRegionName(Int32)

Gets the description of the regionId.

Declaration
Task<string> GetRegionName(int regionId)
Parameters
Type Name Description
System.Int32 regionId

Region id.
Returns
Type Description
System.Threading.Tasks.Task<System.String>

Name of region.

See Also