For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
  • GraphQL
    • Overview
      • Playground
      • Explorer
          • QUERYsite
          • QUERYchannel
          • QUERYcustomer
          • QUERYnode
          • QUERYlocations
          • QUERYshopperPreferences
          • QUERYstore
          • QUERYcountries
  • MCP
    • Overview
Dev Portal
LogoLogo
GraphQLStorefrontQueries

customer

Example Query
1query ExampleQuery {
2  customer {
3    entityId
4    company
5    customerGroupId
6    customerGroupName
7    email
8    firstName
9    lastName
10    notes
11    phone
12    taxExemptCategory
13  }
14}
Example response
1{
2  "data": {
3    "customer": {
4      "entityId": 0,
5      "company": "example",
6      "customerGroupId": 0,
7      "customerGroupName": "example",
8      "email": "example",
9      "firstName": "example",
10      "lastName": "example",
11      "notes": "example",
12      "phone": "example",
13      "taxExemptCategory": "example"
14    }
15  }
16}
The currently logged in customer.
Was this page helpful?
Previous

channel

Next

node

Built with

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.
notesString
The notes of the customer.
phoneString
The phone number of the customer.
taxExemptCategoryString
The tax exempt category of the customer.
addressCountInteger
Customer addresses count.
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.
notificationPreferenceslist of Strings
The customer's notification preferences.
customerGroupNameString
The customer group name of the customer.
ordersOrdersConnection
The Orders for the customer.