OBJECT

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.

link GraphQL Schema definition

  • type Customer {
  • # Indicates whether the customer has consented to be sent marketing material via
  • # email.
  • acceptsMarketing: Boolean!
  • # A list of addresses for the customer.
  • #
  • # Arguments
  • # first: [Not documented]
  • # after: [Not documented]
  • # reverse: [Not documented]
  • addresses(first: Int!, after: String, reverse: Boolean): 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.
  • #
  • # Arguments
  • # first: [Not documented]
  • # after: [Not documented]
  • # sortKey: [Not documented]
  • # reverse: [Not documented]
  • # query: Supported filter parameters:
  • #
  • # - `status`
  • #
  • # - `financial_status`
  • #
  • # - `fulfillment_status`
  • #
  • # - `source_name`
  • #
  • # - `chargeback_status`
  • #
  • # - `risk_level`
  • #
  • # - `customer_id`
  • #
  • # - `email`
  • #
  • # - `credit_card_last4`
  • #
  • # - `processed_at`
  • #
  • # - `checkout_token`
  • #
  • # - `cart_token`
  • #
  • # - `location_id`
  • #
  • # - `channel_id`
  • #
  • # - `discount_code`
  • #
  • # - `tag`
  • #
  • # - `since_id`
  • #
  • # - `updated_at`
  • #
  • # - `created_at`
  • orders(
  • first: Int!,
  • after: String,
  • sortKey: OrderSortKeys,
  • reverse: Boolean,
  • query: String
  • ): OrderConnection!
  • # The customer’s phone number.
  • phone: String
  • # The date and time when the customer information was updated.
  • updatedAt: DateTime!
  • }