Skip to Content
ReferenceStorefrontv1.0.0 API ReferenceMutationscustomerAccessTokenCreate

customerAccessTokenCreate

Creates a customer access token (login).

Authentication

Authentication Required: Secret API key with scope customer:auth

Mutation Structure

mutation {
  customerAccessTokenCreate(input: CustomerAccessTokenCreateInput!) {
    customerAccessToken: CustomerAccessToken
    customerUserErrors: [CustomerUserError]!
  }
}

Input Arguments

ArgumentTypeRequiredDescription
inputCustomerAccessTokenCreateInputYesThe input for creating a customer access token

Return Type

CustomerAccessTokenCreatePayload - Payload returned by the customerAccessTokenCreate mutation. Contains the created customer access token and any errors that occurred during the operation.

Example

mutation {
  customerAccessTokenCreate(input: {
    email: "customer@example.com"
    password: "SecurePassword123"
  }) {
    customerAccessToken {
      accessToken
      expiresAt
    }
    customerUserErrors {
      field
      message
      code
    }
  }
}