Address Field Mappings

Our recommended commonly used field mappings.

Universal Response Objects

We have three different types of objects suited to primary business regions being Australia, New Zealand and International (rest of world).

We've created universal response components to enable consistent information no matter which address object best suits your business need.

When integrating to a platform we recommend using the universal response objects for mapping for consistency and scale across regions.

Recommended field mappings

This fields remain constant across AU, NZ and INTL address response packages. We recommend using this mapping to reduce integration effort.

We have very detailed response allowing you to full customise how you want to compile any address component.

Generic Field	Recommended mapping	Description
Building names	buildingName	Building Name component of the address (e.g. 'ANZAC HOUSE').
Subdwelling (long)	subdwelling	Compiled subdwelling components of the address 'UNIT 2'. This includes subdwelling, floor, block and lot information.
Street number	streetNumber	Street Number component of the address '45A'
Street name	street	Compiled Street Name and Street Type. 'HIGH STREET'
City/Locality/Suburb	attributes.City	A smaller region contained in a Province. Australia known as Locality, in NZ is Suburb, around the world it can be City.
Zip/Postcode	postcode	Postcode or ZIP code of address
Region/State/Province (Short)	attributes.ProvinceCode	This is the highest region contained within a country. 'VIC'
Region/State/Province (Long)	attributes.ProvinceName	This is the highest region contained within a country. 'Victoria'
Country2 (Short)	attributes.CountryIso2	Country in ISO2 format. 'AU'
Country3 (Short)	attributes.CountryIso3	Country in ISO3 format. 'AUS'
Country (Long)	country	Country in full text. 'Australia'
Latitude	attributes.Latitude	Geocode of latitude "-34.77910653"
Longitude	attributes.Longitude	Geocode of longitude "139.55428910"

Components for labels or integration

Every supplier has a preferred configuration. We give you the tools to compile as you need to fit your use case.

Example 1: Australia Post Standard

AUPAF barcode: {attributes.Barcode}

Address Line 1: {buildingName} {subdwelling} {userInferred}

Address Line 2: {streetNumber} {street} {streetSuffix}

Address Line 3: {attributes.City} {attributes.ProvinceCode} {postcode} {attributes.CountryIso3}

Example 2: American Standard

Address Line 1: {streetNumber} {street} {streetSuffix}

Address Line 2: {buildingName} {subdwelling} {userInferred}

Address Line 3: {attributes.City} {attributes.ProvinceCode} {postcode} {attributes.CountryIso2}

Example 3: Two lines with regions

Address Line 1: {streetNumber} {street} {streetSuffix}

Address Line 2: {buildingName} {subdwelling} {userInferred}

City: {attributes.City}

Zip: {postcode}

Province code: {attributes.ProvinceCode}

Country code: {attributes.CountryIso2}