query

address

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
Required
ID allotted to the selected address.
buyNow
Boolean
Whether to get a buy_now cart.
cartId
String
The unique identifier of the user cart.
checkoutMode
String
Option to checkout for self or for others.
isDefault
Boolean
This is a boolean value. Select `true` to fetch the default address.
mobileNo
String
Mobile number of the customer.
tags
String
Tag given to an address, e.g. work, home, office, shop.
Response
custom_json
JSON
Custom json of the address.
address
String
Address description for address data.
address_type
String
Address type of address.
area
String
Area description for address.
area_code
String
Area code of the address.
area_code_slug
String
Area code slug for address. example pincode is slug for India.
checkout_mode
String
Checkout mode of address on which address to be used for which checkout mode of cart.
app_id
String
Sales channel id.
city
String
City of the address.
country
String
Country of address.
country_code
String
Country code of address.
country_iso_code
String
Country iso code for address.
country_phone_code
String
Country phone code for address.
created_by_user_id
String
Created by user id of address.
email
String
Email address for address data.
geo_location
GeoLocation
Geolocation details for address data.
google_map_point
JSON
Google map point of the address.
Id of the address.
is_active
Boolean
States whether address is active or not.
is_default_address
Boolean
Default address flag if no address selected then this should be the default address selected.
landmark
String
Landmark of address.
meta
JSON
Metadata of the address.
name
String
Name of person in address data to whom it belongs to.
phone
String
Phone number for address.
state
String
State of the address.
Tags of address from which it can be identified.
uid
Int
Unique id associated with the address.
user_id
String
User id of address for which address is created.
sector
String
Sector of the address.
state_code
String
State code for address.
is_anonymous
Boolean
Is address anonymous or not.
Query
1query address(
2 $id: String!
3 $buyNow: Boolean
4 $cartId: String
5 $checkoutMode: String
6 $isDefault: Boolean
7 $mobileNo: String
8 $tags: String
9) {
10 address(
11 id: $id
12 buyNow: $buyNow
13 cartId: $cartId
14 checkoutMode: $checkoutMode
15 isDefault: $isDefault
16 mobileNo: $mobileNo
17 tags: $tags
18 ) {
19 custom_json
20 address
21 address_type
22 area
23 area_code
24 area_code_slug
25 checkout_mode
26 app_id
27 city
28 country
29 country_code
30 country_iso_code
31 country_phone_code
32 created_by_user_id
33 email
34 geo_location {
35 latitude
36 longitude
37 }
38 google_map_point
39 id
40 is_active
41 is_default_address
42 landmark
43 meta
44 name
45 phone
46 state
47 tags
48 uid
49 user_id
50 sector
51 state_code
52 is_anonymous
53 }
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.7
21 },
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": true
39 }
40}