Choose a version:

storefrontAccessTokenCreate

mutation

Creates a storefront access token that delegates unauthenticated access scopes to clients using the Storefront API. The token provides public access to storefront resources without requiring customer authentication.

Each shop can have up to 100 active StorefrontAccessToken objects. Headless storefronts, mobile apps, and other client applications typically use these tokens to access public storefront data.

Learn more about building with the Storefront API.

Anchor to Arguments

Arguments

Anchor to inputinput

•StorefrontAccessTokenInput!

required

Provides the input fields for creating a storefront access token.

Show input fields

Was this section helpful?

Anchor to StorefrontAccessTokenCreatePayload returnsStorefrontAccessTokenCreatePayload returns

Anchor to shopshop •Shop! non-null: The user's shop.

Show fields
Anchor to storefrontAccessTokenstorefrontAccessToken •StorefrontAccessToken: The storefront access token.

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

Create a Storefront Access Token

Description

This example demonstrates how to create a storefront access token.

Query

mutation StorefrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {
  storefrontAccessTokenCreate(input: $input) {
    userErrors {
      field
      message
    }
    shop {
      id
    }
    storefrontAccessToken {
      accessScopes {
        handle
      }
      accessToken
      title
    }
  }
}

Variables

{
  "input": {
    "title": "New Storefront Access Token"
  }
}

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 StorefrontAccessTokenCreate($input: StorefrontAccessTokenInput!) { storefrontAccessTokenCreate(input: $input) { userErrors { field message } shop { id } storefrontAccessToken { accessScopes { handle } accessToken title } } }",
 "variables": {
    "input": {
      "title": "New Storefront Access Token"
    }
  }
}'

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 StorefrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {
    storefrontAccessTokenCreate(input: $input) {
      userErrors {
        field
        message
      }
      shop {
        id
      }
      storefrontAccessToken {
        accessScopes {
          handle
        }
        accessToken
        title
      }
    }
  }`,
  {
    variables: {
        "input": {
            "title": "New Storefront Access Token"
        }
    },
  },
  );
  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 StorefrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {
    storefrontAccessTokenCreate(input: $input) {
      userErrors {
        field
        message
      }
      shop {
        id
      }
      storefrontAccessToken {
        accessScopes {
          handle
        }
        accessToken
        title
      }
    }
  }
QUERY

variables = {
  "input": {
    "title": "New Storefront Access Token"
  }
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation StorefrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {
      storefrontAccessTokenCreate(input: $input) {
        userErrors {
          field
          message
        }
        shop {
          id
        }
        storefrontAccessToken {
          accessScopes {
            handle
          }
          accessToken
          title
        }
      }
    }`,
    "variables": {
        "input": {
            "title": "New Storefront Access Token"
        }
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation StorefrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {
  storefrontAccessTokenCreate(input: $input) {
    userErrors {
      field
      message
    }
    shop {
      id
    }
    storefrontAccessToken {
      accessScopes {
        handle
      }
      accessToken
      title
    }
  }
}' \
--variables \
'{
  "input": {
    "title": "New Storefront Access Token"
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation StorefrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {
        storefrontAccessTokenCreate(input: $input) {
          userErrors {
            field
            message
          }
          shop {
            id
          }
          storefrontAccessToken {
            accessScopes {
              handle
            }
            accessToken
            title
          }
        }
      }
    `,
    variables: {
        "input": {
            "title": "New Storefront Access Token"
        }
    },
  }),
});

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

Response

{
  "storefrontAccessTokenCreate": {
    "userErrors": [],
    "shop": {
      "id": "gid://shopify/Shop/325953821"
    },
    "storefrontAccessToken": {
      "accessScopes": [
        {
          "handle": "unauthenticated_read_product_listings"
        },
        {
          "handle": "unauthenticated_write_checkouts"
        },
        {
          "handle": "unauthenticated_read_checkouts"
        },
        {
          "handle": "unauthenticated_read_selling_plans"
        }
      ],
      "accessToken": "d016c3f69af5f85abdcd3b3252469efc",
      "title": "New Storefront Access Token"
    }
  }
}

Creates a new StorefrontAccessToken

Query

mutation storeFrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {
  storefrontAccessTokenCreate(input: $input) {
    storefrontAccessToken {
      id
      accessToken
      accessScopes {
        handle
      }
      createdAt
      title
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "input": {
    "title": "New Storefront Access Token"
  }
}

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 storeFrontAccessTokenCreate($input: StorefrontAccessTokenInput!) { storefrontAccessTokenCreate(input: $input) { storefrontAccessToken { id accessToken accessScopes { handle } createdAt title } userErrors { field message } } }",
 "variables": {
    "input": {
      "title": "New Storefront Access Token"
    }
  }
}'

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 storeFrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {
    storefrontAccessTokenCreate(input: $input) {
      storefrontAccessToken {
        id
        accessToken
        accessScopes {
          handle
        }
        createdAt
        title
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "input": {
            "title": "New Storefront Access Token"
        }
    },
  },
  );
  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 storeFrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {
    storefrontAccessTokenCreate(input: $input) {
      storefrontAccessToken {
        id
        accessToken
        accessScopes {
          handle
        }
        createdAt
        title
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "input": {
    "title": "New Storefront Access Token"
  }
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation storeFrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {
      storefrontAccessTokenCreate(input: $input) {
        storefrontAccessToken {
          id
          accessToken
          accessScopes {
            handle
          }
          createdAt
          title
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "input": {
            "title": "New Storefront Access Token"
        }
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation storeFrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {
  storefrontAccessTokenCreate(input: $input) {
    storefrontAccessToken {
      id
      accessToken
      accessScopes {
        handle
      }
      createdAt
      title
    }
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "input": {
    "title": "New Storefront Access Token"
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation storeFrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {
        storefrontAccessTokenCreate(input: $input) {
          storefrontAccessToken {
            id
            accessToken
            accessScopes {
              handle
            }
            createdAt
            title
          }
          userErrors {
            field
            message
          }
        }
      }
    `,
    variables: {
        "input": {
            "title": "New Storefront Access Token"
        }
    },
  }),
});

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

