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.
buyNow
BooleanWhether to get a buy_now cart.
cartId
StringThe unique identifier of the user cart.
checkoutMode
StringOption to checkout for self or for others.
isDefault
BooleanThis is a boolean value. Select `true` to fetch the default address.
mobileNo
StringMobile number of the customer.
tags
StringTag given to an address, e.g. work, home, office, shop.
Response
custom_json
JSONCustom json of the address.
address
StringAddress description for address data.
address_type
StringAddress type of address.
area
StringArea description for address.
area_code
StringArea code of the address.
area_code_slug
StringArea code slug for address. example pincode is slug for India.
checkout_mode
StringCheckout mode of address on which address to be used for which checkout mode of cart.
app_id
StringSales channel id.
city
StringCity of the address.
country
StringCountry of address.
country_code
StringCountry code of address.
country_iso_code
StringCountry iso code for address.
country_phone_code
StringCountry phone code for address.
created_by_user_id
StringCreated by user id of address.
email
StringEmail address for address data.
geo_location
GeoLocationGeolocation details for address data.
google_map_point
JSONGoogle map point of the address.
id
StringId of the address.
is_active
BooleanStates whether address is active or not.
is_default_address
BooleanDefault address flag if no address selected then this should be the default address selected.
landmark
StringLandmark of address.
meta
JSONMetadata of the address.
name
StringName of person in address data to whom it belongs to.
phone
StringPhone number for address.
state
StringState of the address.
tags
[String]Tags of address from which it can be identified.
uid
IntUnique id associated with the address.
user_id
StringUser id of address for which address is created.
sector
StringSector of the address.
state_code
StringState code for address.
is_anonymous
BooleanIs address anonymous or not.
Query
1query address(2 $id: String!3 $buyNow: Boolean4 $cartId: String5 $checkoutMode: String6 $isDefault: Boolean7 $mobileNo: String8 $tags: String9) {10 address(11 id: $id12 buyNow: $buyNow13 cartId: $cartId14 checkoutMode: $checkoutMode15 isDefault: $isDefault16 mobileNo: $mobileNo17 tags: $tags18 ) {19 custom_json20 address21 address_type22 area23 area_code24 area_code_slug25 checkout_mode26 app_id27 city28 country29 country_code30 country_iso_code31 country_phone_code32 created_by_user_id33 email34 geo_location {35 latitude36 longitude37 }38 google_map_point39 id40 is_active41 is_default_address42 landmark43 meta44 name45 phone46 state47 tags48 uid49 user_id50 sector51 state_code52 is_anonymous53 }54}
Try it
Input Variables
1{2 "id": "08a16b83-9094-4e89-8c05-2ccadd5c1c7e",3 "buyNow": true,4 "cartId": "cartId",5 "checkoutMode": "checkoutMode",6 "isDefault": true,7 "mobileNo": "mobileNo",8 "tags": "tags"9}
Response
1{2 "address": {3 "custom_json": {},4 "address": "2832 Sesame Street",5 "address_type": "address_type",6 "area": "area",7 "area_code": "area_code",8 "area_code_slug": "area_code_slug",9 "checkout_mode": "checkout_mode",10 "app_id": "app_id",11 "city": "Montreal",12 "country": "Canada",13 "country_code": "country_code",14 "country_iso_code": "country_iso_code",15 "country_phone_code": "country_phone_code",16 "created_by_user_id": "created_by_user_id",17 "email": "test-email@yourcompany.com",18 "geo_location": {19 "latitude": 30.7,20 "longitude": 30.721 },22 "google_map_point": {},23 "id": "08a16b83-9094-4e89-8c05-2ccadd5c1c7e",24 "is_active": true,25 "is_default_address": true,26 "landmark": "landmark",27 "meta": {},28 "name": "A name",29 "phone": "1+ 418-323-4236",30 "state": "Quebec",31 "tags": [32 "tags"33 ],34 "uid": 42,35 "user_id": "user_id",36 "sector": "sector",37 "state_code": "state_code",38 "is_anonymous": true39 }40}
Was this section helpful?