Customer
The Customer menu is the customer's account area — registering and signing in, managing the profile and address book, viewing past orders, invoices, shipments, and downloadable products, and managing their own reviews. It backs every "My Account" screen on the storefront.
Authentication & session
A customer registers, then logs in to receive a Bearer token. That token is sent on every account operation (and is the same token used by Cart, Checkout, Wishlist, and Compare). The token can be verified, and logging out invalidates it. Forgot Password starts the password-reset flow by email.
What you can do
- Profile — read, update, or delete the signed-in customer's account.
- Orders — list the customer's orders, view one order in detail, view its shipments, and cancel or reorder an order.
- Invoices — list invoices and view one. The PDF itself is fetched over REST from the invoice's
downloadUrl. - Downloadable products — list the customer's purchased downloads and read how many uses remain. The file itself is fetched over REST.
- Addresses — list, create, update, and delete saved addresses (the address book).
- Reviews — read the reviews the customer has written. Submitting one is on Create Product Review.
Operations
Profile and session
| Operation | GraphQL field | Description |
|---|---|---|
| Register | createCustomer | Create a customer account. |
| Log in | createCustomerLogin | Exchange credentials for a Bearer token. |
| Verify a token | createVerifyToken | Check whether a stored token is still valid. |
| Log out | createLogout | Invalidate the current token. |
| Start a password reset | createForgotPassword | Email the customer a reset link. |
| Read the profile | readCustomerProfile | The signed-in customer's account details. |
| Update the profile | createCustomerProfileUpdate | Change name, email, phone, or password. |
| Delete the account | createCustomerProfileDelete | Close the customer's own account. |
Orders
| Operation | GraphQL field | Description |
|---|---|---|
| List orders | customerOrders | The customer's own orders, paginated. |
| View one order | customerOrder | Full order detail with items, addresses, and payment. |
| List shipments | customerOrderShipments | Shipments across the customer's orders. |
| View one shipment | customerOrderShipment | A single shipment with its items. |
| Cancel an order | createCancelOrder | Cancel an order that is still cancellable. |
| Reorder | createReorderOrder | Rebuild a cart from a past order. |
Invoices
| Operation | GraphQL field | Description |
|---|---|---|
| List invoices | customerInvoices | Invoices raised against the customer's orders. |
| View one invoice | customerInvoice | A single invoice with its totals and items. |
| Download the PDF | customerInvoice | Read downloadUrl from the invoice, then fetch the PDF over REST — GraphQL cannot return a binary. |
Downloadable products
| Operation | GraphQL field | Description |
|---|---|---|
| List purchases | customerDownloadableProducts | Downloadable products the customer has bought, with remaining downloads. |
| View one purchase | customerDownloadableProduct | A single purchased download. |
| Download the file | REST only | The file is served over REST; use the downloadUrl from the queries above. |
Addresses
| Operation | GraphQL field | Description |
|---|---|---|
| List addresses | getCustomerAddresses | The customer's saved address book. |
| Create an address | createAddUpdateCustomerAddress | Add a new address. |
| Update an address | createAddUpdateCustomerAddress | The same mutation — supplying an existing address ID updates it instead of adding one. |
| Delete an address | createDeleteCustomerAddress | Remove an address from the book. |
Reviews
| Operation | GraphQL field | Description |
|---|---|---|
| List own reviews | customerReviews | Reviews the customer has written. |
| View one review | customerReview | A single review the customer owns. |
Registration, Login, and Forgot Password are public (storefront key only); every other operation requires a customer Bearer token — see Authentication.

