Choose a version:

customerCreate

mutation

Requires unauthenticated_write_customers access scope.

Creates a new customer.

Arguments

Anchor to inputinput •CustomerCreateInput! required: The fields used to create a new customer.

Was this section helpful?

Anchor to CustomerCreatePayload returnsCustomerCreatePayload returns

Anchor to customercustomer •Customer: The created customer object.
Anchor to customerUserErrorscustomerUserErrors •[CustomerUserError!]! non-null: The list of errors that occurred from executing the mutation.
Anchor to userErrorsuserErrors •[UserError!]! non-nullDeprecated: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Create a customer

Description

Create a new customer

Query

mutation customerCreate($input: CustomerCreateInput!) {
  customerCreate(input: $input) {
    customer {
      firstName
      lastName
      email
      phone
      acceptsMarketing
    }
    customerUserErrors {
      field
      message
      code
    }
  }
}

Variables

{
  "input": {
    "firstName": "John",
    "lastName": "Smith",
    "email": "johnsmith@shopify.com",
    "phone": "+15146669999",
    "password": "5hopify",
    "acceptsMarketing": true
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \
-d '{
"query": "mutation customerCreate($input: CustomerCreateInput!) { customerCreate(input: $input) { customer { firstName lastName email phone acceptsMarketing } customerUserErrors { field message code } } }",
 "variables": {
    "input": {
      "firstName": "John",
      "lastName": "Smith",
      "email": "johnsmith@shopify.com",
      "phone": "+15146669999",
      "password": "5hopify",
      "acceptsMarketing": true
    }
  }
}'

Remix

const { storefront } = await unauthenticated.storefront(
  'your-development-store.myshopify.com'
);

const response = await storefront.graphql(
  `#graphql
  mutation customerCreate($input: CustomerCreateInput!) {
    customerCreate(input: $input) {
      customer {
        firstName
        lastName
        email
        phone
        acceptsMarketing
      }
      customerUserErrors {
        field
        message
        code
      }
    }
  }`,
  {
    variables: {
      "input": {
        "firstName": "John",
        "lastName": "Smith",
        "email": "johnsmith@shopify.com",
        "phone": "+15146669999",
        "password": "5hopify",
        "acceptsMarketing": true
      }
    },
  },
);

const data = await response.json();

Node.js

const client = new shopify.clients.Storefront({
  domain: 'your-development-store.myshopify.com',
  storefrontAccessToken,
});
const data = await client.query({
  data: {
    "query": `mutation customerCreate($input: CustomerCreateInput!) {
      customerCreate(input: $input) {
        customer {
          firstName
          lastName
          email
          phone
          acceptsMarketing
        }
        customerUserErrors {
          field
          message
          code
        }
      }
    }`,
    "variables": {
      "input": {
        "firstName": "John",
        "lastName": "Smith",
        "email": "johnsmith@shopify.com",
        "phone": "+15146669999",
        "password": "5hopify",
        "acceptsMarketing": true
      }
    },
  },
});

Response

{
  "customerCreate": {
    "customer": {
      "firstName": "John",
      "lastName": "Smith",
      "email": "johnsmith@shopify.com",
      "phone": "+15146669999",
      "acceptsMarketing": true
    },
    "customerUserErrors": []
  }
}

customerCreate reference

Examples

Open in GraphiQL

const { storefront } = await unauthenticated.storefront(

'your-development-store.myshopify.com'

);

const response = await storefront.graphql(

`#graphql

mutation customerCreate($input: CustomerCreateInput!) {

customerCreate(input: $input) {

customer {

firstName

lastName

phone

acceptsMarketing

}

customerUserErrors {

field

message

code

}

}`,

{

variables: {

"input": {

"firstName": "John",

"lastName": "Smith",

"email": "johnsmith@shopify.com",

"phone": "+15146669999",

"password": "5hopify",

"acceptsMarketing": true

}

);

const data = await response.json();

mutation customerCreate($input: CustomerCreateInput!) {
  customerCreate(input: $input) {
    customer {
      firstName
      lastName
      email
      phone
      acceptsMarketing
    }
    customerUserErrors {
      field
      message
      code
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \
-d '{
"query": "mutation customerCreate($input: CustomerCreateInput!) { customerCreate(input: $input) { customer { firstName lastName email phone acceptsMarketing } customerUserErrors { field message code } } }",
 "variables": {
    "input": {
      "firstName": "John",
      "lastName": "Smith",
      "email": "johnsmith@shopify.com",
      "phone": "+15146669999",
      "password": "5hopify",
      "acceptsMarketing": true
    }
  }
}'

const { storefront } = await unauthenticated.storefront(
  'your-development-store.myshopify.com'
);

const response = await storefront.graphql(
  `#graphql
  mutation customerCreate($input: CustomerCreateInput!) {
    customerCreate(input: $input) {
      customer {
        firstName
        lastName
        email
        phone
        acceptsMarketing
      }
      customerUserErrors {
        field
        message
        code
      }
    }
  }`,
  {
    variables: {
      "input": {
        "firstName": "John",
        "lastName": "Smith",
        "email": "johnsmith@shopify.com",
        "phone": "+15146669999",
        "password": "5hopify",
        "acceptsMarketing": true
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Storefront({
  domain: 'your-development-store.myshopify.com',
  storefrontAccessToken,
});
const data = await client.query({
  data: {
    "query": `mutation customerCreate($input: CustomerCreateInput!) {
      customerCreate(input: $input) {
        customer {
          firstName
          lastName
          email
          phone
          acceptsMarketing
        }
        customerUserErrors {
          field
          message
          code
        }
      }
    }`,
    "variables": {
      "input": {
        "firstName": "John",
        "lastName": "Smith",
        "email": "johnsmith@shopify.com",
        "phone": "+15146669999",
        "password": "5hopify",
        "acceptsMarketing": true
      }
    },
  },
});

Input variables

JSON

{

"input": {

"firstName": "John",

"lastName": "Smith",

"email": "johnsmith@shopify.com",

"phone": "+15146669999",

"password": "5hopify",

"acceptsMarketing": true

}

Response

JSON

{

"customerCreate": {

"customer": {

"firstName": "John",

"lastName": "Smith",

"email": "johnsmith@shopify.com",

"phone": "+15146669999",

"acceptsMarketing": true

"customerUserErrors": []

}