Przejdź do głównej zawartości

CustomerCreateInput

Input for customerSignup — registers a new customer.

input CustomerCreateInput {
  acceptsMarketing: Boolean
  address: CustomerRegistrationAddressInput
  company: CustomerCompanyInput
  customFields: [FormFieldValueInput!]
  email: String!
  firstName: String
  lastName: String
  marketingOptInLevel: MarketingOptInLevel
  password: String!
  phone: String
  referralCode: String
}

Fields​

CustomerCreateInput.acceptsMarketing ● Boolean scalar​

Marketing opt-in checkbox. true → consent state SUBSCRIBED (single opt-in) unless marketingOptInLevel: CONFIRMED_OPT_IN is also sent (then PENDING and the server sends a double-opt-in confirmation email). false / null → no consent change.

CustomerCreateInput.address ● CustomerRegistrationAddressInput input​

Address stored as the default customer address. Render when registrationForm.addressSection is not OFF; required when it is REQUIRED.

CustomerCreateInput.company ● CustomerCompanyInput input​

Company details (B2B). Render when registrationForm.companySection is not OFF; required (name + tax id) when it is REQUIRED.

CustomerCreateInput.customFields ● [FormFieldValueInput!] list input​

Values of the store-defined custom fields from registrationForm.fields. Unknown keys, missing required fields and values outside SELECT options are rejected.

CustomerCreateInput.email ● String! non-null scalar​

Email address — must be unique within the shop. Used as the login identity.

CustomerCreateInput.firstName ● String scalar​

First name.

CustomerCreateInput.lastName ● String scalar​

Last name.

CustomerCreateInput.marketingOptInLevel ● MarketingOptInLevel enum​

Opt-in level. Defaults to SINGLE_OPT_IN (signup itself is treated as email proof). Pass CONFIRMED_OPT_IN to enforce double opt-in — the server then emails a confirmation link and leaves consent in PENDING until the buyer clicks it.

CustomerCreateInput.password ● String! non-null scalar​

Password (8 to 128 chars). The shop password policy may impose additional strength rules.

CustomerCreateInput.phone ● String scalar​

Phone number (free-form).

CustomerCreateInput.referralCode ● String scalar​

Referral code of an existing customer, usually taken from a referral link's ref URL parameter (codes are case-insensitive). Optional — an invalid, malformed, expired or own code is silently ignored and the signup still succeeds; only a value longer than 50 characters is rejected. When the shop's referral program is active, a valid code grants the configured bonus points to the new customer and, after their first paid order, rewards the referrer.

Member Of​

customerSignup mutation