Shopify uses cookies to provide necessary site functionality and improve your experience. By using our website, you agree to our privacy policy and our cookie policy.
Represents information about a customer of the shop, such as the customer's contact details, their order
history, and whether they've agreed to receive marketing material by email.
Caution: Only use this data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.
addresses•
[MailingAddress!]!
non-null
A list of addresses associated with the customer.
amountSpent•
MoneyV2!
non-null
The total amount that the customer has spent on orders in their lifetime.
canDelete•
Boolean!
non-null
Whether the merchant can delete the customer from their store.
A customer can be deleted from a store only if they haven't yet made an order. After a customer makes an
order, they can't be deleted from a store.
companyContactProfiles•
[CompanyContact!]!
non-null
A list of the customer's company contact profiles.
createdAt•
DateTime!
non-null
The date and time when the customer was added to the store.
dataSaleOptOut•
Boolean!
non-null
Whether the customer has opted out of having their data sold.
defaultAddress•
MailingAddress
The default address associated with the customer.
displayName•
String!
non-null
The full name of the customer, based on the values for first_name and last_name. If the first_name and
last_name are not available, then this falls back to the customer's email address, and if that is not available, the customer's phone number.
events•
EventConnection!
non-null
A list of events associated with the customer.
firstName•
String
The customer's first name.
id•
ID!
non-null
A globally-unique ID.
image•
Image!
non-null
The image associated with the customer.
lastName•
String
The customer's last name.
lastOrder•
Order
The customer's last order.
legacyResourceId•
UnsignedInt64!
non-null
The ID of the corresponding resource in the REST Admin API.
lifetimeDuration•
String!
non-null
The amount of time since the customer was first added to the store.
Example: 'about 12 years'.
locale•
String!
non-null
The customer's locale.
market•
Market
The market that includes the customer’s default address.
mergeable•
CustomerMergeable!
non-null
Whether the customer can be merged with another customer.
metafield•
Metafield
A custom field,
including its namespace and key, that's associated with a Shopify resource
for the purposes of adding and storing additional information.
metafields•
MetafieldConnection!
non-null
A list of custom fields
that a merchant associates with a Shopify resource.
multipassIdentifier•
String
A unique identifier for the customer that's used with Multipass login.
note•
String
A note about the customer.
numberOfOrders•
UnsignedInt64!
non-null
The number of orders that the customer has made at the store in their lifetime.
orders•
OrderConnection!
non-null
A list of the customer's orders.
paymentMethods•
CustomerPaymentMethodConnection!
non-null
A list of the customer's payment methods.
productSubscriberStatus•
CustomerProductSubscriberStatus!
non-null
Possible subscriber states of a customer defined by their subscription contracts.
state•
CustomerState!
non-null
The state of the customer's account with the shop.
Please note that this only meaningful when Classic Customer Accounts is active.
statistics•
CustomerStatistics!
non-null
The statistics for a given customer.
storeCreditAccounts•
StoreCreditAccountConnection!
non-null
Returns a list of store credit accounts that belong to the owner resource.
A store credit account owner can hold multiple accounts each with a different currency.
subscriptionContracts•
SubscriptionContractConnection!
non-null
A list of the customer's subscription contracts.
tags•
[String!]!
non-null
A comma separated list of tags that have been added to the customer.
taxExempt•
Boolean!
non-null
Whether the customer is exempt from being charged taxes on their orders.
taxExemptions•
[TaxExemption!]!
non-null
The list of tax exemptions applied to the customer.
updatedAt•
DateTime!
non-null
The date and time when the customer was last updated.
verifiedEmail•
Boolean!
non-null
Whether the customer has verified their email address. Defaults to true if the customer is created through the Shopify admin or API.
email•
String
Deprecated
The customer's email address. Use defaultEmailAddress.emailAddress instead.
emailMarketingConsent•
CustomerEmailMarketingConsentState
Deprecated
The current email marketing state for the customer.
If the customer doesn't have an email address, then this property is null. Use defaultEmailAddress.marketingState, defaultEmailAddress.marketingOptInLevel, defaultEmailAddress.marketingUpdatedAt, and defaultEmailAddress.sourceLocation instead.
hasTimelineComment•
Boolean!
non-nullDeprecated
Whether the merchant has added timeline comments about the customer on the customer's page. To query for comments on the timeline, use the events connection and a query argument containing verb:comment, or look for a CommentEvent in the __typename of events.
metafieldDefinitions•
MetafieldDefinitionConnection!
non-nullDeprecated
List of metafield definitions. This field will be removed in a future version. Use the root metafieldDefinitions field instead.
phone•
String
Deprecated
The customer's phone number. Use defaultPhoneNumber.phoneNumber instead.
privateMetafield•
PrivateMetafield
Deprecated
Returns a private metafield by namespace and key that belongs to the resource. Metafields created using a reserved namespace are private by default. See our guide for
migrating private metafields.
privateMetafields•
PrivateMetafieldConnection!
non-nullDeprecated
List of private metafields that belong to the resource. Metafields created using a reserved namespace are private by default. See our guide for
migrating private metafields.
smsMarketingConsent•
CustomerSmsMarketingConsentState
Deprecated
The current SMS marketing state for the customer's phone number.
If the customer does not have a phone number, then this property is null. Use defaultPhoneNumber.marketingState, defaultPhoneNumber.marketingOptInLevel, defaultPhoneNumber.marketingUpdatedAt, defaultPhoneNumber.marketingCollectedFrom, and defaultPhoneNumber.sourceLocation instead.
unsubscribeUrl•
URL!
non-nullDeprecated
The URL to unsubscribe the customer from the mailing list. Use defaultEmailAddress.marketingUnsubscribeUrl instead.
validEmailAddress•
Boolean!
non-nullDeprecated
Whether the email address is formatted correctly.
Returns true when the email is formatted correctly and
belongs to an existing domain. This doesn't guarantee that
the email address actually exists. Use defaultEmailAddress.validFormat instead.
