Shopify

Run Shopify GraphQL mutations from Mechanic tasks — create orders, update products, manage customers, and more via the Shopify action.

The Shopify action sends requests to the Shopify Admin API. Use the shopify Liquid filter to read data; use this action to write or update data. Use GraphQL for new Shopify automation work.

In Mechanic, writing data to Shopify must happen using an action. While the Shopify action is usually the right choice, the HTTP action can also be used for this purpose, by manually configuring authentication headers. Reading data should use the shopify Liquid filter unless you're running a bulk read that has to happen after the run.

To learn more, see Interacting with Shopify.

Options

This action has several usage styles, each with a different set of constraints on action options.

GraphQL

This usage style invokes the Shopify GraphQL Admin API. In this style, a single GraphQL query string is supplied as the action options. The action tag has specific support for this action type, allowing this string to be provided as the contents of an action block.

To prepare complex query inputs, use the graphql_arguments Liquid filter.

Liquid

{% action "shopify" %}
  mutation {
    customerCreate(
      input: {
        email: "[e-mail]"
      }
    ) {
      customer {
        id
      }
      userErrors {
        field
        message
      }
    }
  }
{% endaction %}

GraphQL with variables

This usage style invokes the Shopify GraphQL Admin API, and supports combining GraphQL queries with GraphQL variables. This can be useful for re-using queries with multiple inputs, and is critical when dealing with very large pieces of input. Because GraphQL queries (excluding whitespace) are limited in length to 50k characters, GraphQL variables can be used in cases when large inputs (like Base64-encoded images) need to be submitted.

Option	Description
query	Required; a string containing a GraphQL query
variables	Required; a JSON object mapping variable names to values

Basic example

Liquid

{% capture query %}
  mutation DeleteProduct($productId: ID!) {
    productDelete(
      input: {
        id: $productId
      }
    ) {
      userErrors {
        field
        message
      }
    }
  }
{% endcapture %}

{% action "shopify" %}
  {
    "query": {{ query | json }},
    "variables": {
      "productId": "gid://shopify/Product/1234567890"
    }
  }
{% endaction %}

Complex example

This example shows how the query and variables may be built up separately, and provided to the action using concise tag syntax.

Liquid

{% assign metafield_owner_id = "gid://shopify/Customer/507332001849" %}
{% assign metafield_value = hash %}
{% assign metafield_value["foo"] = "bar" %}

{% capture query %}
  mutation MetafieldsSet($metafields: [MetafieldsSetInput!]!) {
    metafieldsSet(metafields: $metafields) {
      metafields {
        key
        namespace
        value
        createdAt
        updatedAt
      }
      userErrors {
        field
        message
        code
      }
    }
  }
{% endcapture %}

{% assign metafield = hash %}
{% assign metafield["ownerId"] = metafield_owner_id %}
{% assign metafield["namespace"] = "demo" %}
{% assign metafield["key"] = "demo" %}
{% assign metafield["type"] = "json" %}
{% assign metafield["value"] = metafield_value | json %}
{% assign metafields = array %}
{% assign metafields = metafields | push: metafield %}

{% assign variables = hash %}
{% assign variables["metafields"] = metafields %}

{% action "shopify" query: query, variables: variables %}

Bulk operations

The Shopify action can start Shopify bulk operations using bulkOperationRunQuery or bulkOperationRunMutation. Mechanic detects the returned bulk operation, monitors it, and re-invokes the same task with mechanic/shopify/bulk_operation when Shopify finishes.

Bulk operation mutations require a staged JSONL variables upload before calling bulkOperationRunMutation. Use the HTTP action for the multipart upload step, and use mechanic/actions/perform to move between the staged upload, file upload, and mutation-start steps.

• Bulk operations

• Running bulk operation mutations

Related

• Reading Shopify data — query products, orders, customers, and more using GraphQL in Liquid

• Writing Shopify data — overview of writing data to Shopify

• Responding to action results — inspect Shopify mutation results in a follow-up task run

• Preventing action loops — guard against re-triggers when modifying resources you subscribe to