CustomerAccessToken object

A CustomerAccessToken represents the unique token required to make modifications to the customer object.

Required access

unauthenticated_read_customers access scope

Fields

accessToken (String!)

The customer’s access token.

expiresAt (DateTime!)

The date and time when the customer access token expires.

Mutations for CustomerAccessToken

customerAccessTokenCreate

Creates a customer access token. The customer access token is required to modify the customer object in any way.

customerAccessTokenDelete

Permanently destroys a customer access token.

customerAccessTokenRenew

Renews a customer access token.

Access token renewal must happen before a token expires. If a token has already expired, a new one should be created instead via customerAccessTokenCreate.

A CustomerAccessToken represents the unique token required to make modifications to the customer object.

Required access

unauthenticated_read_customers access scope

Fields

accessToken (String!)

The customer’s access token.

expiresAt (DateTime!)

The date and time when the customer access token expires.

Mutations for CustomerAccessToken

customerAccessTokenCreate

Creates a customer access token. The customer access token is required to modify the customer object in any way.

customerAccessTokenDelete

Permanently destroys a customer access token.

customerAccessTokenRenew

Renews a customer access token.

Access token renewal must happen before a token expires. If a token has already expired, a new one should be created instead via customerAccessTokenCreate.

A CustomerAccessToken represents the unique token required to make modifications to the customer object.

Required access

unauthenticated_read_customers access scope

Fields

accessToken (String!)

The customer’s access token.

expiresAt (DateTime!)

The date and time when the customer access token expires.

Mutations for CustomerAccessToken

customerAccessTokenCreate

Creates a customer access token. The customer access token is required to modify the customer object in any way.

customerAccessTokenDelete

Permanently destroys a customer access token.

customerAccessTokenRenew

Renews a customer access token.

Access token renewal must happen before a token expires. If a token has already expired, a new one should be created instead via customerAccessTokenCreate.

Sign up for a Partner account to get started.

Sign up