Skip to content

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, view one, and download an invoice PDF.
  • Downloadable products — list the customer's purchased downloadable products and download a file.
  • Addresses — list, create, update, and delete saved addresses (the address book).
  • Reviews — read the reviews the customer has written.

Operations in this menu

Profile & session

OperationGraphQL field
Customer RegistrationcreateCustomer mutation
Customer LogintokenCreate mutation
Customer Verify TokenverifyToken mutation
Customer Logoutlogout mutation
Forgot PasswordforgotPassword mutation
Get Customer Profilecustomer query
Update Customer ProfileupdateCustomerProfile mutation
Delete Customer ProfiledeleteCustomerProfile mutation

Orders

OperationGraphQL field
Get Customer OrderscustomerOrders query
Get Customer OrdercustomerOrder(id:) query
Get Customer Order ShipmentscustomerOrderShipments query
Get Customer Order ShipmentcustomerOrderShipment(id:) query
Cancel Customer OrdercancelOrder mutation
Reorder Customer Orderreorder mutation

Invoices

OperationGraphQL field
Get Customer InvoicescustomerInvoices query
Get Customer InvoicecustomerInvoice(id:) query
Download InvoicedownloadInvoice query

Downloadable products

OperationGraphQL field
Get Downloadable ProductsdownloadableProducts query
Get Downloadable ProductdownloadableProduct(id:) query
Download Downloadable ProductdownloadDownloadableProduct query

Addresses

OperationGraphQL field
Get Customer Addressesaddresses query
Create Customer AddresscreateAddress mutation
Update Customer AddressupdateAddress mutation
Delete Customer AddressdeleteAddress mutation

Reviews

OperationGraphQL field
Get Customer ReviewscustomerReviews query
Get Customer ReviewcustomerReview(id:) query

Registration, Login, and Forgot Password are public (storefront key only); every other operation requires a customer Bearer token — see Authentication.

Released under the MIT License.