Skip to navigation
GraphQLStorefrontQueries

customer

The currently logged in customer.

Returns

an optional Customer
entityIdInteger
The ID of the customer.
companyString
The company name of the customer.
customerGroupIdInteger
The customer group id of the customer.
emailString
The email address of the customer.
firstNameString
The first name of the customer.
lastNameString
The last name of the customer.
phoneString
The phone number of the customer.
taxExemptCategoryString
The tax exempt category of the customer.
attributeCountInteger
Customer attributes count.
storeCreditlist of Moneys
Customer store credit.
attributesCustomerAttributes
Customer attributes.
wishlistsWishlistConnection
Customer wishlists.
formFieldslist of CustomerFormFieldValues
The form field values of the customer.
addressesAddressConnection
Customer addresses.
metafieldsMetafieldConnection
Metafield data related to a customer.
isSubscribedToNewsletterBoolean
Indicates whether the customer is subscribed to the store's newsletter.
storedPaymentInstrumentsStoredPaymentInstrumentConnection
Stored payment instruments for the authenticated customer.
notesStringDeprecated

The notes of the customer.

Deprecated: Notes aren’t supported in Storefront GQL API. This will output an empty string.

addressCountIntegerDeprecated

Customer addresses count.

Deprecated: Use addresses.collectionInfo.totalItems instead.

notificationPreferenceslist of StringsDeprecated

The customer’s notification preferences.

Deprecated: Alpha version. Do not use in production.

customerGroupNameStringOptional
The customer group name of the customer.
activeCompanyActiveCompanyOptional
The customer's active company context, or null when the shopper is not an authenticated customer.
ordersOrdersConnectionOptional
The Orders for the customer.