List all addresses saved by the customer, simplifying the checkout process by offering pre-saved address options for delivery.
Arguments
buyNow
BooleanWhether to get buy_now cart.
cartId
StringThe unique identifier of the user cart.
checkoutMode
StringOption to checkout for self or for others.
isDefault
BooleanSelect `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
address
[Address]Address description for address data.
pii_masking
BooleanPersonally Identifiable Information masking flag to denote if the user data in address is masked or not.
validation_config
ValidationConfigDefines validation rules for user addresses.
Query
1query addresses(2 $buyNow: Boolean3 $cartId: String4 $checkoutMode: String5 $isDefault: Boolean6 $mobileNo: String7 $tags: String8) {9 addresses(10 buyNow: $buyNow11 cartId: $cartId12 checkoutMode: $checkoutMode13 isDefault: $isDefault14 mobileNo: $mobileNo15 tags: $tags16 ) {17 address {18 custom_json19 address20 address_type21 area22 area_code23 area_code_slug24 checkout_mode25 app_id26 city27 country28 country_code29 country_iso_code30 country_phone_code31 created_by_user_id32 email33 google_map_point34 id35 is_active36 is_default_address37 landmark38 meta39 name40 phone41 state42 tags43 uid44 user_id45 sector46 state_code47 is_anonymous48 }49 pii_masking50 validation_config {51 address_max_limit52 user_address_count53 }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": true37 }38 ],39 "pii_masking": true,40 "validation_config": {41 "address_max_limit": 30.7,42 "user_address_count": 4243 }44 }45}
Was this section helpful?