Choose a version:

storefrontAccessTokenCreate

mutation

Creates a storefront access token for use with the Storefront API.

An app can have a maximum of 100 active storefront access tokens for each shop.

Get started with the Storefront API.

Arguments

Anchor to inputinput • StorefrontAccessTokenInput!required: Provides the input fields for creating a storefront access token.

Was this section helpful?

Anchor to StorefrontAccessTokenCreatePayload returnsStorefrontAccessTokenCreatePayload returns

Anchor to shopshop • Shop!non-null: The user's shop.
Anchor to storefrontAccessTokenstorefrontAccessToken • StorefrontAccessToken: The storefront access token.
Anchor to userErrorsuserErrors • [UserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Create a Storefront Access Token
storefrontAccessTokenCreate reference

Examples

Open in GraphiQL

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 data = await response.json();

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

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-07/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"
    }
  }
}'

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 data = await response.json();

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"
      }
    },
  },
});

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)

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"

}