GraphQL Queries
Queries in GraphQL are operations that allow you to retrieve data from the server. Unlike REST APIs, GraphQL queries give you the flexibility to request exactly the data you need in a single request.
Structure of Queries
All queries in our GraphQL API follow a consistent structure:
- Query Name: The name of the operation you want to perform
- Arguments: Optional parameters to filter or customize the data
- Selection Set: The specific fields you want to retrieve
Available Query Categories
Our GraphQL API provides queries for various e-commerce data:
Cart Queries
Queries for retrieving information about shopping carts, including items, totals, and applied coupons.
Checkout Queries
Queries related to the checkout process, including available shipping methods, payment methods, and checkout status.
Customer Queries
Queries for retrieving customer information, including profile details, addresses, and preferences.
Product Queries
Queries for retrieving product information, including details, pricing, availability, and related products.
Purchase Queries
Queries related to orders and purchases, including order history, order details, and order status.
Authentication
Some queries require authentication, while others can be performed anonymously. The documentation for each query specifies whether authentication is required.
Pagination
For queries that return collections of items, pagination is supported through cursor-based pagination arguments.
Examples
Each query documentation includes examples showing how to use the query and what response to expect.