storefrontAccessTokenCreate - admin-graphql - MUTATION

Version: 2025-01

Description:

Creates a storefront access token for use with the [Storefront API](https://shopify.dev/docs/api/storefront). An app can have a maximum of 100 active storefront access tokens for each shop. [Get started with the Storefront API](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/getting-started).

Access Scopes

Arguments

• input: StorefrontAccessTokenInput! - Provides the input fields for creating a storefront access token.

Returns

• shop: Shop! The user's shop.
• storefrontAccessToken: StorefrontAccessToken The storefront access token.
• userErrors: UserError! The list of errors that occurred from executing the mutation.

Examples

• Create a Storefront Access Token

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation StorefrontAccessTokenCreate($input: StorefrontAccessTokenInput!) { storefrontAccessTokenCreate(input: $input) { userErrors { field message } shop { id } storefrontAccessToken { accessScopes { handle } accessToken title } } }\",\n \"variables\": {\n    \"input\": {\n      \"title\": \"New Storefront Access Token\"\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation StorefrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {\n      storefrontAccessTokenCreate(input: $input) {\n        userErrors {\n          field\n          message\n        }\n        shop {\n          id\n        }\n        storefrontAccessToken {\n          accessScopes {\n            handle\n          }\n          accessToken\n          title\n        }\n      }\n    }`,\n    \"variables\": {\n      \"input\": {\n        \"title\": \"New Storefront Access Token\"\n      }\n    },\n  },\n});\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 StorefrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {\n    storefrontAccessTokenCreate(input: $input) {\n      userErrors {\n        field\n        message\n      }\n      shop {\n        id\n      }\n      storefrontAccessToken {\n        accessScopes {\n          handle\n        }\n        accessToken\n        title\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"input\": {\n    \"title\": \"New Storefront Access Token\"\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation StorefrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {\n    storefrontAccessTokenCreate(input: $input) {\n      userErrors {\n        field\n        message\n      }\n      shop {\n        id\n      }\n      storefrontAccessToken {\n        accessScopes {\n          handle\n        }\n        accessToken\n        title\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"input\" => [\n    \"title\" => \"New Storefront Access Token\",\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation StorefrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {\n    storefrontAccessTokenCreate(input: $input) {\n      userErrors {\n        field\n        message\n      }\n      shop {\n        id\n      }\n      storefrontAccessToken {\n        accessScopes {\n          handle\n        }\n        accessToken\n        title\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"input\": {\n        \"title\": \"New Storefront Access Token\"\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation StorefrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {\n  storefrontAccessTokenCreate(input: $input) {\n    userErrors {\n      field\n      message\n    }\n    shop {\n      id\n    }\n    storefrontAccessToken {\n      accessScopes {\n        handle\n      }\n      accessToken\n      title\n    }\n  }\n}"
        

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

  response: {
    "data": {
      "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

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation storeFrontAccessTokenCreate($input: StorefrontAccessTokenInput!) { storefrontAccessTokenCreate(input: $input) { storefrontAccessToken { id accessToken accessScopes { handle } createdAt title } userErrors { field message } } }\",\n \"variables\": {\n    \"input\": {\n      \"title\": \"New Storefront Access Token\"\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation storeFrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {\n      storefrontAccessTokenCreate(input: $input) {\n        storefrontAccessToken {\n          id\n          accessToken\n          accessScopes {\n            handle\n          }\n          createdAt\n          title\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"input\": {\n        \"title\": \"New Storefront Access Token\"\n      }\n    },\n  },\n});\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 storeFrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {\n    storefrontAccessTokenCreate(input: $input) {\n      storefrontAccessToken {\n        id\n        accessToken\n        accessScopes {\n          handle\n        }\n        createdAt\n        title\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"input\": {\n    \"title\": \"New Storefront Access Token\"\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation storeFrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {\n    storefrontAccessTokenCreate(input: $input) {\n      storefrontAccessToken {\n        id\n        accessToken\n        accessScopes {\n          handle\n        }\n        createdAt\n        title\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"input\" => [\n    \"title\" => \"New Storefront Access Token\",\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation storeFrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {\n    storefrontAccessTokenCreate(input: $input) {\n      storefrontAccessToken {\n        id\n        accessToken\n        accessScopes {\n          handle\n        }\n        createdAt\n        title\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"input\": {\n        \"title\": \"New Storefront Access Token\"\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation storeFrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {\n  storefrontAccessTokenCreate(input: $input) {\n    storefrontAccessToken {\n      id\n      accessToken\n      accessScopes {\n        handle\n      }\n      createdAt\n      title\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

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

  response: {
    "data": {
      "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": []
      }
    }
  }