Address details including pincode, phone, id, country code, geolocation, country, state, city, landmark, email, etc.
Fields
_custom_json
JSONCustom JSON for address. Example: { instructions: 'Leave at the gate' }
address
StringAddress line(s). Example: '221B Baker Street'
address_type
StringType of address. Example: 'home'
area
StringArea/locality. Example: 'Andheri East'
area_code
StringArea code. Example: '400059'
area_code_slug
StringArea code slug (e.g., pincode in India). Example: 'pincode'
checkout_mode
StringCheckout mode associated with this address (e.g., 'self', 'other'). Example: 'self'
city
StringCity of the address (e.g., Mumbai). Example: 'Mumbai'
country
StringCountry of the address (e.g., India). Example: 'India'
country_code
StringCountry phone code (e.g., '+91'). Example: '+91'
country_iso_code
StringCountry ISO code (e.g., IN). Example: 'IN'
country_phone_code
StringCountry phone code (e.g., '+91'). Example: '+91'
created_by_user_id
StringUser ID that created this address. Example: 'usr_123'
email
StringEmail address. Example: 'john.doe@example.com'
geo_location
GeoLocationInputGeolocation coordinates. Example: { latitude: 19.076, longitude: 72.8777 }
google_map_point
JSONGoogle Maps geometry point. Example: { type: 'Point', coordinates: [72.8777, 19.076] }
id
StringAddress identifier. Example: 'addr_001'
is_active
BooleanWhether the address is active. Example: true
is_default_address
BooleanWhether this is the default address. Example: false
landmark
StringLandmark. Example: 'Near City Mall'
meta
JSONAdditional metadata. Example: { floor: '2nd' }
name
StringFull name. Example: 'John Doe'
phone
StringPhone number. Example: '9876543210'
sector
StringSector/Block. Example: 'Sector 21'
pincode
StringPostal code or PIN code of the address area.
state
StringState. Example: 'Maharashtra'
state_code
StringState code. Example: 'MH'
tags
[String]Tags to identify the address. Example: ['home', 'default']
user_id
StringUser ID the address belongs to. Example: 'usr_123'
Was this section helpful?