Choose a version:

customerDelete

mutation

Requires write_customers access scope.

Deletes a Customer from the store. You can only delete customers who haven't placed any orders.

Apps using protected customer data must meet Shopify's protected customer data requirements.

Anchor to Arguments

Arguments

Anchor to inputinput

•CustomerDeleteInput!

required

Specifies the customer to delete.

Show input fields

Was this section helpful?

Anchor to CustomerDeletePayload returnsCustomerDeletePayload returns

Anchor to deletedCustomerIddeletedCustomerId •ID: The ID of the deleted customer.
Anchor to shopshop •Shop! non-null: The shop of the deleted customer.

Show fields
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

Deletes a customer

Query

mutation customerDelete($id: ID!) {
  customerDelete(input: {id: $id}) {
    shop {
      id
    }
    userErrors {
      field
      message
    }
    deletedCustomerId
  }
}

Variables

{
  "id": "gid://shopify/Customer/105906728"
}

cURL

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 customerDelete($id: ID!) { customerDelete(input: {id: $id}) { shop { id } userErrors { field message } deletedCustomerId } }",
 "variables": {
    "id": "gid://shopify/Customer/105906728"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation customerDelete($id: ID!) {
    customerDelete(input: {id: $id}) {
      shop {
        id
      }
      userErrors {
        field
        message
      }
      deletedCustomerId
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Customer/105906728"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 customerDelete($id: ID!) {
    customerDelete(input: {id: $id}) {
      shop {
        id
      }
      userErrors {
        field
        message
      }
      deletedCustomerId
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Customer/105906728"
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation customerDelete($id: ID!) {
      customerDelete(input: {id: $id}) {
        shop {
          id
        }
        userErrors {
          field
          message
        }
        deletedCustomerId
      }
    }`,
    "variables": {
        "id": "gid://shopify/Customer/105906728"
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation customerDelete($id: ID!) {
  customerDelete(input: {id: $id}) {
    shop {
      id
    }
    userErrors {
      field
      message
    }
    deletedCustomerId
  }
}' \
--variables \
'{
  "id": "gid://shopify/Customer/105906728"
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation customerDelete($id: ID!) {
        customerDelete(input: {id: $id}) {
          shop {
            id
          }
          userErrors {
            field
            message
          }
          deletedCustomerId
        }
      }
    `,
    variables: {
        "id": "gid://shopify/Customer/105906728"
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "customerDelete": {
    "shop": {
      "id": "gid://shopify/Shop/26371970"
    },
    "userErrors": [],
    "deletedCustomerId": "gid://shopify/Customer/105906728"
  }
}

customerDelete reference

Examples

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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

const response = await admin.graphql(

`#graphql

mutation customerDelete($id: ID!) {

customerDelete(input: {id: $id}) {

shop {

}

userErrors {

field

message

}

deletedCustomerId

}

}`,

{

variables: {

"id": "gid://shopify/Customer/105906728"

);

const json = await response.json();

return json.data;

}

GQL

mutation customerDelete($id: ID!) {
  customerDelete(input: {id: $id}) {
    shop {
      id
    }
    userErrors {
      field
      message
    }
    deletedCustomerId
  }
}

cURL

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 customerDelete($id: ID!) { customerDelete(input: {id: $id}) { shop { id } userErrors { field message } deletedCustomerId } }",
 "variables": {
    "id": "gid://shopify/Customer/105906728"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation customerDelete($id: ID!) {
    customerDelete(input: {id: $id}) {
      shop {
        id
      }
      userErrors {
        field
        message
      }
      deletedCustomerId
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Customer/105906728"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation customerDelete($id: ID!) {
      customerDelete(input: {id: $id}) {
        shop {
          id
        }
        userErrors {
          field
          message
        }
        deletedCustomerId
      }
    }`,
    "variables": {
        "id": "gid://shopify/Customer/105906728"
    },
  },
});

Ruby

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 customerDelete($id: ID!) {
    customerDelete(input: {id: $id}) {
      shop {
        id
      }
      userErrors {
        field
        message
      }
      deletedCustomerId
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Customer/105906728"
}

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

Shopify CLI

shopify app execute \
--query \
'mutation customerDelete($id: ID!) {
  customerDelete(input: {id: $id}) {
    shop {
      id
    }
    userErrors {
      field
      message
    }
    deletedCustomerId
  }
}' \
--variables \
'{
  "id": "gid://shopify/Customer/105906728"
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation customerDelete($id: ID!) {
        customerDelete(input: {id: $id}) {
          shop {
            id
          }
          userErrors {
            field
            message
          }
          deletedCustomerId
        }
      }
    `,
    variables: {
        "id": "gid://shopify/Customer/105906728"
    },
  }),
});

const { data } = await response.json();
console.log(data);

Input variables

JSON

{

"id": "gid://shopify/Customer/105906728"

}

Response

JSON

{

"customerDelete": {

"shop": {

"id": "gid://shopify/Shop/26371970"

"userErrors": [],

"deletedCustomerId": "gid://shopify/Customer/105906728"

}