Customer
Represents an error that happens during execution of a customer mutation.
Anchor to FieldsFields
- code (CustomerErrorCode)
- field ([String!])
- message (String!)
- Anchor to codecode•Customer
Error Code The error code.
- Anchor to fieldfield•[String!]
The path to the input field that caused the error.
- Anchor to messagemessage•String!non-null
The error message.
Anchor to MutationsMutations
- customerAccessTokenCreate (CustomerAccessTokenCreatePayload)
- customerAccessTokenCreateWithMultipass (CustomerAccessTokenCreateWithMultipassPayload)
- customerActivate (CustomerActivatePayload)
- customerActivateByUrl (CustomerActivateByUrlPayload)
- customerAddressCreate (CustomerAddressCreatePayload)
- customerAddressDelete (CustomerAddressDeletePayload)
- customerAddressUpdate (CustomerAddressUpdatePayload)
- customerCreate (CustomerCreatePayload)
- customerDefaultAddressUpdate (CustomerDefaultAddressUpdatePayload)
- customerRecover (CustomerRecoverPayload)
- 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
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
Creates a new address for a customer.
- Anchor to customerAccessTokencustomer•String!
Access Token required The access token used to identify the customer.
- Anchor to addressaddress•Mailing
Address Input! required The customer mailing address to create.
Arguments
- •mutation
Permanently deletes the address of an existing customer.
- •ID!required
Specifies the address to delete.
- Anchor to customerAccessTokencustomer•String!
Access Token required The access token used to identify the customer.
Arguments
- •ID!
- •mutation
Updates the address of an existing customer.
- Anchor to customerAccessTokencustomer•String!
Access Token required The access token used to identify the customer.
- •ID!required
Specifies the customer address to update.
- Anchor to addressaddress•Mailing
Address Input! required The customer’s mailing address.
Arguments
- •mutation
Creates a new customer.
- Anchor to inputinput•Customer
Create Input! required The fields used to create a new customer.
Arguments
- •mutation
Updates the default address of an existing customer.
- Anchor to customerAccessTokencustomer•String!
Access Token required The access token used to identify the customer.
- Anchor to addressIdaddress•ID!
Id required ID of the address to set as the new default for the customer.
Arguments
- •mutation
Sends a reset password email to the customer. The reset password email contains a reset password URL and token that you can pass to the
ormutation to reset the customer password.This mutation is throttled by IP. With private access, you can provide a
instead of the request IP. The header is case-sensitive and must be sent as.Make sure that the value provided to
is trusted. Unthrottled access to this mutation presents a security risk.- Anchor to emailemail•String!required
The email address of the customer to recover.
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