CustomerGraphQl
vendor/magento/module-customer-graph-ql/etc/schema.graphqls
Queries
customer
Return detailed information about a customer account.
Customer · returns Customer
customerGroup
Provides Customer Group assigned to the Customer or Guest.
Customer · returns CustomerGroupStorefront!
isEmailAvailable
Check whether the specified email has already been used to create a customer account.
Customer · returns IsEmailAvailableOutput
Mutations
changeCustomerPassword
Change the password for the logged-in customer.
Customer · returns Customer
confirmEmail
Confirms the email address for a customer.
Customer · returns CustomerOutput
createCustomer
DeprecatedCustomer · returns CustomerOutput
createCustomerAddress
Create a billing or shipping address for a customer or guest.
Customer · returns CustomerAddress
createCustomerV2
Create a customer account.
Customer · returns CustomerOutput
deleteCustomer
Delete customer account
Customer · returns Boolean
deleteCustomerAddress
DeprecatedDelete the billing or shipping address of a customer.
Customer · returns Boolean
deleteCustomerAddressV2
Delete the billing or shipping address of a customer.
Customer · returns Boolean
generateCustomerToken
Generate a token for specified customer.
Customer · returns CustomerToken
requestPasswordResetEmail
Request an email with a reset password token for the registered customer identified by the specified email.
Customer · returns Boolean
resendConfirmationEmail
Resends the confirmation email to a customer.
Customer · returns Boolean
resetPassword
Reset a customer's password using the reset password token that the customer received in an email after requesting it using `requestPasswordResetEmail`.
Customer · returns Boolean
revokeCustomerToken
Revoke the customer token.
Customer · returns RevokeCustomerTokenOutput
updateCustomer
DeprecatedCustomer · returns CustomerOutput
updateCustomerAddress
DeprecatedUpdate the billing or shipping address of a customer or guest.
Customer · returns CustomerAddress
updateCustomerAddressV2
Update the billing or shipping address of a customer or guest.
Customer · returns CustomerAddress
updateCustomerEmail
Change the email address for the logged-in customer.
Customer · returns CustomerOutput
updateCustomerV2
Update the customer's personal information.
Customer · returns CustomerOutput
Types
Object types, input types, enums, interfaces, and unions declared (or extended) in this module.
AttributeEntityTypeEnum
List of all entity types. Populated by the modules introducing EAV entities.
ConfirmEmailInput
Contains details about a customer email address to confirm.
ConfirmationStatusEnum
List of account confirmation statuses.
CountryCodeEnum
The list of country codes.
Customer
Defines the customer name, addresses, and other details.
CustomerAddress
Contains detailed information about a customer's billing or shipping address.
CustomerAddressAttribute
Specifies the attribute code and value of a customer address attribute.
CustomerAddressAttributeInput
Specifies the attribute code and value of a customer attribute.
CustomerAddressInput
Contains details about a billing or shipping address.
CustomerAddressRegion
Defines the customer's state or province.
CustomerAddressRegionInput
Defines the customer's state or province.
CustomerAddresses
CustomerAttributeMetadata
Customer attribute metadata.
CustomerCreateInput
An input object for creating a customer.
CustomerGroupStorefront
Data of customer group.
CustomerInput
An input object that assigns or updates customer attributes.
CustomerOutput
Contains details about a newly-created or updated customer.
CustomerToken
Contains a customer authorization token.
CustomerUpdateInput
An input object for updating a customer.
InputFilterEnum
List of templates/filters applied to customer attribute input.
IsEmailAvailableOutput
Contains the result of the `isEmailAvailable` query.
RevokeCustomerTokenOutput
Contains the result of a request to revoke a customer token.
StoreConfig
Contains information about a store's configuration.
ValidationRule
Defines a customer attribute validation rule.
ValidationRuleEnum
List of validation rule names applied to a customer attribute.
Every Magento dev tool, in one hosted workspace.
Free to sign up. Nothing to install. Drafts, audits, and projects saved across every tool.