customerAccessTokenCreate - storefront - MUTATION

Version: 2025-01

Description:

Creates a customer access token. The customer access token is required to modify the customer object in any way.

Access Scopes

`unauthenticated_write_customers` access scope.

Arguments

• input: CustomerAccessTokenCreateInput! - The fields used to create a customer access token.

Returns

• customerAccessToken: CustomerAccessToken The newly created customer access token object.
• customerUserErrors: CustomerUserError! The list of errors that occurred from executing the mutation.
• userErrors: UserError! The list of errors that occurred from executing the mutation.

Examples

• Create a customer access token

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/api/2025-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \\\n-d '{\n\"query\": \"mutation customerAccessTokenCreate { customerAccessTokenCreate(input: {email: \\\"ghaida@example.com\\\", password: \\\"7dx2gx2Z\\\"}) { customerAccessToken { accessToken } customerUserErrors { message } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Storefront({\n  domain: 'your-development-store.myshopify.com',\n  storefrontAccessToken,\n});\nconst data = await client.query({\n  data: `mutation customerAccessTokenCreate {\n    customerAccessTokenCreate(input: {email: \"ghaida@example.com\", password: \"7dx2gx2Z\"}) {\n      customerAccessToken {\n        accessToken\n      }\n      customerUserErrors {\n        message\n      }\n    }\n  }`,\n});\n"
          Ruby example: null
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new ShopifyClientsStorefront(\"your-development-store.myshopify.com\", $storefrontAccessToken);\n$query = <<<QUERY\n  mutation customerAccessTokenCreate {\n    customerAccessTokenCreate(input: {email: \"ghaida@example.com\", password: \"7dx2gx2Z\"}) {\n      customerAccessToken {\n        accessToken\n      }\n      customerUserErrors {\n        message\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { storefront } = await unauthenticated.storefront(\n  'your-development-store.myshopify.com'\n);\n\nconst response = await storefront.graphql(\n  `#graphql\n  mutation customerAccessTokenCreate {\n    customerAccessTokenCreate(input: {email: \"ghaida@example.com\", password: \"7dx2gx2Z\"}) {\n      customerAccessToken {\n        accessToken\n      }\n      customerUserErrors {\n        message\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation customerAccessTokenCreate {\n  customerAccessTokenCreate(input: {email: \"ghaida@example.com\", password: \"7dx2gx2Z\"}) {\n    customerAccessToken {\n      accessToken\n    }\n    customerUserErrors {\n      message\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "customerAccessTokenCreate": {
        "customerAccessToken": {
          "accessToken": "ghaidas_token"
        },
        "customerUserErrors": []
      }
    }
  }

  Get a customer by access token

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/api/2025-01/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \\\n-d '{\n\"query\": \"query { customer(customerAccessToken: \\\"bobs_token\\\") { id firstName lastName acceptsMarketing email phone } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Storefront({\n  domain: 'your-development-store.myshopify.com',\n  storefrontAccessToken,\n});\nconst data = await client.query({\n  data: `query {\n    customer(customerAccessToken: \"bobs_token\") {\n      id\n      firstName\n      lastName\n      acceptsMarketing\n      email\n      phone\n    }\n  }`,\n});\n"
          Ruby example: null
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new ShopifyClientsStorefront(\"your-development-store.myshopify.com\", $storefrontAccessToken);\n$query = <<<QUERY\n  query {\n    customer(customerAccessToken: \"bobs_token\") {\n      id\n      firstName\n      lastName\n      acceptsMarketing\n      email\n      phone\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { storefront } = await unauthenticated.storefront(\n  'your-development-store.myshopify.com'\n);\n\nconst response = await storefront.graphql(\n  `#graphql\n  query {\n    customer(customerAccessToken: \"bobs_token\") {\n      id\n      firstName\n      lastName\n      acceptsMarketing\n      email\n      phone\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  customer(customerAccessToken: \"bobs_token\") {\n    id\n    firstName\n    lastName\n    acceptsMarketing\n    email\n    phone\n  }\n}"
        

  input: null

  response: {
    "data": {
      "customer": {
        "id": "gid://shopify/Customer/410535040",
        "firstName": "John",
        "lastName": "Smith",
        "acceptsMarketing": false,
        "email": "johnsmith@example.com",
        "phone": "+16134504533"
      }
    }
  }