Skip to Content
ReferenceStorefrontv1.3.0 API Reference (Latest)MutationscustomerAccessTokenRenew

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 an optional renewed customer access token and a list of any errors that occurred during the operation.

Example

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