Documentation Home

Geolocation Data Transfer Object

The object that is returned from all Broadleaf geolocation API implementations is called a GeolocationDTO.

Attributes

Field Type Examples
Source java.lang.String FreeGeoIP
IP Address java.lang.String 8.8.8.8
Country Code java.lang.String US
Country Name java.lang.String United States
Region Code java.lang.String CA
Region Name java.lang.String California
City java.lang.String Mountain View
Postal Code java.lang.String 94035
Latitude java.lang.Double 37.386
Longitude java.lang.Double -122.0838

Missing Values from API Calls

If any of these values that are not obtained through the API call, then they are left as null.