customerByIdentifier - admin-graphql - QUERY

Version: unstable

Description:

Return a customer by an identifier.

Access Scopes

`read_customers` access scope.

Arguments

  • identifier: CustomerIdentifierInput! - The identifier of the customer.

Returns

  • addresses: MailingAddress! A list of addresses associated with the customer.
  • amountSpent: MoneyV2! The total amount that the customer has spent on orders in their lifetime.
  • canDelete: Boolean! 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! A list of the customer's company contact profiles.
  • createdAt: DateTime! The date and time when the customer was added to the store.
  • dataSaleOptOut: Boolean! Whether the customer has opted out of having their data sold.
  • defaultAddress: MailingAddress The default address associated with the customer.
  • displayName: String! 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.
  • email: String The customer's email address.
  • emailMarketingConsent: CustomerEmailMarketingConsentState The current email marketing state for the customer. If the customer doesn't have an email address, then this property is `null`.
  • firstName: String The customer's first name.
  • hasTimelineComment: Boolean! Whether the merchant has added timeline comments about the customer on the customer's page.
  • id: ID! A globally-unique ID.
  • image: Image! The image associated with the customer.
  • lastName: String The customer's last name.
  • lastOrder: Order The customer's last order.
  • legacyResourceId: UnsignedInt64! The ID of the corresponding resource in the REST Admin API.
  • lifetimeDuration: String! The amount of time since the customer was first added to the store. Example: 'about 12 years'.
  • locale: String! The customer's locale.
  • market: Market The market that includes the customer’s default address.
  • mergeable: CustomerMergeable! Whether the customer can be merged with another customer.
  • metafield: Metafield A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information.
  • metafieldsByIdentifiers: Metafield! The metafields associated with the resource matching the supplied list of namespaces and keys.
  • multipassIdentifier: String A unique identifier for the customer that's used with Multipass login.
  • note: String A note about the customer.
  • numberOfOrders: UnsignedInt64! The number of orders that the customer has made at the store in their lifetime.
  • phone: String The customer's phone number.
  • productSubscriberStatus: CustomerProductSubscriberStatus! Possible subscriber states of a customer defined by their subscription contracts.
  • smsMarketingConsent: CustomerSmsMarketingConsentState 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`.
  • state: CustomerState! The state of the customer's account with the shop. Please note that this only meaningful when Classic Customer Accounts is active.
  • statistics: CustomerStatistics! The statistics for a given customer.
  • tags: String! A comma separated list of tags that have been added to the customer.
  • taxExempt: Boolean! Whether the customer is exempt from being charged taxes on their orders.
  • taxExemptions: TaxExemption! The list of tax exemptions applied to the customer.
  • unsubscribeUrl: URL! The URL to unsubscribe the customer from the mailing list.
  • updatedAt: DateTime! The date and time when the customer was last updated.
  • validEmailAddress: Boolean! 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.
  • verifiedEmail: Boolean! Whether the customer has verified their email address. Defaults to `true` if the customer is created through the Shopify admin or API.

Examples