Customer object

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.

Connections

• addresses (MailingAddressConnection!)

  A list of addresses for the customer.

  Argument	Description
  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: false

• orders (OrderConnection!)

  The orders associated with the customer.

  Argument	Description
  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 for more information about using filters.
  reverse ( Boolean )	Reverse the order of the underlying list. Default value: false
  sortKey ( OrderSortKeys )	Sort the underlying list by the given key. Default value: 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.

• 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 comma separated list of tags that have been added 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.

Types that return Customer

• QueryRoot.customer

Mutations for Customer

• customerActivate

  Activates a customer.

• customerActivateByUrl

  Activates a customer with the activation url received from customerCreate.

• customerAddressCreate

  Creates a new address for a customer.

• customerAddressDelete

  Permanently deletes the address of an existing customer.

• customerAddressUpdate

  Updates the address of an existing customer.

• customerCreate

  Creates a new customer.

• customerDefaultAddressUpdate

  Updates the default address of an existing customer.

• customerRecover

  Sends a reset password email to the customer, as the first step in the reset password process.

• customerReset

  Resets a customer’s password with a token received from CustomerRecover.

• customerResetByUrl

  Resets a customer’s password with the reset password url received from CustomerRecover.

• customerUpdate

  Updates an existing customer.