Skip to Content
ReferenceStorefrontv1.3.0 API Reference (Latest)EnumsCustomerErrorCode

CustomerErrorCode

Possible error codes that can be returned by customer mutations.

Enum Definition

enum CustomerErrorCode {
  INVALID_CREDENTIALS
  UNIDENTIFIED_CUSTOMER
  TOKEN_EXPIRED
  TOKEN_INVALID
  TOO_MANY_ATTEMPTS
  EMAIL_TAKEN
  INVALID_EMAIL
  INVALID_PASSWORD
  PASSWORD_MISMATCH
  LOGIN_DISABLED
  REGISTRATION_DISABLED
  BLANK
  INVALID
}

Values

ValueDescription
INVALID_CREDENTIALSThe email or password is incorrect
UNIDENTIFIED_CUSTOMERThe customer could not be identified
TOKEN_EXPIREDThe access token has expired
TOKEN_INVALIDThe access token is invalid
TOO_MANY_ATTEMPTSToo many login attempts. Please try again later.
EMAIL_TAKENThe email address is already registered
INVALID_EMAILThe email address is invalid
INVALID_PASSWORDThe password does not meet requirements
PASSWORD_MISMATCHThe password and password confirmation do not match
LOGIN_DISABLEDCustomer login is disabled for this store
REGISTRATION_DISABLEDCustomer registration is disabled for this store
BLANKA required field is blank
INVALIDThe supplied value is invalid

Example

mutation LoginCustomer($email: String!, $password: String!) {
  customerLogin(input: {email: $email, password: $password}) {
    customer {
      id
      email
    }
    errors {
      code
      message
    }
  }
}

When this mutation fails, the errors field may contain a code value of type CustomerErrorCode, such as INVALID_CREDENTIALS or EMAIL_TAKEN.

  • Customer
  • CustomerInput
  • CustomerError
  • CustomerLoginPayload
  • CustomerCreatePayload
  • CustomerUpdatePayload