Customer

OBJECT

Definition

1 type Customer {
2   entityId: Int!
3   company: String!
4   customerGroupId: Int!
5   customerGroupName: String
6   email: String!
7   firstName: String!
8   lastName: String!
9   notes: String!
10   phone: String!
11   taxExemptCategory: String!
12   addressCount: Int!
13   attributeCount: Int!
14   storeCredit: [Money!]!
15   attributes: CustomerAttributes!
16   wishlists(filters: WishlistFiltersInput, before: String, after: String, first: Int, last: Int): WishlistConnection!
17   formFields: [CustomerFormFieldValue!]!
18   addresses(before: String, after: String, first: Int, last: Int): AddressConnection!
19   activeCompany: ActiveCompany
20   metafields(namespace: String!, keys: [String!], before: String, after: String, first: Int, last: Int): MetafieldConnection!
21   orders(filters: OrdersFiltersInput, before: String, after: String, first: Int, last: Int): OrdersConnection
22   isSubscribedToNewsletter: Boolean!
23   notificationPreferences: [String!]!
24   storedPaymentInstruments(filters: StoredPaymentInstrumentsFiltersInput, before: String, after: String, first: Int, last: Int): StoredPaymentInstrumentConnection!
25 }

A customer that shops on a store

Fields

entityIdIntegerRequired

The ID of the customer.

companyStringRequired

The company name of the customer.

customerGroupIdIntegerRequired

The customer group id of the customer.

emailStringRequired

The email address of the customer.

firstNameStringRequired

The first name of the customer.

lastNameStringRequired

The last name of the customer.

phoneStringRequired

The phone number of the customer.

taxExemptCategoryStringRequired

The tax exempt category of the customer.

attributeCountIntegerRequired

Customer attributes count.

storeCreditlist of MoneysRequired

Customer store credit.

attributesCustomerAttributesRequired

Customer attributes.

wishlistsWishlistConnectionRequired

Customer wishlists.

formFieldslist of CustomerFormFieldValuesRequired

The form field values of the customer.

addressesAddressConnectionRequired

Customer addresses.

metafieldsMetafieldConnectionRequired

Metafield data related to a customer.

isSubscribedToNewsletterBooleanRequired

Indicates whether the customer is subscribed to the store's newsletter.

storedPaymentInstrumentsStoredPaymentInstrumentConnectionRequired

Stored payment instruments for the authenticated customer.

notesStringRequiredDeprecated

The notes of the customer.

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

addressCountIntegerRequiredDeprecated

Customer addresses count.

Deprecated: Use addresses.collectionInfo.totalItems instead.

notificationPreferenceslist of StringsRequiredDeprecated

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.

Referenced by

Queries

customer