E-Commerce GraphQL API
v2.0.0
A comprehensive GraphQL API for e-commerce operations including products, orders, customers, and real-time inventory updates. This API follows the Relay specification for pagination and implements standard GraphQL best practices.
Servers
| URL |
WebSocket URL |
Description |
https://api.example.com/graphql |
wss://api.example.com/graphql |
Production GraphQL endpoint with introspection disabled for security |
https://staging-api.example.com/graphql |
wss://staging-api.example.com/graphql |
Staging environment for integration testing with introspection enabled |
Authentication
| ID |
Type |
Description |
bearerAuth |
bearer |
JWT Bearer token authentication. Tokens are issued by the /auth/token endpoint and expire after 1 hour. |
apiKey |
apiKey |
API key for service-to-service communication. Keys are provisioned through the developer portal. |
Custom Scalars
-
DateTime
- ISO 8601 formatted date-time string with timezone information
-
Money
- Monetary value represented as a decimal string to avoid floating-point precision issues
-
EmailAddress
- RFC 5322 compliant email address
Directives
-
@deprecated
(FIELD_DEFINITION, ENUM_VALUE, ARGUMENT_DEFINITION)
- Marks a field, argument, or enum value as deprecated with an optional reason
-
@auth
(FIELD_DEFINITION, OBJECT)
- Specifies authentication and authorisation requirements for a field or type
-
@cacheControl
(FIELD_DEFINITION, OBJECT)
- Configures caching behaviour for a field or type. Used by Apollo Server and similar implementations.
