Skip to main content

CreateCustomerInput

Input for creating a single customer along with its default address.

input CreateCustomerInput {
  email: String!
  firstName: String!
  lastName: String!
  salesChannelId: ID!
  customerGroupId: ID!
  accountType: CustomerAccountType!
  billingAddress: CreateCustomerAddressInput!
  salutationId: ID
  defaultPaymentMethodId: ID
  company: String
  title: String
  vatIds: [String!]
  password: String
  customerNumber: String
}

Fields​

CreateCustomerInput.email ● String! non-null scalar​

Email address of the customer. Must be unique within the sales channel.

CreateCustomerInput.firstName ● String! non-null scalar​

First name of the customer.

CreateCustomerInput.lastName ● String! non-null scalar​

Last name of the customer.

CreateCustomerInput.salesChannelId ● ID! non-null scalar​

ID of the sales channel the customer is registered in.

CreateCustomerInput.customerGroupId ● ID! non-null scalar​

ID of the customer group the customer is assigned to.

CreateCustomerInput.accountType ● CustomerAccountType! non-null enum​

Customer type. Either Private or Business. company is required for Business.

CreateCustomerInput.billingAddress ● CreateCustomerAddressInput! non-null input​

Billing address, also used as the default shipping address.

CreateCustomerInput.salutationId ● ID scalar​

ID of the salutation. Applied to both the customer and the created address.

CreateCustomerInput.defaultPaymentMethodId ● ID scalar​

ID of the default payment method. Required on Shopware 6.6 (where the field exists) and ignored on 6.7+, where customers no longer carry a default payment method.

CreateCustomerInput.company ● String scalar​

Company name. Required when accountType is Business.

CreateCustomerInput.title ● String scalar​

Optional academic or honorific title (e.g. Dr.).

CreateCustomerInput.vatIds ● [String!] list scalar​

List of VAT registration IDs of the customer.

CreateCustomerInput.password ● String scalar​

Password for the customer login. Stored only as a secure hash — never persisted in plain text. Omit to create a customer without login credentials.

CreateCustomerInput.customerNumber ● String scalar​

Human-readable customer number. Generated from the customer number range when omitted.

Member Of​

createCustomer mutation