CustomerDraft

Request body for creating a new customer.

CommerceComposable CommerceE-CommerceGraphQLRESTSDK

Properties

Name	Type	Description
key	string	User-defined unique identifier.
email	string	Email address for the new customer.
password	string	Password for the new customer account.
firstName	string	Customer first name.
lastName	string	Customer last name.
customerGroup	object
addresses	array	Initial addresses for the customer.
isEmailVerified	boolean	Whether to pre-verify the email address.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CustomerDraft",
  "title": "CustomerDraft",
  "type": "object",
  "description": "Request body for creating a new customer.",
  "required": [
    "email",
    "password"
  ],
  "properties": {
    "key": {
      "type": "string",
      "description": "User-defined unique identifier."
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Email address for the new customer."
    },
    "password": {
      "type": "string",
      "description": "Password for the new customer account."
    },
    "firstName": {
      "type": "string",
      "description": "Customer first name."
    },
    "lastName": {
      "type": "string",
      "description": "Customer last name."
    },
    "customerGroup": {
      "$ref": "#/components/schemas/Reference"
    },
    "addresses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Address"
      },
      "description": "Initial addresses for the customer."
    },
    "isEmailVerified": {
      "type": "boolean",
      "description": "Whether to pre-verify the email address."
    }
  }
}