Skip to content
Advertisement

How to Make a ShopifyQL query?

Shopify recently announced ShopifyQL for easier accessing of analytics data. However, I’m unclear of how to actually make a ShopifyQL call. They do include an example.

{
  # "FROM sales SHOW total_sales BY month SINCE -1y UNTIL today" passes a ShopifyQL query to the GraphQL query.
  shopifyqlQuery(query: "FROM sales SHOW total_sales BY month SINCE -1y UNTIL today") {
    __typename
    ... on TableResponse {
      tableData {
        rowData
        columns {
          # Elements in the columns section describe which column properties you want to return.
          name
          dataType
          displayName
        }
      }
    }
    # parseErrors specifies that you want errors returned, if there were any, and which error properties you want to return.
    parseErrors {
      code
      message
      range {
        start {
          line
          character
        }
        end {
          line
          character
        }
      }
    }
  }
}

However, using the GraphiQL tool to run the query hits a number of errors:

{
  "errors": [
    {
      "message": "Field 'shopifyqlQuery' doesn't exist on type 'QueryRoot'",
      "locations": [
        {
          "line": 3,
          "column": 3
        }
      ],
      "path": [
        "query",
        "shopifyqlQuery"
      ],
      "extensions": {
        "code": "undefinedField",
        "typeName": "QueryRoot",
        "fieldName": "shopifyqlQuery"
      }
    }
  ]
}

I also tried making an authenticated call with the example query above using my app’s Node server, but ran into the same issues.

What am I missing here?

Advertisement

Answer

Looks like it only works with the unstable version currently:

https://”+shop_name+”.myshopify.com/admin/api/unstable/graphql.json

Got a successful response with this.

User contributions licensed under: CC BY-SA
3 People found this is helpful
Advertisement