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 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 ​

OperationGraphQL fieldDescription
RegistercreateCustomerCreate a customer account.
Log increateCustomerLoginExchange credentials for a Bearer token.
Verify a tokencreateVerifyTokenCheck whether a stored token is still valid.
Log outcreateLogoutInvalidate the current token.
Start a password resetcreateForgotPasswordEmail the customer a reset link.
Read the profilereadCustomerProfileThe signed-in customer's account details.
Update the profilecreateCustomerProfileUpdateChange name, email, phone, or password.
Delete the accountcreateCustomerProfileDeleteClose the customer's own account.

Orders ​

OperationGraphQL fieldDescription
List orderscustomerOrdersThe customer's own orders, paginated.
View one ordercustomerOrderFull order detail with items, addresses, and payment.
List shipmentscustomerOrderShipmentsShipments across the customer's orders.
View one shipmentcustomerOrderShipmentA single shipment with its items.
Cancel an ordercreateCancelOrderCancel an order that is still cancellable.
ReordercreateReorderOrderRebuild a cart from a past order.

Invoices ​

OperationGraphQL fieldDescription
List invoicescustomerInvoicesInvoices raised against the customer's orders.
View one invoicecustomerInvoiceA single invoice with its totals and items.
Download the PDFcustomerInvoiceRead downloadUrl from the invoice, then fetch the PDF over REST — GraphQL cannot return a binary.

Downloadable products ​

OperationGraphQL fieldDescription
List purchasescustomerDownloadableProductsDownloadable products the customer has bought, with remaining downloads.
View one purchasecustomerDownloadableProductA single purchased download.
Download the fileREST onlyThe file is served over REST; use the downloadUrl from the queries above.

Addresses ​

OperationGraphQL fieldDescription
List addressesgetCustomerAddressesThe customer's saved address book.
Create an addresscreateAddUpdateCustomerAddressAdd a new address.
Update an addresscreateAddUpdateCustomerAddressThe same mutation — supplying an existing address ID updates it instead of adding one.
Delete an addresscreateDeleteCustomerAddressRemove an address from the book.

Reviews ​

OperationGraphQL fieldDescription
List own reviewscustomerReviewsReviews the customer has written.
View one reviewcustomerReviewA 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.

Released under the MIT License.