Customer
Requires access scope.
A CustomerAccessToken represents the unique token required to make modifications to the customer object.
Anchor to FieldsFields
- Anchor to accessTokenaccess•String!non-null
Token The customer’s access token.
- Anchor to expiresAtexpires•Date
At Time!non-null The date and time when the customer access token expires.
Anchor to MutationsMutations
- •mutation
Creates a customer access token. The customer access token is required to modify the customer object in any way.
- Anchor to inputinput•Customer
Access Token Create Input!required The fields used to create a customer access token.
Arguments
- Anchor to customerAccessTokencustomer•Customer
Access Token Access Token The newly created customer access token object.
- Anchor to customerUserErrorscustomer•[Customer
User Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
- Anchor to userErrorsuser•[User
Errors Error!]!non-nullDeprecated
Fields
- •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.
- Anchor to multipassTokenmultipass•String!required
Token A valid multipass token to be authenticated.
Arguments
- Anchor to customerAccessTokencustomer•Customer
Access Token Access Token An access token object associated with the customer.
- Anchor to customerUserErrorscustomer•[Customer
User Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •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
.- Anchor to customerAccessTokencustomer•String!required
Access Token The access token used to identify the customer.
Arguments
- Anchor to customerAccessTokencustomer•Customer
Access Token Access Token The renewed customer access token object.
- Anchor to userErrorsuser•[User
Errors Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Activates a customer.
- •ID!required
Specifies the customer to activate.
- Anchor to inputinput•Customer
Activate Input!required The fields used to activate a customer.
Arguments
- Anchor to customercustomer•Customer
The customer object.
- Anchor to customerAccessTokencustomer•Customer
Access Token Access Token A newly created customer access token object for the customer.
- Anchor to customerUserErrorscustomer•[Customer
User Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
- Anchor to userErrorsuser•[User
Errors Error!]!non-nullDeprecated
Fields
- •mutation
Activates a customer with the activation url received from
.- Anchor to activationUrlactivation•URL!required
Url The customer activation URL.
- Anchor to passwordpassword•String!required
A new password set during activation.
Arguments
- Anchor to customercustomer•Customer
The customer that was activated.
- Anchor to customerAccessTokencustomer•Customer
Access Token Access Token A new customer access token for the customer.
- Anchor to customerUserErrorscustomer•[Customer
User Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
"Resets a customer’s password with the token received from a reset password email. You can send a reset password email with the
mutation."- •ID!required
Specifies the customer to reset.
- Anchor to inputinput•Customer
Reset Input!required The fields used to reset a customer’s password.
Arguments
- Anchor to customercustomer•Customer
The customer object which was reset.
- Anchor to customerAccessTokencustomer•Customer
Access Token Access Token A newly created customer access token object for the customer.
- Anchor to customerUserErrorscustomer•[Customer
User Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
- Anchor to userErrorsuser•[User
Errors Error!]!non-nullDeprecated
Fields
- •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
mutation."- Anchor to passwordpassword•String!required
New password that will be set as part of the reset password process.
- Anchor to resetUrlreset•URL!required
Url The customer's reset password url.
Arguments
- Anchor to customercustomer•Customer
The customer object which was reset.
- Anchor to customerAccessTokencustomer•Customer
Access Token Access Token A newly created customer access token object for the customer.
- Anchor to customerUserErrorscustomer•[Customer
User Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
- Anchor to userErrorsuser•[User
Errors Error!]!non-nullDeprecated
Fields
- •mutation
Updates an existing customer.
- Anchor to customercustomer•Customer
Update Input!required The customer object input.
- Anchor to customerAccessTokencustomer•String!required
Access Token The access token used to identify the customer.
Arguments
- Anchor to customercustomer•Customer
The updated customer object.
- Anchor to customerAccessTokencustomer•Customer
Access Token Access Token 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.
- Anchor to customerUserErrorscustomer•[Customer
User Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
- Anchor to userErrorsuser•[User
Errors Error!]!non-nullDeprecated
Fields