Anchor to section titled 'undefined'storefront
storefront
mutation
Unstable
Deletes a storefront access token.
Anchor to section titled 'Arguments'
Arguments
Provides the input fields required to delete a storefront access token.
Was this section helpful?
Anchor to section titled 'StorefrontAccessTokenDeletePayload returns'
StorefrontAccessTokenDeletePayload returns
- Anchor to StorefrontAccessTokenDeletePayload.deletedStorefrontAccessTokenIddeleted
Storefront Access Token Id The ID of the deleted storefront access token.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: storefrontAccessTokenDelete
Query Reference for MUTATION: storefrontAccessTokenDelete
"mutation storefrontAccessTokenDelete($input: StorefrontAccessTokenDeleteInput!) {\n storefrontAccessTokenDelete(input: $input) {\n deletedStorefrontAccessTokenId\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: storefrontAccessTokenDelete
"{\n \"input\": {\n \"id\": \"gid://shopify/<objectName>/10079785100\"\n }\n}"Schema Reference for MUTATION: storefrontAccessTokenDelete
"input StorefrontAccessTokenDeleteInput {\n id: ID!\n}\n"Display Examples for MUTATION: storefrontAccessTokenDelete
[
{
"example": {
"type_name": "storefrontaccesstokendelete",
"title": "Delete a Storefront Access Token.",
"description": "This example demonstrates how to delete a storefront access token.",
"query_string": "mutation storefrontAccessTokenDelete($input: StorefrontAccessTokenDeleteInput!) {\n storefrontAccessTokenDelete(input: $input) {\n deletedStorefrontAccessTokenId\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"input": {
"id": "gid://shopify/StorefrontAccessToken/55270800"
}
},
"response": {
"data": {
"storefrontAccessTokenDelete": {
"deletedStorefrontAccessTokenId": "gid://shopify/StorefrontAccessToken/55270800",
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/apps/test/unit/graph_api/admin/mutations/storefront_access_token_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 storefrontAccessTokenDelete($input: StorefrontAccessTokenDeleteInput!) { storefrontAccessTokenDelete(input: $input) { deletedStorefrontAccessTokenId userErrors { field message } } }\",\n \"variables\": {\n \"input\": {\n \"id\": \"gid://shopify/StorefrontAccessToken/55270800\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation storefrontAccessTokenDelete($input: StorefrontAccessTokenDeleteInput!) {\n storefrontAccessTokenDelete(input: $input) {\n deletedStorefrontAccessTokenId\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"id\": \"gid://shopify/StorefrontAccessToken/55270800\"\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 storefrontAccessTokenDelete($input: StorefrontAccessTokenDeleteInput!) {\n storefrontAccessTokenDelete(input: $input) {\n deletedStorefrontAccessTokenId\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"id\": \"gid://shopify/StorefrontAccessToken/55270800\"\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 storefrontAccessTokenDelete($input: StorefrontAccessTokenDeleteInput!) {\n storefrontAccessTokenDelete(input: $input) {\n deletedStorefrontAccessTokenId\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"id\": \"gid://shopify/StorefrontAccessToken/55270800\"\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 storefrontAccessTokenDelete($input: StorefrontAccessTokenDeleteInput!) {\n storefrontAccessTokenDelete(input: $input) {\n deletedStorefrontAccessTokenId\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"id\" => \"gid://shopify/StorefrontAccessToken/55270800\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "Provides the input fields required to delete a storefront access token.",
"type": {
"kind": "INPUT_OBJECT",
"name": "StorefrontAccessTokenDeleteInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "StorefrontAccessTokenDeleteInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"id\":\"gid://shopify/StorefrontAccessToken/55270800\"}",
"typeKind": "MUTATION"
}
]
}
]