Customer object

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 email marketing.

Required access

read_customers access scope.

On this page

Connections

  • events ([EventConnection!](https://shopify.dev/docs/admin-api/graphql/reference/events/eventconnection))
    A list of events associated with the customer.
Argument Description
after
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come after the specified cursor.
before
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come before the specified cursor.
first
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the first n elements from the list.
last
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the last n elements from the list.
query
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Supported filter parameters:
+ comments
+ created_at
+ subject_type
+ verb
See the detailed search syntax for more information about using filters.
reverse
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Reverse the order of the underlying list.
Default value: false
sortKey
(
[EventSortKeys](https://shopify.dev/docs/admin-api/graphql/reference/events/eventsortkeys)

)		 Sort the underlying list by the given key.
Default value: ID
  • metafields ([MetafieldConnection!](https://shopify.dev/docs/admin-api/graphql/reference/metafields/metafieldconnection))
    A paginated list of metafields associated with the resource.
Argument Description
after
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come after the specified cursor.
before
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come before the specified cursor.
first
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the first n elements from the list.
last
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the last n elements from the list.
namespace
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Finds all metafields with a specific namespace under the resource.
reverse
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Reverse the order of the underlying list.
Default value: false
  • orders ([OrderConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/order))
    A list of the customer’s orders.
Argument Description
after
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come after the specified cursor.
before
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come before the specified cursor.
first
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the first n elements from the list.
last
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the last n elements from the list.
query
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Supported filter parameters:
+ cart_token
+ channel_id
+ chargeback_status
+ checkout_token
+ created_at
+ credit_card_last4
+ customer_id
+ delivery_method
+ discount_code
+ email
+ financial_status
+ fraud_protection_level
+ fulfillment_location_id
+ fulfillment_status
+ location_id
+ name
+ processed_at
+ reference_location_id
+ return_status
+ risk_level
+ sales_channel
+ source_identifier
+ source_name
+ status
+ tag
+ test
+ updated_at
See the detailed search syntax for more information about using filters.
reverse
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Reverse the order of the underlying list.
Default value: false
sortKey
(
[OrderSortKeys](https://shopify.dev/docs/admin-api/graphql/reference/orders/ordersortkeys)

)		 Sort the underlying list by the given key.
Default value: ID
  • paymentMethods ([CustomerPaymentMethodConnection!](https://shopify.dev/docs/admin-api/graphql/reference/customers/customerpaymentmethod))
    A list of the customer’s payment methods.
Argument Description
after
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come after the specified cursor.
before
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come before the specified cursor.
first
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the first n elements from the list.
last
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the last n elements from the list.
reverse
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Reverse the order of the underlying list.
Default value: false
showRevoked
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Whether to show the customer’s revoked payment method.
Default value: false
  • privateMetafields ([PrivateMetafieldConnection!](https://shopify.dev/docs/admin-api/graphql/reference/metafields/privatemetafieldconnection))
    List of private metafields.
Argument Description
after
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come after the specified cursor.
before
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come before the specified cursor.
first
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the first n elements from the list.
last
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the last n elements from the list.
namespace
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Filter the private metafields by namespace.
reverse
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Reverse the order of the underlying list.
Default value: false
  • subscriptionContracts ([SubscriptionContractConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptioncontract))
    A list of the customer’s subscription contracts.
Argument Description
after
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come after the specified cursor.
before
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come before the specified cursor.
first
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the first n elements from the list.
last
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the last n elements from the list.
reverse
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Reverse the order of the underlying list.
Default value: false

Fields

  • acceptsMarketing ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
    Whether the customer has agreed to receive marketing materials.
  • acceptsMarketingUpdatedAt ([DateTime!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
    The date and time when the customer consented or objected to receiving marketing material by email.
  • addresses ([[MailingAddress!]!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/mailingaddress))
    A list of addresses associated with the customer.
Argument Description
first
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Truncate the array result to this size.
  • averageOrderAmountV2 ([MoneyV2](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneyv2))
    The average amount that the customer spent per order.
  • canDelete ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
    Whether the merchant can delete the customer from their store.
    A customer can be deleted from a store only if they have not yet made an order. After a customer makes an order, they can’t be deleted from a store.
  • createdAt ([DateTime!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
    The date and time when the customer was added to the store.
  • defaultAddress ([MailingAddress](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/mailingaddress))
    The default address associated with the customer.
  • displayName ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    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](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The customer’s email address.
  • firstName ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The customer’s first name.
  • hasNote ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
    Whether the customer has a note associated with them.
  • hasTimelineComment ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
    Whether the merchant has added timeline comments about the customer on the customer’s page.
  • id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    Globally unique identifier.
  • image ([Image!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/image))
    The image associated with the customer.
Argument Description
size
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Image width and height (1 - 2048 pixels) This argument is deprecated: Use maxWidth or maxHeight on Image.transformedSrc instead.
  • lastName ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The customer’s last name.
  • lastOrder ([Order](https://shopify.dev/docs/admin-api/graphql/reference/orders/order))
    The customer’s last order.
  • legacyResourceId ([UnsignedInt64!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#unsignedint64-2021-01))
    The ID of the corresponding resource in the REST Admin API.
  • lifetimeDuration ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The amount of time since the customer was first added to the store.
    Example: ‘about 12 years’.
  • locale ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The customer’s locale.
  • marketingOptInLevel ([CustomerMarketingOptInLevel](https://shopify.dev/docs/admin-api/graphql/reference/customers/customermarketingoptinlevel))
    The marketing subscription opt-in level (as described by the M3AAWG best practices guideline) that the customer gave when they consented to receive marketing material by email.
    If the customer does not accept email marketing, then this property will be null.
  • metafield ([Metafield](https://shopify.dev/docs/admin-api/graphql/reference/metafields/metafield))
    The metafield associated with the resource.
Argument Description
key
(
[String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

) REQUIRED		 Identifier for the metafield (maximum of 30 characters).
namespace
(
[String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

) REQUIRED		 Container for a set of metafields (maximum of 20 characters).
  • multipassIdentifier ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    A unique identifier for the customer that’s used with Multipass login.
  • note ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    A note about the customer.
  • ordersCount ([UnsignedInt64!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#unsignedint64-2021-01))
    The number of orders that the customer has made at the store in their lifetime.
  • phone ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The customer’s phone number.
  • privateMetafield ([PrivateMetafield](https://shopify.dev/docs/admin-api/graphql/reference/metafields/privatemetafield))
    Returns a private metafield found by namespace and key.
Argument Description
key
(
[String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

) REQUIRED		 The key for the private metafield.
namespace
(
[String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

) REQUIRED		 The namespace for the private metafield.
  • productSubscriberStatus ([CustomerProductSubscriberStatus!](https://shopify.dev/docs/admin-api/graphql/reference/customers/customerproductsubscriberstatus))
    Possible subscriber states of a customer defined by their subscription contracts.
  • state ([CustomerState!](https://shopify.dev/docs/admin-api/graphql/reference/customers/customerstate))
    The state of the customer’s account with the shop.
  • tags ([[String!]!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    A comma separated list of tags that have been added to the customer.
  • taxExempt ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
    Whether the customer is exempt from being charged taxes on their orders.
  • taxExemptions ([[TaxExemption!]!](https://shopify.dev/docs/admin-api/graphql/reference/customers/taxexemption))
    The list of tax exemptions applied to the customer.
  • totalSpent ([Money!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#money-2021-01))
    The total amount that the customer has spent on orders in their lifetime.
  • totalSpentV2 ([MoneyV2!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneyv2))
    The total amount that the customer has spent on orders in their lifetime.
  • updatedAt ([DateTime!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
    The date and time when the customer was last updated.
  • validEmailAddress ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
    Whether the email address is formatted correctly. This does not guarantee that the email address actually exists.
  • verifiedEmail ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
    Whether the customer has verified their email address. Defaults to true if the customer is created through the Shopify admin or API.

Types that return Customer

  • [CalculatedDraftOrder.customer](https://shopify.dev/docs/admin-api/graphql/reference/orders/calculateddraftorder#customer-2021-01)
  • [CustomerPaymentMethod.customer](https://shopify.dev/docs/admin-api/graphql/reference/customers/customerpaymentmethod#customer-2021-01)
  • [DiscountCustomers.customers](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/discountcustomers#customers-2021-01)
  • [DraftOrder.customer](https://shopify.dev/docs/admin-api/graphql/reference/orders/draftorder#customer-2021-01)
  • [Order.customer](https://shopify.dev/docs/admin-api/graphql/reference/orders/order#customer-2021-01)
  • [PriceRuleCustomerSelection.customers](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/pricerulecustomerselection#customers-2021-01)
  • [QueryRoot.customer](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/queryroot#customer-2021-01)
  • [QueryRoot.customers](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/queryroot#customers-2021-01)
  • [SubscriptionContract.customer](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptioncontract#customer-2021-01)
  • [SubscriptionDraft.customer](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptiondraft#customer-2021-01)

Mutations for Customer

Implements

  • [CommentEventSubject](https://shopify.dev/docs/admin-api/graphql/reference/events/commenteventsubject)
  • [HasEvents](https://shopify.dev/docs/admin-api/graphql/reference/events/hasevents)
  • [HasMetafields](https://shopify.dev/docs/admin-api/graphql/reference/metafields/hasmetafields)
  • [LegacyInteroperability](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/legacyinteroperability)
  • [Node](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/node)

Deprecated fields

An auto-generated type for paginating through multiple Customers.

On this page

Fields

  • edges ([[CustomerEdge!]!](https://shopify.dev/docs/admin-api/graphql/reference/customers/customer))
    A list of edges.
  • pageInfo ([PageInfo!](https://shopify.dev/docs/admin-api/graphql/reference/pageinfo))
    Information to aid in pagination.

An auto-generated type which holds one Customer and a cursor during pagination.

On this page

Fields

  • cursor ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    A cursor for use in pagination.
  • node ([Customer!](https://shopify.dev/docs/admin-api/graphql/reference/customers/customer))
    The item at the end of CustomerEdge.

Types that return CustomerEdge

  • [CustomerConnection.edges](https://shopify.dev/docs/admin-api/graphql/reference/customers/customer#edges-2021-01)