Skip to Content
ReferenceStorefrontv1.0.0 API ReferenceObjectsCustomerAccessTokenCreatePayload

CustomerAccessTokenCreatePayload

Payload returned by the customerAccessTokenCreate mutation. This type encapsulates the result of attempting to create a customer access token, including either the successfully created token or any errors that occurred during the operation.

Type Definition

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

Fields

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

Relationships

CustomerAccessTokenCreatePayload is returned by the customerAccessTokenCreate mutation. It contains a reference to a CustomerAccessToken object when the token creation succeeds, and includes CustomerUserError objects that describe any validation or processing errors that occur during the operation.

Example

{
  customerAccessTokenCreatePayload {
    customerAccessToken {
      accessToken
      expiresAt
    }
    customerUserErrors {
      field
      message
    }
  }
}

Implements

This type does not implement any interfaces.