Introduction to ShopifyQL in GraphQL Admin API
ShopifyQL is now available as shopifyqlQuery within the GraphQL Admin API, enabling developers to harness powerful merchant analytics. This advancement allows for sophisticated data extraction and detailed reporting across sales, customers, and product data.
What is ShopifyQL?
ShopifyQL is a query language specifically designed for Shopify's data ecosystem. It simplifies the process of extracting actionable insights, making complex querying easier for developers.
Key Features of ShopifyQL Integration
- Access merchant analytics data, including sales, customer, and product information.
- Perform advanced data analysis and reporting using concise queries.
- Retrieve data in table format, complete with columns and rows for easy parsing and visualization.
Practical Example: Retrieve Total Sales by Month
Using ShopifyQL, you can effortlessly query total sales data grouped by month starting from the beginning of the current year:
{ shopifyqlQuery(query: "FROM sales SHOW total_sales GROUP BY month SINCE startOfYear(0y) ORDER BY month") { tableData { columns { name dataType displayName } rows } parseErrors } }The response contains column and row data detailing the total sales per month:
{ "data": { "shopifyqlQuery": { "tableData": { "columns": [ { "name": "month", "dataType": "MONTH_TIMESTAMP", "displayName": "Month" }, { "name": "total_sales", "dataType": "MONEY", "displayName": "Total sales" } ], "rows": [ { "month": "2025-01-01", "total_sales": "5542.954" }, { "month": "2025-02-01", "total_sales": "1610.094" } ] }, "parseErrors": [] } } }Error Handling
Any parsing errors encountered during execution are listed under parseErrors, making debugging straightforward for developers.
Getting Started
- Learn more about ShopifyQL by visiting the ShopifyQL syntax documentation.
- Explore the
shopifyqlQueryfield in our GraphQL Admin API documentation. - Experiment with real-world queries to unlock valuable insights for Shopify merchants.