Anchor to section titled 'undefined'storefront
storefront
mutation
2024-10latest
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.
Anchor to section titled 'Arguments'
Arguments
Provides the input fields for creating a storefront access token.
Was this section helpful?
Anchor to section titled 'StorefrontAccessTokenCreatePayload returns'
StorefrontAccessTokenCreatePayload returns
The user's shop.
The storefront access token.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: storefrontAccessTokenCreate
Query Reference for MUTATION: storefrontAccessTokenCreate
"mutation storefrontAccessTokenCreate($input: StorefrontAccessTokenInput!) {\n storefrontAccessTokenCreate(input: $input) {\n shop {\n # Shop fields\n }\n storefrontAccessToken {\n # StorefrontAccessToken fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: storefrontAccessTokenCreate
"{\n \"input\": {\n \"title\": \"<your-title>\"\n }\n}"Schema Reference for MUTATION: storefrontAccessTokenCreate
"input StorefrontAccessTokenInput {\n title: String!\n}\n"Display Examples for MUTATION: storefrontAccessTokenCreate
[
{
"example": {
"type_name": "storefrontaccesstokencreate",
"title": "Create a Storefront Access Token",
"description": "This example demonstrates how to create a storefront access token.",
"query_string": "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}",
"variables": {
"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": "010d7d4bcbde61fb31e04ced99c1bb83",
"title": "New Storefront Access Token"
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/apps/test/unit/graph_api/admin/mutations/storefront_access_token_create_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/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",
"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",
"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",
"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",
"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"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "Provides the input fields for creating a storefront access token.",
"type": {
"kind": "INPUT_OBJECT",
"name": "StorefrontAccessTokenInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "StorefrontAccessTokenInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"title\":\"New Storefront Access Token\"}",
"typeKind": "MUTATION"
}
]
}
]