customerDelete

mutation

Code examples for MUTATION: customerDelete

Query Reference for MUTATION: customerDelete

"mutation customerDelete($input: CustomerDeleteInput!) {\n  customerDelete(input: $input) {\n    deletedCustomerId\n    shop {\n      # Shop fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: customerDelete

"{\n  \"input\": {\n    \"id\": \"gid://shopify/<objectName>/10079785100\"\n  }\n}"

Schema Reference for MUTATION: customerDelete

"input CustomerDeleteInput {\n  id: ID!\n}\n"

Display Examples for MUTATION: customerDelete

[
  {
    "example": {
      "type_name": "customerdelete",
      "title": "Delete a customer by ID",
      "query_string": "mutation customerDelete($id: ID!) {\n  customerDelete(input: {id: $id}) {\n    shop {\n      id\n    }\n    userErrors {\n      field\n      message\n    }\n    deletedCustomerId\n  }\n}",
      "query_arguments": {
        "id": "$id"
      },
      "variables": {
        "id": "gid://shopify/Customer/105906728"
      },
      "response": {
        "data": {
          "customerDelete": {
            "shop": {
              "id": "gid://shopify/Shop/26371970"
            },
            "userErrors": [],
            "deletedCustomerId": "gid://shopify/Customer/105906728"
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/customers/test/unit/graph_api/admin/mutations/customer_delete_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation customerDelete($id: ID!) { customerDelete(input: {id: $id}) { shop { id } userErrors { field message } deletedCustomerId } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/Customer/105906728\"\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation customerDelete($id: ID!) {\n    customerDelete(input: {id: $id}) {\n      shop {\n        id\n      }\n      userErrors {\n        field\n        message\n      }\n      deletedCustomerId\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/Customer/105906728\"\n    },\n  },\n);\n\nconst data = await response.json();\n",
      "ruby_example": "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation customerDelete($id: ID!) {\n    customerDelete(input: {id: $id}) {\n      shop {\n        id\n      }\n      userErrors {\n        field\n        message\n      }\n      deletedCustomerId\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/Customer/105906728\"\n}\n\nresponse = client.query(query: query, variables: variables)\n",
      "node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation customerDelete($id: ID!) {\n      customerDelete(input: {id: $id}) {\n        shop {\n          id\n        }\n        userErrors {\n          field\n          message\n        }\n        deletedCustomerId\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/Customer/105906728\"\n    },\n  },\n});\n",
      "php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation customerDelete($id: ID!) {\n    customerDelete(input: {id: $id}) {\n      shop {\n        id\n      }\n      userErrors {\n        field\n        message\n      }\n      deletedCustomerId\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/Customer/105906728\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": []
  }
]