Represents a collection of geographical locations, each associated with specific hierarchical data such as cities, states, or countries.
Fields
display_name
StringUser-friendly version of the geographical data, which may be more descriptive or formatted differently.
id
StringA unique identifier for the locality.
name
StringThe actual geographical data, such as country names (India), state names (Maharashtra), pin codes (400603), city names (Dubai), or local sectors (Deira).
parent_ids
[String]Identifiers for the parent of the current locality.
type
StringSpecifies the category of the address component, such as pincode, state, city, country, or sector.
localities
[LocalityParent]Representing the localities that are associated with or contained within the current locality.It provides detailed information about the parent localities, including their names, identifiers, and hierarchical relationships.
custom_meta
JSONCustom meta to store custom json against hierarchy.
parent_uid
StringUnique Identifiers for the parent of the current locality.
meta
JSONSpecifies the meta information for the current locality.
code
StringSpecifies the code for the locality.
Was this section helpful?