Skip to Content
ReferenceStorefrontv1.0.0 API ReferenceObjectsCustomerAccessTokenRenewPayload

CustomerAccessTokenRenewPayload

Payload returned by the customerAccessTokenRenew mutation. This type contains the renewed access token and any errors that may have occurred during the renewal process.

Type Definition

type CustomerAccessTokenRenewPayload {
  customerAccessToken: CustomerAccessToken
  customerUserErrors: [CustomerUserError]!
}

Fields

FieldTypeDescription
customerAccessTokenCustomerAccessTokenThe renewed customer access token
customerUserErrors[CustomerUserError]!List of errors that occurred during the operation

Relationships

The CustomerAccessTokenRenewPayload type is returned by the customerAccessTokenRenew mutation. It contains a reference to a CustomerAccessToken object that represents the renewed authentication token, and a list of CustomerUserError objects that provide details about any validation or processing errors that occurred during the token renewal operation.

Example

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

Implements

This type does not implement any interfaces.