customerCreate

mutation

Requires write_customers access scope.

Create a new customer. As of API version 2022-10, apps using protected customer data must meet the protected customer data requirements.

Arguments

Anchor to inputinput • CustomerInput!required: The input fields to create a customer.

Was this section helpful?

Anchor to CustomerCreatePayload returnsCustomerCreatePayload returns

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

Was this section helpful?

Create a customer subscribed to SMS marketing
Create a customer without required attributes
Create a new metafield on a new customer
Creates a customer
customerCreate reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation customerCreate($input: CustomerInput!) {
6    customerCreate(input: $input) {
7      userErrors {
8        field
9        message
10      }
11      customer {
12        id
13        email
14        phone
15        taxExempt
16        firstName
17        lastName
18        amountSpent {
19          amount
20          currencyCode
21        }
22        smsMarketingConsent {
23          marketingState
24          marketingOptInLevel
25          consentUpdatedAt
26        }
27      }
28    }
29  }`,
30  {
31    variables: {
32      "input": {
33        "email": "steve.lastnameson@example.com",
34        "phone": "+16465555555",
35        "firstName": "Steve",
36        "smsMarketingConsent": {
37          "marketingState": "SUBSCRIBED",
38          "marketingOptInLevel": "SINGLE_OPT_IN"
39        }
40      }
41    },
42  },
43);
44
45const data = await response.json();
46

mutation customerCreate($input: CustomerInput!) {
  customerCreate(input: $input) {
    userErrors {
      field
      message
    }
    customer {
      id
      email
      phone
      taxExempt
      firstName
      lastName
      amountSpent {
        amount
        currencyCode
      }
      smsMarketingConsent {
        marketingState
        marketingOptInLevel
        consentUpdatedAt
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation customerCreate($input: CustomerInput!) { customerCreate(input: $input) { userErrors { field message } customer { id email phone taxExempt firstName lastName amountSpent { amount currencyCode } smsMarketingConsent { marketingState marketingOptInLevel consentUpdatedAt } } } }",
 "variables": {
    "input": {
      "email": "steve.lastnameson@example.com",
      "phone": "+16465555555",
      "firstName": "Steve",
      "smsMarketingConsent": {
        "marketingState": "SUBSCRIBED",
        "marketingOptInLevel": "SINGLE_OPT_IN"
      }
    }
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation customerCreate($input: CustomerInput!) {
    customerCreate(input: $input) {
      userErrors {
        field
        message
      }
      customer {
        id
        email
        phone
        taxExempt
        firstName
        lastName
        amountSpent {
          amount
          currencyCode
        }
        smsMarketingConsent {
          marketingState
          marketingOptInLevel
          consentUpdatedAt
        }
      }
    }
  }`,
  {
    variables: {
      "input": {
        "email": "steve.lastnameson@example.com",
        "phone": "+16465555555",
        "firstName": "Steve",
        "smsMarketingConsent": {
          "marketingState": "SUBSCRIBED",
          "marketingOptInLevel": "SINGLE_OPT_IN"
        }
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation customerCreate($input: CustomerInput!) {
      customerCreate(input: $input) {
        userErrors {
          field
          message
        }
        customer {
          id
          email
          phone
          taxExempt
          firstName
          lastName
          amountSpent {
            amount
            currencyCode
          }
          smsMarketingConsent {
            marketingState
            marketingOptInLevel
            consentUpdatedAt
          }
        }
      }
    }`,
    "variables": {
      "input": {
        "email": "steve.lastnameson@example.com",
        "phone": "+16465555555",
        "firstName": "Steve",
        "smsMarketingConsent": {
          "marketingState": "SUBSCRIBED",
          "marketingOptInLevel": "SINGLE_OPT_IN"
        }
      }
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation customerCreate($input: CustomerInput!) {
    customerCreate(input: $input) {
      userErrors {
        field
        message
      }
      customer {
        id
        email
        phone
        taxExempt
        firstName
        lastName
        amountSpent {
          amount
          currencyCode
        }
        smsMarketingConsent {
          marketingState
          marketingOptInLevel
          consentUpdatedAt
        }
      }
    }
  }
QUERY

variables = {
  "input": {
    "email": "steve.lastnameson@example.com",
    "phone": "+16465555555",
    "firstName": "Steve",
    "smsMarketingConsent": {
      "marketingState": "SUBSCRIBED",
      "marketingOptInLevel": "SINGLE_OPT_IN"
    }
  }
}

response = client.query(query: query, variables: variables)

Input variables

JSON

1{
2  "input": {
3    "email": "steve.lastnameson@example.com",
4    "phone": "+16465555555",
5    "firstName": "Steve",
6    "smsMarketingConsent": {
7      "marketingState": "SUBSCRIBED",
8      "marketingOptInLevel": "SINGLE_OPT_IN"
9    }
10  }
11}

Response

JSON

1{
2  "customerCreate": {
3    "userErrors": [],
4    "customer": {
5      "id": "gid://shopify/Customer/1073340122",
6      "email": "steve.lastnameson@example.com",
7      "phone": "+16465555555",
8      "taxExempt": false,
9      "firstName": "Steve",
10      "lastName": null,
11      "amountSpent": {
12        "amount": "0.0",
13        "currencyCode": "USD"
14      },
15      "smsMarketingConsent": {
16        "marketingState": "SUBSCRIBED",
17        "marketingOptInLevel": "SINGLE_OPT_IN",
18        "consentUpdatedAt": "2024-11-05T14:29:24Z"
19      }
20    }
21  }
22}