storefrontAccessTokenDelete

mutation

Deletes a storefront access token.

Arguments

Anchor to inputinput • StorefrontAccessTokenDeleteInput!required: Provides the input fields required to delete a storefront access token.

Was this section helpful?

Anchor to StorefrontAccessTokenDeletePayload returnsStorefrontAccessTokenDeletePayload returns

Anchor to deletedStorefrontAccessTokenIddeletedStorefrontAccessTokenId • ID: The ID of the deleted storefront access token.
Anchor to userErrorsuserErrors • [UserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Delete a Storefront Access Token.
Deletes an existing storefront access token
storefrontAccessTokenDelete reference

Examples

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

const response = await admin.graphql(

`#graphql

mutation storefrontAccessTokenDelete($input: StorefrontAccessTokenDeleteInput!) {

storefrontAccessTokenDelete(input: $input) {

deletedStorefrontAccessTokenId

userErrors {

field

message

}

}`,

{

variables: {

"input": {

"id": "gid://shopify/StorefrontAccessToken/55270800"

}

);

const data = await response.json();

mutation storefrontAccessTokenDelete($input: StorefrontAccessTokenDeleteInput!) {
  storefrontAccessTokenDelete(input: $input) {
    deletedStorefrontAccessTokenId
    userErrors {
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation storefrontAccessTokenDelete($input: StorefrontAccessTokenDeleteInput!) { storefrontAccessTokenDelete(input: $input) { deletedStorefrontAccessTokenId userErrors { field message } } }",
 "variables": {
    "input": {
      "id": "gid://shopify/StorefrontAccessToken/55270800"
    }
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation storefrontAccessTokenDelete($input: StorefrontAccessTokenDeleteInput!) {
    storefrontAccessTokenDelete(input: $input) {
      deletedStorefrontAccessTokenId
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "input": {
        "id": "gid://shopify/StorefrontAccessToken/55270800"
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation storefrontAccessTokenDelete($input: StorefrontAccessTokenDeleteInput!) {
      storefrontAccessTokenDelete(input: $input) {
        deletedStorefrontAccessTokenId
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "input": {
        "id": "gid://shopify/StorefrontAccessToken/55270800"
      }
    },
  },
});

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 storefrontAccessTokenDelete($input: StorefrontAccessTokenDeleteInput!) {
    storefrontAccessTokenDelete(input: $input) {
      deletedStorefrontAccessTokenId
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "input": {
    "id": "gid://shopify/StorefrontAccessToken/55270800"
  }
}

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

Input variables

JSON

{

"input": {

"id": "gid://shopify/StorefrontAccessToken/55270800"

}

Response

JSON

{

"storefrontAccessTokenDelete": {

"deletedStorefrontAccessTokenId": "gid://shopify/StorefrontAccessToken/55270800",

"userErrors": []

}