Customer
Requires access scope.
A CustomerAccessToken represents the unique token required to make modifications to the customer object.
Anchor to FieldsFields
- accessToken (String!)
- expiresAt (DateTime!)
- Anchor to accessTokenaccess•String!
Token non-null Token access required The customer’s access token.
- Anchor to expiresAtexpires•Date
At Time! non-null Token access required The date and time when the customer access token expires.
Anchor to MutationsMutations
- customerAccessTokenCreate (CustomerAccessTokenCreatePayload)
- customerAccessTokenCreateWithMultipass (CustomerAccessTokenCreateWithMultipassPayload)
- customerAccessTokenRenew (CustomerAccessTokenRenewPayload)
- customerActivate (CustomerActivatePayload)
- customerActivateByUrl (CustomerActivateByUrlPayload)
- customerReset (CustomerResetPayload)
- customerResetByUrl (CustomerResetByUrlPayload)
- customerUpdate (CustomerUpdatePayload)
- •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
- •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!
Token required A valid multipass token to be authenticated.
Arguments
- •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!
Access Token required The access token used to identify the customer.
Arguments
- •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
- •ID!
- •mutation
Activates a customer with the activation url received from
.- Anchor to activationUrlactivation•URL!
Url required The customer activation URL.
- Anchor to passwordpassword•String!required
A new password set during activation.
Arguments
- •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
- •ID!
- •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 resetUrlreset•URL!
Url required The customer's reset password url.
- Anchor to passwordpassword•String!required
New password that will be set as part of the reset password process.
Arguments
- •mutation
Updates an existing customer.
- Anchor to customerAccessTokencustomer•String!
Access Token required The access token used to identify the customer.
- Anchor to customercustomer•Customer
Update Input! required The customer object input.
Arguments