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.

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(first: Int!, after: String, 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 last name.
  lastName: String

  # The orders associated with the customer.
  orders(
    first: Int!
    after: String
    sortKey: OrderSortKeys = ID
    reverse: Boolean = false

    # Supported filter parameters:
    #  - `processed_at`
    query: String
  ): OrderConnection!

  # The customer’s phone number.
  phone: String

  # The date and time when the customer information was updated.
  updatedAt: DateTime!
}

Connections

addresses   (MailingAddressConnection!)

A list of addresses for the customer.

Argument Type Default Description
after String
first required Int
reverse Boolean false

orders   (OrderConnection!)

The orders associated with the customer.

Argument Type Default Description
after String
first required Int
query String

Supported filter parameters:

  • processed_at
reverse Boolean false
sortKey OrderSortKeys ID

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.

lastName   (String)

The customer’s last name.

phone   (String)

The customer’s phone number.

updatedAt   (DateTime!)

The date and time when the customer information was updated.