Skip to main content
Version: 1.0.0

Customer Queries

This section documents the GraphQL queries available for retrieving information about customers in the YSCP platform. Customer queries allow you to fetch details about customer profiles, addresses, and preferences.

Available Queries​

The following customer queries are available:

  • CustomerGroupsQuery - Retrieves a list of customer groups available in the system, including group IDs, names, and descriptions.
  • IsEmailAvailableQuery - Checks if an email address is available for registration, returning a boolean indicating whether the email is already in use.

Authentication​

Customer queries require authentication. The user must be logged in to access customer information. Attempting to access customer information without authentication will result in an error.

Customer Structure​

The customer structure returned by customer queries typically includes:

  • Profile Information: Name, email, and other personal details
  • Addresses: Saved shipping and billing addresses
  • Preferences: Customer preferences and settings
  • Account Information: Account creation date, status, and other account-related details

Data Privacy​

Customer queries are designed with data privacy in mind. Only the authenticated user can access their own customer information. Administrators with appropriate permissions can access customer information for administrative purposes.

Examples​

Each query documentation includes examples showing how to use the query and what response to expect.