customerSet

mutation

Requires write_customers access scope.

Creates or updates a customer in a single mutation.

Use this mutation when syncing information from an external data source into Shopify.

This mutation can be used to create a new customer, update an existing customer by id, or upsert a customer by a unique key (email or phone).

To create a new customer omit the identifier argument. To update an existing customer, include the identifier with the id of the customer to update.

To perform an 'upsert' by unique key (email or phone) use the identifier argument to upsert a customer by a unique key (email or phone). If a customer with the specified unique key exists, it will be updated. If not, a new customer will be created with that unique key.

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

Any list field (e.g. addresses, will be updated so that all included entries are either created or updated, and all existing entries not included will be deleted.

All other fields will be updated to the value passed. Omitted fields will not be updated.

Arguments

Anchor to identifieridentifier • CustomerSetIdentifiers: Specifies the identifier that will be used to lookup the resource.
Anchor to inputinput • CustomerSetInput!required: The properties of the customer.

Was this section helpful?

Anchor to CustomerSetPayload returnsCustomerSetPayload returns

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

Was this section helpful?

Create a customer
Update a customer's first and last name
Upsert a customer by email address
customerSet reference

Examples

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

const response = await admin.graphql(

`#graphql

mutation createCustomer($input: CustomerSetInput!) {

customerSet(input: $input) {

customer {

}

userErrors {

code

field

message

}

}`,

{

variables: {

"input": {

"email": "steve.lastnameson@example.com",

"phone": "+16465555555",

"firstName": "Steve",

"lastName": "Lastname"

}

);

const data = await response.json();

mutation createCustomer($input: CustomerSetInput!) {
  customerSet(input: $input) {
    customer {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation createCustomer($input: CustomerSetInput!) { customerSet(input: $input) { customer { id } userErrors { code field message } } }",
 "variables": {
    "input": {
      "email": "steve.lastnameson@example.com",
      "phone": "+16465555555",
      "firstName": "Steve",
      "lastName": "Lastname"
    }
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation createCustomer($input: CustomerSetInput!) {
    customerSet(input: $input) {
      customer {
        id
      }
      userErrors {
        code
        field
        message
      }
    }
  }`,
  {
    variables: {
      "input": {
        "email": "steve.lastnameson@example.com",
        "phone": "+16465555555",
        "firstName": "Steve",
        "lastName": "Lastname"
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation createCustomer($input: CustomerSetInput!) {
      customerSet(input: $input) {
        customer {
          id
        }
        userErrors {
          code
          field
          message
        }
      }
    }`,
    "variables": {
      "input": {
        "email": "steve.lastnameson@example.com",
        "phone": "+16465555555",
        "firstName": "Steve",
        "lastName": "Lastname"
      }
    },
  },
});

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 createCustomer($input: CustomerSetInput!) {
    customerSet(input: $input) {
      customer {
        id
      }
      userErrors {
        code
        field
        message
      }
    }
  }
QUERY

variables = {
  "input": {
    "email": "steve.lastnameson@example.com",
    "phone": "+16465555555",
    "firstName": "Steve",
    "lastName": "Lastname"
  }
}

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

Input variables

JSON

{

"input": {

"email": "steve.lastnameson@example.com",

"phone": "+16465555555",

"firstName": "Steve",

"lastName": "Lastname"

}

Response

JSON

{

"customerSet": {

"customer": {

"id": "gid://shopify/Customer/1073339466"

"userErrors": []

}