CustomerSignupPayload
Result of customerSignup.
type CustomerSignupPayload {
accountStatus: CustomerAccountStatus
customer: Customer
customerAccessToken: CustomerAccessToken
pendingApprovalMessage: String
userErrors: [UserError!]!
}
Fields
CustomerSignupPayload.accountStatus ● CustomerAccountStatus enum
State of the freshly created account. PENDING_APPROVAL means the store reviews registrations manually — show pendingApprovalMessage and do not treat the buyer as signed in. Null when userErrors is non-empty.
CustomerSignupPayload.customer ● Customer object
The created customer on success; null when userErrors is non-empty.
CustomerSignupPayload.customerAccessToken ● CustomerAccessToken object
Access token for the new customer — saves a follow-up login round-trip. Null when accountStatus is PENDING_APPROVAL (the store verifies new accounts before first sign-in).
CustomerSignupPayload.pendingApprovalMessage ● String scalar
Store-configured message to show after a PENDING_APPROVAL signup (already resolved to the request language). Null when the account is ACTIVE.
CustomerSignupPayload.userErrors ● [UserError!]! non-null object
Validation / business errors carrying a stable CustomerErrorCode in code (e.g. TAKEN, INVALID, PASSWORD_TOO_WEAK, BAD_DOMAIN).
Returned By
customerSignup mutation