Customer

A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout.

Required access

unauthenticated_read_customers access scope

Show definition

"""
A customer represents a customer account with the shop. Customer accounts store
contact information for the customer, saving logged-in customers the trouble of
having to provide it at every checkout.
"""
type Customer {
  """
  Indicates whether the customer has consented to be sent marketing material via email.
  """
  acceptsMarketing: Boolean!
  """
  A list of addresses for the customer.
  """
  addresses(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
  ): MailingAddressConnection!
  """
  The date and time when the customer was created.
  """
  createdAt: DateTime!
  """
  The customer’s default address.
  """
  defaultAddress: MailingAddress
  """
  The customer’s name, email or phone number.
  """
  displayName: String!
  """
  The customer’s email address.
  """
  email: String
  """
  The customer’s first name.
  """
  firstName: String
  """
  A unique identifier for the customer.
  """
  id: ID!
  """
  The customer's most recently updated, incomplete checkout.
  """
  lastIncompleteCheckout: Checkout
  """
  The customer’s last name.
  """
  lastName: String
  """
  The orders associated with the customer.
  """
  orders(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first n elements from the list.
    """
    first: Int
    """
    Returns up to the last n elements from the list.
    """
    last: Int
    """
    Supported filter parameters:
     - processed_at
    See the detailed search syntax.
    """
    query: String
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    Sort the underlying list by the given key.
    """
    sortKey: OrderSortKeys = ID
  ): OrderConnection!
  """
  The customer’s phone number.
  """
  phone: String
  """
  A list of tags assigned to the customer.
  Additional access scope required: unauthenticated_read_customer_tags.
  """
  tags: [String!]!
  """
  The date and time when the customer information was updated.
  """
  updatedAt: DateTime!
}

Connections

addresses (MailingAddressConnection!)	A list of addresses for the customer.
after ( String )	Returns the elements that come after the specified cursor.
before ( String )	Returns the elements that come before the specified cursor.
first ( Int )	Returns up to the first n elements from the list.
last ( Int )	Returns up to the last n elements from the list.
reverse ( Boolean )	Reverse the order of the underlying list. Default value: true
orders (OrderConnection!)	The orders associated with the customer.
after ( String )	Returns the elements that come after the specified cursor.
before ( String )	Returns the elements that come before the specified cursor.
first ( Int )	Returns up to the first n elements from the list.
last ( Int )	Returns up to the last n elements from the list.
query ( String )	Supported filter parameters: processed_at See the detailed search syntax.
reverse ( Boolean )	Reverse the order of the underlying list. Default value: true
sortKey ( OrderSortKeys )	Sort the underlying list by the given key. Default value: true

Fields

acceptsMarketing (Boolean!)	Indicates whether the customer has consented to be sent marketing material via email.
createdAt (DateTime!)	The date and time when the customer was created.
defaultAddress (MailingAddress)	The customer’s default address.
displayName (String!)	The customer’s name, email or phone number.
email (String)	The customer’s email address.
firstName (String)	The customer’s first name.
id (ID!)	A unique identifier for the customer.
lastIncompleteCheckout (Checkout)	The customer's most recently updated, incomplete checkout.
lastName (String)	The customer’s last name.
phone (String)	The customer’s phone number.
tags ([String!]!)	A list of tags assigned to the customer. Additional access scope required: unauthenticated_read_customer_tags. Required access unauthenticated_read_customer_tags access scope
updatedAt (DateTime!)	The date and time when the customer information was updated.