User
Represents an error in the input of a mutation.
Anchor to FieldsFields
- 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
- •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
Permanently destroys a customer access token.
- Anchor to customerAccessTokencustomer•String!required
Access Token The access token used to identify the customer.
Arguments
- Anchor to deletedAccessTokendeleted•String
Access Token The destroyed access token.
- Anchor to deletedCustomerAccessTokenIddeleted•String
Customer Access Token Id ID of the destroyed customer access token.
- Anchor to userErrorsuser•[User
Errors 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
Creates a new address for a customer.
- Anchor to addressaddress•Mailing
Address Input!required The customer mailing address to create.
- Anchor to customerAccessTokencustomer•String!required
Access Token The access token used to identify the customer.
Arguments
- Anchor to customerAddresscustomer•Mailing
Address Address The new customer address 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
Permanently deletes the address of an existing customer.
- Anchor to customerAccessTokencustomer•String!required
Access Token The access token used to identify the customer.
- •ID!required
Specifies the address to delete.
Arguments
- Anchor to customerUserErrorscustomer•[Customer
User Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
- Anchor to deletedCustomerAddressIddeleted•String
Customer Address Id ID of the deleted customer address.
- Anchor to userErrorsuser•[User
Errors Error!]!non-nullDeprecated
Fields
- •mutation
Updates the address of an existing customer.
- Anchor to addressaddress•Mailing
Address Input!required The customer’s mailing address.
- Anchor to customerAccessTokencustomer•String!required
Access Token The access token used to identify the customer.
- •ID!required
Specifies the customer address to update.
Arguments
- Anchor to customerAddresscustomer•Mailing
Address Address The customer’s updated mailing address.
- 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 new customer.
- Anchor to inputinput•Customer
Create Input!required The fields used to create a new customer.
Arguments
- Anchor to customercustomer•Customer
The created customer 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
Updates the default address of an existing customer.
- Anchor to addressIdaddress•ID!required
Id ID of the address to set as the new default for the customer.
- 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 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
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
- 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 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