API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

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.

  • customerAccessTokenCreateWithMultipass

    Creates a customer access token using a multipass token instead of email and password. A customer record is created if customer does not exist. If a customer record already exists but the record is disabled, then it's enabled.

  • 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.

  • customerAccessTokenCreateWithMultipass

    Creates a customer access token using a multipass token instead of email and password. A customer record is created if customer does not exist. If a customer record already exists but the record is disabled, then it's enabled.

  • 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.

  • customerAccessTokenCreateWithMultipass

    Creates a customer access token using a multipass token instead of email and password. A customer record is created if customer does not exist. If a customer record already exists but the record is disabled, then it's enabled.

  • 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.

  • customerAccessTokenCreateWithMultipass

    Creates a customer access token using a multipass token instead of email and password. A customer record is created if customer does not exist. If a customer record already exists but the record is disabled, then it's enabled.

  • 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.

  • customerAccessTokenCreateWithMultipass

    Creates a customer access token using a multipass token instead of email and password. A customer record is created if customer does not exist. If a customer record already exists but the record is disabled, then it's enabled.

  • 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.

  • customerAccessTokenCreateWithMultipass

    Creates a customer access token using a multipass token instead of email and password. A customer record is created if customer does not exist. If a customer record already exists but the record is disabled, then it's enabled.

  • 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.

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.