Regions, countries, and states
Regions are configurable groupings of countries. They are most commonly used to represent eCommerce sites or geographic markets, but can be used to group any set of countries for incentive scoping, reporting, or segmentation. Omneo ships with a built-in database of all countries and sub-regions (states, counties, provinces) using their ISO standard names and codes. This reference data is available for use across profiles, locations, and organisations without any additional configuration. A region can also carry acurrency (ISO 4217 format). The currency travels with the region wherever the API or an event context names it: on a Profile’s region and regions memberships, on Definitions and rates scoped to a region, on countries included with their region, and on a location’s region in event contexts. A region with no currency returns currency: null.
Point, reward, credit, and benefit Definitions can each be scoped to a region with region_id. A Definition with no region is usable in every region.
Profile localisation
A profile can have a default Region, with optional country and state refinements. These values can be:- Inherited from the location where the profile was created or last transacted
- Set explicitly based on the customer’s address or registration details
- Updated as the customer’s behaviour changes (for example, shopping in a different country)
Currencies
Every profile has acurrency field (ISO 4217 format, e.g., AUD, USD, GBP). Omneo uses this to store financial values consistently across markets.
Omneo maintains a daily exchange rate reference. When a transaction or order is recorded in a foreign currency, Omneo can convert the value to the tenant’s default currency for reporting. Brands can also configure fixed exchange rates to keep reporting figures consistent rather than subject to daily market movement.
If no currency is set on a profile, Omneo applies the tenant’s default currency.
Regional balances
A Profile’s balances are what they can spend in their active region. The totals include Incentives issued by a Definition in that region, plus Incentives whose Definition names no region. Incentives issued in another region are left out, matching what the Profile can redeem there. A Profile with no active region, or a tenant whose Definitions name no region, sees every unexpired Incentive in the totals. The balance fields on the Profile itself (reward_balance, point_balance, and so on) follow the same rule.
The totals are in the currency of the Profile’s region, not the Profile’s own currency field. A Profile in a region with no currency, or in no region, keeps the tenant’s default currency. Requesting a balance in a different currency converts from that base currency using the configured exchange rate for the pair.
Alongside the totals, the balance response names the region it was calculated for and returns a regions breakdown: one entry per region in the tenant, plus one for Incentives that name no region, each with its own currency. The breakdown shows everything the Profile holds, including what another region issued, so the entries do not add up to the totals. See the Balances API for the full response.