For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Developer
Developer
Search docs
/
Ask AI
Dev Portal
Docs
API Reference
Learn
Community
Changelog
GraphQL
Storefront
Queries
customer
Copy page
The currently logged in customer.
Returns
an optional Customer
entityId
Integer
The ID of the customer.
company
String
The company name of the customer.
customerGroupId
Integer
The customer group id of the customer.
email
String
The email address of the customer.
firstName
String
The first name of the customer.
lastName
String
The last name of the customer.
notes
String
The notes of the customer.
phone
String
The phone number of the customer.
taxExemptCategory
String
The tax exempt category of the customer.
addressCount
Integer
Customer addresses count.
attributeCount
Integer
Customer attributes count.
storeCredit
list of Moneys
Customer store credit.
attributes
CustomerAttributes
Customer attributes.
wishlists
WishlistConnection
Customer wishlists.
formFields
list of CustomerFormFieldValues
The form field values of the customer.
addresses
AddressConnection
Customer addresses.
metafields
MetafieldConnection
Metafield data related to a customer.
isSubscribedToNewsletter
Boolean
Indicates whether the customer is subscribed to the store's newsletter.
notificationPreferences
list of Strings
The customer's notification preferences.
storedPaymentInstruments
StoredPaymentInstrumentConnection
Stored payment instruments for the authenticated customer.
customerGroupName
String
The customer group name of the customer.
orders
OrdersConnection
The Orders for the customer.