Response

{
  "storefrontAccessTokenCreate": {
    "storefrontAccessToken": {
      "id": "gid://shopify/StorefrontAccessToken/1003303992",
      "accessToken": "2a1753b19c85ac630f27391da802765d",
      "accessScopes": [
        {
          "handle": "unauthenticated_read_product_listings"
        },
        {
          "handle": "unauthenticated_write_checkouts"
        },
        {
          "handle": "unauthenticated_read_checkouts"
        },
        {
          "handle": "unauthenticated_read_selling_plans"
        }
      ],
      "createdAt": "2024-10-29T18:54:07Z",
      "title": "New Storefront Access Token"
    },
    "userErrors": []
  }
}

storefrontAccessTokenCreate 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 StorefrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {

storefrontAccessTokenCreate(input: $input) {

userErrors {

field

message

}

shop {

}

storefrontAccessToken {

accessScopes {

handle

}

accessToken

title

}

}`,

{

variables: {

"input": {

"title": "New Storefront Access Token"

}

);

const json = await response.json();

return json.data;

}

GQL

mutation StorefrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {
  storefrontAccessTokenCreate(input: $input) {
    userErrors {
      field
      message
    }
    shop {
      id
    }
    storefrontAccessToken {
      accessScopes {
        handle
      }
      accessToken
      title
    }
  }
}

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 StorefrontAccessTokenCreate($input: StorefrontAccessTokenInput!) { storefrontAccessTokenCreate(input: $input) { userErrors { field message } shop { id } storefrontAccessToken { accessScopes { handle } accessToken title } } }",
 "variables": {
    "input": {
      "title": "New Storefront Access Token"
    }
  }
}'

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 StorefrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {
    storefrontAccessTokenCreate(input: $input) {
      userErrors {
        field
        message
      }
      shop {
        id
      }
      storefrontAccessToken {
        accessScopes {
          handle
        }
        accessToken
        title
      }
    }
  }`,
  {
    variables: {
        "input": {
            "title": "New Storefront Access Token"
        }
    },
  },
  );
  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 StorefrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {
      storefrontAccessTokenCreate(input: $input) {
        userErrors {
          field
          message
        }
        shop {
          id
        }
        storefrontAccessToken {
          accessScopes {
            handle
          }
          accessToken
          title
        }
      }
    }`,
    "variables": {
        "input": {
            "title": "New Storefront Access Token"
        }
    },
  },
});

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 StorefrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {
    storefrontAccessTokenCreate(input: $input) {
      userErrors {
        field
        message
      }
      shop {
        id
      }
      storefrontAccessToken {
        accessScopes {
          handle
        }
        accessToken
        title
      }
    }
  }
QUERY

variables = {
  "input": {
    "title": "New Storefront Access Token"
  }
}

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

Shopify CLI

shopify app execute \
--query \
'mutation StorefrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {
  storefrontAccessTokenCreate(input: $input) {
    userErrors {
      field
      message
    }
    shop {
      id
    }
    storefrontAccessToken {
      accessScopes {
        handle
      }
      accessToken
      title
    }
  }
}' \
--variables \
'{
  "input": {
    "title": "New Storefront Access Token"
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation StorefrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {
        storefrontAccessTokenCreate(input: $input) {
          userErrors {
            field
            message
          }
          shop {
            id
          }
          storefrontAccessToken {
            accessScopes {
              handle
            }
            accessToken
            title
          }
        }
      }
    `,
    variables: {
        "input": {
            "title": "New Storefront Access Token"
        }
    },
  }),
});

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

Input variables

JSON

{

"input": {

"title": "New Storefront Access Token"

}

Response

JSON

{

"storefrontAccessTokenCreate": {

"userErrors": [],

"shop": {

"id": "gid://shopify/Shop/325953821"

"storefrontAccessToken": {

"accessScopes": [

{

"handle": "unauthenticated_read_product_listings"

{

"handle": "unauthenticated_write_checkouts"

{

"handle": "unauthenticated_read_checkouts"

{

"handle": "unauthenticated_read_selling_plans"

}

"accessToken": "d016c3f69af5f85abdcd3b3252469efc",

"title": "New Storefront Access Token"

}