Skip to main content

Customer

type Customer {
  id: ID!
  accountStatus: CustomerAccountStatusEnum
  accountStatusUpdatedAt: Timestamp
  addresses: [CustomerAddress!]
  attributes: [CustomerAttributeValue!]
  customerGroupIds: [String!]
  customerSegmentIds: [String!]
  customerSequence: Float
  email: String
  emailVerifiedDate: Timestamp
  firstName: String!
  firstOrderDate: Timestamp
  fullName: String
  ip: String
  isEmailVerified: Boolean
  isPhoneVerified: Boolean
  lastName: String
  lastOrderDate: Timestamp
  lastPriceListId: String
  lastStorefrontRoutingId: String
  note: String
  orderCount: Float
  passwordUpdateDate: Timestamp
  phone: String
  phoneVerifiedDate: Timestamp
  preferredLanguage: String
  priceListId: String
  priceListRules: [CustomerPriceListRule!]
  registrationSource: CustomerRegistrationSourceEnum
  subscriptionStatus: CustomerEmailSubscriptionStatusesEnum
  subscriptionStatusUpdatedAt: Timestamp
  tagIds: [String!]
  totalOrderPrice: Float
  userAgent: String
}

Fields

idID!required

CustomerAccountStatusEnum

accountStatusUpdatedAtTimestamp

A list of the ten most recently updated addresses for the customer.

customerGroupIds[String!]

Groups that the store owner attaches to the customer.

customerSegmentIds[String!]

Segments that the customers are belong to.

customerSequenceFloat

It is the sequence value of the customer. The sequence value starts from 1.

emailString

The unique email address of the customer. Attempting to assign the same email address to multiple customers returns an error.

emailVerifiedDateTimestamp

The date the email was verified.

firstNameString!required

The customer's first name.

firstOrderDateTimestamp

Date of first order by the customer

fullNameString

Customer's full name. Firstname plus lastname if firstname and lastname exist. Otherwise, it is saved as firstname only.

isEmailVerifiedBoolean

Email verification status. isEmailVerified returns true if the email is verified.

isPhoneVerifiedBoolean

Phone verification status. isPhoneVerified returns true if the email is verified.

lastNameString

The customer's last name.

lastOrderDateTimestamp

Date of last order by the customer

lastPriceListIdString

Last used price list id by the customer

lastStorefrontRoutingIdString

Last used storefront routing id by the customer

noteString

A note about the customer.

orderCountFloat

Number of orders placed by the customer.

passwordUpdateDateTimestamp

Date the customer last changed their password.

phoneString

The customer's phone number

phoneVerifiedDateTimestamp

The date the email was verified.

preferredLanguageString
priceListIdString

Registration source of customer.

CustomerEmailSubscriptionStatusesEnum

subscriptionStatusUpdatedAtTimestamp
tagIds[String!]

Tags that the store owner attaches to the customer.

totalOrderPriceFloat

Amount of orders by the customer

userAgentString