ShopifyQL overview
You can use the GraphQL Admin API to query data from a Plus merchant store using ShopifyQL. The ShopifyQL API enables you to write analytical queries to find insights in merchants' store data.
You can use the ShopifyQL API to create reporting apps that provide business insights for Plus merchants. The ShopifyQL API also enables you to export data from a Plus merchant store, so you can import the data into data warehouses.
For a complete reference of the ShopifyQL language, refer to the ShopifyQL reference.
Access scopes
Anchor link to section titled "Access scopes"To use ShopifyQL, you need to request access to protect customer data in the Partner Dashboard. Your app also needs to meet certain requirements to ensure customer privacy and security. You will need to request access for protected customer data including name, email, address, and phone fields.
You also need to request access to authenticated access scopes for the following access scopes read_reports, read_customers, read_fulfillments, read_inventory, read_orders, read_products, and read_all_orders.
How it works
Anchor link to section titled "How it works"Plus Merchant stores contain data in a format that can be read by ShopifyQL. The store data is organized as a table, which has columns that contain details about the data. The following store data is available, grouped into datasets:
- orders dataset - Available for Plus Merchants
- products dataset - Available for Plus Merchants
You can use the specific details to sort or filter store data.
The GraphQL Admin API enables you to interact with store data using ShopifyQL. You can compose queries that sort and filter store data, so you can create interfaces or visuals that merchants can use to find patterns in their stores.
Segment query language
Anchor link to section titled "Segment query language"The segment query language is a different implementation of ShopifyQL that uses a subset of ShopifyQL. The segment query language only uses the WHERE clause from ShopifyQL to filter customers by their attributes.
You can use the segment query language to create a collection of customers that are filtered out by specific criteria. Filtered customers in a collection are called “segment members”, and the collections of filtered customers are called “segments”. Merchants can create segments in the Shopify admin.
For a complete reference of the segment query language, refer to the segment query language reference.
The following example shows how to use shopifyqlQuery in the GraphQL Admin API to retrieve the total sales for each month from the start of the year until today.
- Access the language reference for ShopifyQL.
- Access the language reference for Shopify's segment query language.