Skip to Content
ReferenceStorefrontv1.0.0 API ReferenceMutationscustomerAccessTokenRenew

customerAccessTokenRenew

Renews a customer access token.

Authentication

Authentication Required: Secret API key with scope customer:auth

Mutation Structure

mutation {
  customerAccessTokenRenew(customerAccessToken: String!) {
    customerAccessToken {
      # CustomerAccessToken fields
    }
    customerUserErrors {
      # CustomerUserError fields
    }
  }
}

Input Arguments

ArgumentTypeRequiredDescription
customerAccessTokenStringYesThe customer access token to renew

Return Type

CustomerAccessTokenRenewPayload - Payload returned by the customerAccessTokenRenew mutation. Contains the renewed customer access token and any errors that occurred during the operation.

Example

mutation {
  customerAccessTokenRenew(customerAccessToken: "eyJhbGciOiJIUzI1NiJ9...") {
    customerAccessToken {
      accessToken
      expiresAt
    }
    customerUserErrors {
      code
      field
      message
    }
  }
}