You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 19, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: guides/v2.3/graphql/reference/customer.md
+42-1Lines changed: 42 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -8,12 +8,17 @@ The `Customer` endpoint contains information about a customer account accessible
8
8
To return or modify information about a customer, Magento recommends you use customer tokens in the header of your GraphQL calls. However, you also can use [session authentication]({{ page.baseurl }}/get-started/authentication/gs-authentication-session.html).
9
9
10
10
## Queries
11
-
Use queries to read server-side data, such as a specific customer's address.
11
+
12
+
The `customer` query returns information about the logged-in customer.
13
+
14
+
The `isEmailAvailable` query checks whether the specified email has already been used to create a customer account. A value of `true` indicates the email address is available, and the customer can use the email address to create an account.
The customer object can contain the following attributes:
19
24
@@ -74,6 +79,18 @@ Attribute | Data Type | Description
74
79
`region` | String | The state or province name
75
80
`region_id` | Int | Uniquely identifies the region
76
81
82
+
### isEmailAvailable query attribute
83
+
84
+
Attribute | Data Type | Description
85
+
--- | --- | ---
86
+
`email` | String! | The email address to check
87
+
88
+
### IsEmailAvailableOutput attribute
89
+
90
+
Attribute | Data Type | Description
91
+
--- | --- | ---
92
+
`is_email_available` | Boolean | A value of `true` indicates the email address is available, and the customer can use the email address to create an account
93
+
77
94
### Example usage
78
95
79
96
The following call returns information about the logged-in customer. Provide the customer's token in the header section of the query.
@@ -140,6 +157,30 @@ The following call returns information about the logged-in customer. Provide the
140
157
}
141
158
```
142
159
160
+
The following example checks whether the email address `[email protected]` is available to create a customer account.
0 commit comments