createCustomer mutation

Use the createCustomer mutation to create a new customer.

To return or modify information about a customer, Magento recommends you use customer tokens in the header of your GraphQL calls. However, you also can use session authentication.

Syntax

mutation: {createCustomer(input: CustomerInput!) {CustomerOutput}}

Example usage

The following call creates a new customer.

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
mutation {
  createCustomer(
    input: {
      firstname: "Bob"
      lastname: "Loblaw"
      email: "bobloblaw@example.com"
      password: "b0bl0bl@w"
      is_subscribed: true
    }
  ) {
    customer {
      id
      firstname
      lastname
      email
      is_subscribed
    }
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "data": {
    "createCustomer": {
      "customer": {
        "id": 5,
        "firstname": "Bob",
        "lastname": "Loblaw",
        "email": "bobloblaw@example.com",
        "is_subscribed": true
      }
    }
  }
}

Input attributes

The following table lists the attributes you can use as input for the createCustomer mutation. The Customer attributes table lists the attributes Magento returns.

Output attributes

The createCustomer mutation returns the CustomerOutput object.

CustomerAddress attributes

The values assigned to attributes such as firstname and lastname in this object may be different from those defined in the Customer object.

The CustomerAddress output returns the following attributes:

CustomerAddressAttribute attributes

The CustomerAddressAttribute output data type has been deprecated because the contents are not applicable for GraphQL. It can contain the following attributes:

CustomerAddressRegion attributes

The customerAddressRegion output returns the following attributes:

Errors

Related topics

• customer query
• updateCustomer mutation
• createCustomerAddress mutation
• updateCustomerAddress mutation
• deleteCustomerAddress mutation