Get a specific customer address stored in the system by providing its unique identifier. This API provides detailed information about the address, including the recipient's name, address, city, postal code, and other relevant details.
Arguments
id
String!Required
ID allotted to the selected address. Example: 'addr_001'
buyNow
BooleanWhether to get a Buy Now cart. Example: false
cartId
StringThe unique identifier of the user cart. Example: '5bb521cfdc83215e1889b346'
checkoutMode
StringOption to checkout for self or for others (e.g., 'self', 'other'). Example: 'self'
isDefault
BooleanSelect true to fetch the default address. Example: true
mobileNo
StringMobile number of the customer. Example: '9876543210'
tags
StringTag for the address (e.g., work, home, office, shop). Example: 'home'
Response
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'
app_id
StringSales channel id.
city
StringCity of the address (e.g., Mumbai). Example: 'Mumbai'
country
StringCountry of 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 the address. Example: 'usr_123'
email
StringEmail address. Example: 'john.doe@example.com'
geo_location
GeoLocationGeolocation 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'
state
StringState. Example: 'Maharashtra'
tags
[String]Tags to identify the address. Example: ['home', 'default']
uid
IntNumeric UID associated with the address. Example: 101
user_id
StringUser ID the address belongs to. Example: 'usr_123'
sector
StringSector/Block. Example: 'Sector 21'
state_code
StringState code. Example: 'MH'
is_anonymous
BooleanWhether address belongs to an anonymous user. Example: false
Query
Try it
Input Variables
Response
Was this section helpful?