gateConfigurationDelete
mutation

Choose a version:

Requires write_gates access scope. Also: You must have write access to gates to delete gate configurations.

Deletes a gate configuration.

Anchor to section titled 'Arguments'

Arguments

Anchor to input input GateConfigurationDeleteInput! required: Specifies the gate configuration to delete by its ID.

Was this section helpful?

Anchor to section titled 'GateConfigurationDeletePayload returns'

GateConfigurationDeletePayload returns

Anchor to GateConfigurationDeletePayload.deletedGateConfigurationId deletedGateConfigurationId ID: The ID of the deleted gate configuration.
Anchor to GateConfigurationDeletePayload.shop shop Shop! non-null: The shop associated with the gate configuration.
Anchor to GateConfigurationDeletePayload.userErrors userErrors [GateConfigurationUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: gateConfigurationDelete

Query Reference for MUTATION: gateConfigurationDelete

"mutation gateConfigurationDelete($input: GateConfigurationDeleteInput!) {\n  gateConfigurationDelete(input: $input) {\n    deletedGateConfigurationId\n    shop {\n      # Shop fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: gateConfigurationDelete

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

Schema Reference for MUTATION: gateConfigurationDelete

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

Display Examples for MUTATION: gateConfigurationDelete

[
  {
    "example": {
      "type_name": "gateconfigurationdelete",
      "title": "Delete a gate configuration by ID",
      "query_string": "mutation gateConfigurationDelete($input: GateConfigurationDeleteInput!) {\n  gateConfigurationDelete(input: $input) {\n    userErrors {\n      field\n      message\n    }\n    deletedGateConfigurationId\n  }\n}",
      "variables": {
        "input": {
          "id": "gid://shopify/GateConfiguration/43548663"
        }
      },
      "response": {
        "data": {
          "gateConfigurationDelete": {
            "userErrors": [],
            "deletedGateConfigurationId": "gid://shopify/GateConfiguration/43548663"
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "unstable",
      "maximum_api_version": "unstable",
      "location": "/components/gates/test/unit/models/graph_api/admin/mutations/gate_configuration_delete_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation gateConfigurationDelete($input: GateConfigurationDeleteInput!) { gateConfigurationDelete(input: $input) { userErrors { field message } deletedGateConfigurationId } }\",\n \"variables\": {\n    \"input\": {\n      \"id\": \"gid://shopify/GateConfiguration/43548663\"\n    }\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation gateConfigurationDelete($input: GateConfigurationDeleteInput!) {\n    gateConfigurationDelete(input: $input) {\n      userErrors {\n        field\n        message\n      }\n      deletedGateConfigurationId\n    }\n  }`,\n  {\n    variables: {\n      \"input\": {\n        \"id\": \"gid://shopify/GateConfiguration/43548663\"\n      }\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 gateConfigurationDelete($input: GateConfigurationDeleteInput!) {\n    gateConfigurationDelete(input: $input) {\n      userErrors {\n        field\n        message\n      }\n      deletedGateConfigurationId\n    }\n  }\nQUERY\n\nvariables = {\n  \"input\": {\n    \"id\": \"gid://shopify/GateConfiguration/43548663\"\n  }\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 gateConfigurationDelete($input: GateConfigurationDeleteInput!) {\n      gateConfigurationDelete(input: $input) {\n        userErrors {\n          field\n          message\n        }\n        deletedGateConfigurationId\n      }\n    }`,\n    \"variables\": {\n      \"input\": {\n        \"id\": \"gid://shopify/GateConfiguration/43548663\"\n      }\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 gateConfigurationDelete($input: GateConfigurationDeleteInput!) {\n    gateConfigurationDelete(input: $input) {\n      userErrors {\n        field\n        message\n      }\n      deletedGateConfigurationId\n    }\n  }\nQUERY;\n\n$variables = [\n  \"input\" => [\n    \"id\" => \"gid://shopify/GateConfiguration/43548663\",\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "input",
          "description": "Specifies the gate configuration to delete by its ID.",
          "type": {
            "kind": "INPUT_OBJECT",
            "name": "GateConfigurationDeleteInput",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "GateConfigurationDeleteInput!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "input",
        "argValue": " {\"id\":\"gid://shopify/GateConfiguration/43548663\"}",
        "typeKind": "MUTATION"
      }
    ]
  },
  {
    "example": {
      "type_name": "gateconfigurationdelete",
      "title": "Deleting a gate configuration by an incorrect ID returns an error",
      "query_string": "mutation gateConfigurationDelete($input: GateConfigurationDeleteInput!) {\n  gateConfigurationDelete(input: $input) {\n    userErrors {\n      field\n      message\n    }\n    deletedGateConfigurationId\n  }\n}",
      "variables": {
        "input": {
          "id": "gid://shopify/GateConfiguration/0"
        }
      },
      "response": {
        "data": {
          "gateConfigurationDelete": {
            "userErrors": [
              {
                "field": [
                  "input",
                  "id"
                ],
                "message": "Unable to find gate record with id"
              }
            ],
            "deletedGateConfigurationId": null
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "unstable",
      "maximum_api_version": "unstable",
      "location": "/components/gates/test/unit/models/graph_api/admin/mutations/gate_configuration_delete_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation gateConfigurationDelete($input: GateConfigurationDeleteInput!) { gateConfigurationDelete(input: $input) { userErrors { field message } deletedGateConfigurationId } }\",\n \"variables\": {\n    \"input\": {\n      \"id\": \"gid://shopify/GateConfiguration/0\"\n    }\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation gateConfigurationDelete($input: GateConfigurationDeleteInput!) {\n    gateConfigurationDelete(input: $input) {\n      userErrors {\n        field\n        message\n      }\n      deletedGateConfigurationId\n    }\n  }`,\n  {\n    variables: {\n      \"input\": {\n        \"id\": \"gid://shopify/GateConfiguration/0\"\n      }\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 gateConfigurationDelete($input: GateConfigurationDeleteInput!) {\n    gateConfigurationDelete(input: $input) {\n      userErrors {\n        field\n        message\n      }\n      deletedGateConfigurationId\n    }\n  }\nQUERY\n\nvariables = {\n  \"input\": {\n    \"id\": \"gid://shopify/GateConfiguration/0\"\n  }\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 gateConfigurationDelete($input: GateConfigurationDeleteInput!) {\n      gateConfigurationDelete(input: $input) {\n        userErrors {\n          field\n          message\n        }\n        deletedGateConfigurationId\n      }\n    }`,\n    \"variables\": {\n      \"input\": {\n        \"id\": \"gid://shopify/GateConfiguration/0\"\n      }\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 gateConfigurationDelete($input: GateConfigurationDeleteInput!) {\n    gateConfigurationDelete(input: $input) {\n      userErrors {\n        field\n        message\n      }\n      deletedGateConfigurationId\n    }\n  }\nQUERY;\n\n$variables = [\n  \"input\" => [\n    \"id\" => \"gid://shopify/GateConfiguration/0\",\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
    },
    "titleStringKey": "variables",
    "inputVariableEntries": [
      {
        "arg": {
          "name": "input",
          "description": "Specifies the gate configuration to delete by its ID.",
          "type": {
            "kind": "INPUT_OBJECT",
            "name": "GateConfigurationDeleteInput",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "GateConfigurationDeleteInput!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "input",
        "argValue": " {\"id\":\"gid://shopify/GateConfiguration/0\"}",
        "typeKind": "MUTATION"
      }
    ]
  }
]

gateConfigurationDeletemutation

Arguments

GateConfigurationDeletePayload returns

gateConfigurationDelete
mutation