Choose a version:

customerAccessTokenCreate

mutation

Requires unauthenticated_write_customers access scope.

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

Anchor to Arguments

Arguments

Anchor to inputinput •CustomerAccessTokenCreateInput! required: The fields used to create a customer access token.

Was this section helpful?

Anchor to CustomerAccessTokenCreatePayload returnsCustomerAccessTokenCreatePayload returns

Anchor to customerAccessTokencustomerAccessToken •CustomerAccessToken: The newly created customer access token object.
Anchor to customerUserErrorscustomerUserErrors •[CustomerUserError!]! non-null: The list of errors that occurred from executing the mutation.
Anchor to userErrorsuserErrors •[UserError!]! non-nullDeprecated: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Create a customer access token

Description

Creates a unique customer access token that's required to read and modify the [Customer](https://shopify.dev/api/storefront/latest/objects/customer) object.

Query

mutation customerAccessTokenCreate {
  customerAccessTokenCreate(input: {email: "ghaida@example.com", password: "7dx2gx2Z"}) {
    customerAccessToken {
      accessToken
    }
    customerUserErrors {
      message
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \
-d '{
"query": "mutation customerAccessTokenCreate { customerAccessTokenCreate(input: {email: \"ghaida@example.com\", password: \"7dx2gx2Z\"}) { customerAccessToken { accessToken } customerUserErrors { message } } }"
}'

Remix

const { storefront } = await unauthenticated.storefront(
  'your-development-store.myshopify.com'
);

const response = await storefront.graphql(
  `#graphql
  mutation customerAccessTokenCreate {
    customerAccessTokenCreate(input: {email: "ghaida@example.com", password: "7dx2gx2Z"}) {
      customerAccessToken {
        accessToken
      }
      customerUserErrors {
        message
      }
    }
  }`,
);

const data = await response.json();

Node.js

const client = new shopify.clients.Storefront({
  domain: 'your-development-store.myshopify.com',
  storefrontAccessToken,
});
const data = await client.query({
  data: `mutation customerAccessTokenCreate {
    customerAccessTokenCreate(input: {email: "ghaida@example.com", password: "7dx2gx2Z"}) {
      customerAccessToken {
        accessToken
      }
      customerUserErrors {
        message
      }
    }
  }`,
});

Response

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

Get a customer by customer access token

Description

Retrieves the customer with the associated access token and returns the customer fields specified in the query.

Query

query {
  customer(customerAccessToken: "bobs_token") {
    id
    firstName
    lastName
    acceptsMarketing
    email
    phone
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \
-d '{
"query": "query { customer(customerAccessToken: \"bobs_token\") { id firstName lastName acceptsMarketing email phone } }"
}'

Remix

const { storefront } = await unauthenticated.storefront(
  'your-development-store.myshopify.com'
);

const response = await storefront.graphql(
  `#graphql
  query {
    customer(customerAccessToken: "bobs_token") {
      id
      firstName
      lastName
      acceptsMarketing
      email
      phone
    }
  }`,
);

const data = await response.json();

Node.js

const client = new shopify.clients.Storefront({
  domain: 'your-development-store.myshopify.com',
  storefrontAccessToken,
});
const data = await client.query({
  data: `query {
    customer(customerAccessToken: "bobs_token") {
      id
      firstName
      lastName
      acceptsMarketing
      email
      phone
    }
  }`,
});

Response

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

customerAccessTokenCreate reference

Examples

Open in GraphiQL

const { storefront } = await unauthenticated.storefront(

'your-development-store.myshopify.com'

);

const response = await storefront.graphql(

`#graphql

mutation customerAccessTokenCreate {

customerAccessTokenCreate(input: {email: "ghaida@example.com", password: "7dx2gx2Z"}) {

customerAccessToken {

accessToken

}

customerUserErrors {

message

}

}`,

);

const data = await response.json();

mutation customerAccessTokenCreate {
  customerAccessTokenCreate(input: {email: "ghaida@example.com", password: "7dx2gx2Z"}) {
    customerAccessToken {
      accessToken
    }
    customerUserErrors {
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \
-d '{
"query": "mutation customerAccessTokenCreate { customerAccessTokenCreate(input: {email: \"ghaida@example.com\", password: \"7dx2gx2Z\"}) { customerAccessToken { accessToken } customerUserErrors { message } } }"
}'

const { storefront } = await unauthenticated.storefront(
  'your-development-store.myshopify.com'
);

const response = await storefront.graphql(
  `#graphql
  mutation customerAccessTokenCreate {
    customerAccessTokenCreate(input: {email: "ghaida@example.com", password: "7dx2gx2Z"}) {
      customerAccessToken {
        accessToken
      }
      customerUserErrors {
        message
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Storefront({
  domain: 'your-development-store.myshopify.com',
  storefrontAccessToken,
});
const data = await client.query({
  data: `mutation customerAccessTokenCreate {
    customerAccessTokenCreate(input: {email: "ghaida@example.com", password: "7dx2gx2Z"}) {
      customerAccessToken {
        accessToken
      }
      customerUserErrors {
        message
      }
    }
  }`,
});

Response

JSON

{

"customerAccessTokenCreate": {

"customerAccessToken": {

"accessToken": "ghaidas_token"

"customerUserErrors": []

}