Skip to main content
object

Requires unauthenticated_read_customers access scope.

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

•String!non-null

The customer’s access token.

•DateTime!non-null

The date and time when the customer access token expires.


Was this section helpful?

•mutation

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

Arguments

•CustomerAccessTokenCreateInput!required

The fields used to create a customer access token.


Fields

•CustomerAccessToken

The newly created customer access token object.

•[CustomerUserError!]!non-null

The list of errors that occurred from executing the mutation.

•[UserError!]!non-nullDeprecated
•mutation

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

Arguments

•String!required

A valid multipass token to be authenticated.


Fields

•CustomerAccessToken

An access token object associated with the customer.

•[CustomerUserError!]!non-null

The list of errors that occurred from executing the mutation.

•mutation

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.

Arguments

•String!required

The access token used to identify the customer.


Fields

•CustomerAccessToken

The renewed customer access token object.

•[UserError!]!non-null

The list of errors that occurred from executing the mutation.

•mutation

Activates a customer.

Arguments

•ID!required

Specifies the customer to activate.

•CustomerActivateInput!required

The fields used to activate a customer.


Fields

•Customer

The customer object.

•CustomerAccessToken

A newly created customer access token object for the customer.

•[CustomerUserError!]!non-null

The list of errors that occurred from executing the mutation.

•[UserError!]!non-nullDeprecated
•mutation

Activates a customer with the activation url received from customerCreate.

Arguments

•URL!required

The customer activation URL.

•String!required

A new password set during activation.


Fields

•Customer

The customer that was activated.

•CustomerAccessToken

A new customer access token for the customer.

•[CustomerUserError!]!non-null

The list of errors that occurred from executing the mutation.

•mutation

"Resets a customer’s password with the token received from a reset password email. You can send a reset password email with the customerRecover mutation."

Arguments

•ID!required

Specifies the customer to reset.

•CustomerResetInput!required

The fields used to reset a customer’s password.


Fields

•Customer

The customer object which was reset.

•CustomerAccessToken

A newly created customer access token object for the customer.

•[CustomerUserError!]!non-null

The list of errors that occurred from executing the mutation.

•[UserError!]!non-nullDeprecated
•mutation

"Resets a customer’s password with the reset password URL received from a reset password email. You can send a reset password email with the customerRecover mutation."

Arguments

•String!required

New password that will be set as part of the reset password process.

•URL!required

The customer's reset password url.


Fields

•Customer

The customer object which was reset.

•CustomerAccessToken

A newly created customer access token object for the customer.

•[CustomerUserError!]!non-null

The list of errors that occurred from executing the mutation.

•[UserError!]!non-nullDeprecated
•mutation

Updates an existing customer.

Arguments

•CustomerUpdateInput!required

The customer object input.

•String!required

The access token used to identify the customer.


Fields

•Customer

The updated customer object.

•CustomerAccessToken

The newly created customer access token. If the customer's password is updated, all previous access tokens (including the one used to perform this mutation) become invalid, and a new token is generated.

•[CustomerUserError!]!non-null

The list of errors that occurred from executing the mutation.

•[UserError!]!non-nullDeprecated

Was this section helpful?