query

addresses

List all addresses saved by the customer, simplifying the checkout process by offering pre-saved address options for delivery.
Arguments
buyNow
Boolean
Whether to get buy_now cart.
cartId
String
The unique identifier of the user cart.
checkoutMode
String
Option to checkout for self or for others.
isDefault
Boolean
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
address
[Address]
Address description for address data.
pii_masking
Boolean
Personally Identifiable Information masking flag to denote if the user data in address is masked or not.
validation_config
ValidationConfig
Defines validation rules for user addresses.
Query
1query addresses(
2 $buyNow: Boolean
3 $cartId: String
4 $checkoutMode: String
5 $isDefault: Boolean
6 $mobileNo: String
7 $tags: String
8) {
9 addresses(
10 buyNow: $buyNow
11 cartId: $cartId
12 checkoutMode: $checkoutMode
13 isDefault: $isDefault
14 mobileNo: $mobileNo
15 tags: $tags
16 ) {
17 address {
18 custom_json
19 address
20 address_type
21 area
22 area_code
23 area_code_slug
24 checkout_mode
25 app_id
26 city
27 country
28 country_code
29 country_iso_code
30 country_phone_code
31 created_by_user_id
32 email
33 google_map_point
34 id
35 is_active
36 is_default_address
37 landmark
38 meta
39 name
40 phone
41 state
42 tags
43 uid
44 user_id
45 sector
46 state_code
47 is_anonymous
48 }
49 pii_masking
50 validation_config {
51 address_max_limit
52 user_address_count
53 }
54 }
55}
Try it
Input Variables
1{
2 "buyNow": true,
3 "cartId": "cartId",
4 "checkoutMode": "checkoutMode",
5 "isDefault": true,
6 "mobileNo": "mobileNo",
7 "tags": "tags"
8}
Response
1{
2 "addresses": {
3 "address": [
4 {
5 "custom_json": {},
6 "address": "2832 Sesame Street",
7 "address_type": "address_type",
8 "area": "area",
9 "area_code": "area_code",
10 "area_code_slug": "area_code_slug",
11 "checkout_mode": "checkout_mode",
12 "app_id": "app_id",
13 "city": "Montreal",
14 "country": "Canada",
15 "country_code": "country_code",
16 "country_iso_code": "country_iso_code",
17 "country_phone_code": "country_phone_code",
18 "created_by_user_id": "created_by_user_id",
19 "email": "test-email@yourcompany.com",
20 "google_map_point": {},
21 "id": "08a16b83-9094-4e89-8c05-2ccadd5c1c7e",
22 "is_active": true,
23 "is_default_address": true,
24 "landmark": "landmark",
25 "meta": {},
26 "name": "A name",
27 "phone": "1+ 418-323-4236",
28 "state": "Quebec",
29 "tags": [
30 "tags"
31 ],
32 "uid": 42,
33 "user_id": "user_id",
34 "sector": "sector",
35 "state_code": "state_code",
36 "is_anonymous": true
37 }
38 ],
39 "pii_masking": true,
40 "validation_config": {
41 "address_max_limit": 30.7,
42 "user_address_count": 42
43 }
44 }
45}