GraphQL

Use Shopify's GraphQL Admin API in Mechanic Shopify automation tasks to read and write store data — orders, products, customers, metafields, and more.

Mechanic tasks have direct inline access to Shopify's GraphQL Admin API. Run queries during task execution to read data, and use GraphQL mutations via the Shopify action to write data — giving you the same level of API access you'd have in a custom app, without the infrastructure.

Shopify REST is deprecated in Mechanic. All new tasks should use the GraphQL Admin API. See Converting tasks from Shopify REST to GraphQL for migration guidance.

Reading data with GraphQL

Use the shopify Liquid filter to run a GraphQL query inline during a task run. The result is available immediately.

{% capture query %}
  query {
    orders(first: 5, query: "financial_status:paid") {
      nodes {
        id
        name
        totalPriceSet {
          shopMoney {
            amount
          }
        }
      }
    }
  }
{% endcapture %}

{% assign result = query | shopify %}

{% for order in result.data.orders.nodes %}
  {{ order.name }}: {{ order.totalPriceSet.shopMoney.amount }}
{% endfor %}

Learn more: Queries

Writing data with GraphQL

Use the Shopify action to run GraphQL mutations. Mutations are queued during the task run and performed after the task code finishes.

{% action "shopify" %}
  mutation {
    tagsAdd(id: "gid://shopify/Order/1234567890", tags: ["reviewed"]) {
      node {
        id
      }
      userErrors {
        field
        message
      }
    }
  }
{% endaction %}

Learn more: Mutations

Learn more

• GraphQL in Liquid — the complete guide to using GraphQL queries in task code

• Shopify Admin API GraphiQL explorer — test queries interactively

• Queries — reading data with GraphQL

• Mutations — writing data with GraphQL

• Pagination — handling paginated results

• Bulk operations — processing large datasets

• Converting tasks from Shopify REST to GraphQL — migration guide for existing tasks