Auto-tag orders by app, with Mechanic.

Mechanic is a development platform for Shopify. :)

Auto-tag orders by app

by Isaac Bowen (team@usemechanic.com)

Some apps are responsible for placing orders. Use this task to tag orders, both incoming and historical, based on which app was responsible for placing them.

Runs when an order is created, when a user triggers the task, and when a bulk operation finishes. Configuration includes app titles and order tags and test mode.

15-day free trial – unlimited tasks

Documentation

This task scans your incoming orders, tagging them based on the Shopify app responsible for placing each one. Run this task manually to scan and tag your existing orders.

Configure this task with app titles on the left, and order tags to add on the right.

Use the "Test mode" option to see what the task intends to do, without actually having the task actually make any changes to your customers.

Developer details

Mechanic is designed to benefit everybody: merchants, customers, developers, agencies, Gurus, everybody.

That’s why we make it easy to configure automation without code, why we make it easy to tweak the underlying code once tasks are installed, and why we publish it all here for everyone to learn from.

Events
when an order is created (shopify/orders/create)
when a user triggers the task (mechanic/user/trigger)
when a bulk operation finishes (mechanic/shopify/bulk_operation)
Options
app titles and order tags (keyval, required), test mode (boolean)
Script
{% if event.topic == "shopify/orders/create" %}
  {% capture query %}
    query {
      order(id: {{ order.admin_graphql_api_id | json }}) {
        id
        name
        tags
        events(
          first: 1
          sortKey: CREATED_AT
          query: "verb:placed"
        ) {
          edges {
            node {
              id
              ... on BasicEvent {
                appTitle
              }
            }
          }
        }
      }
    }
  {% endcapture %}

  {% assign result = query | shopify %}

  {% if event.preview %}
    {% capture result_json %}
      {
        "data": {
          "order": {
            "id": "gid://shopify/Order/1234567890",
            "name": "#1234",
            "tags": [],
            "events": {
              "edges": [
                {
                  "node": {
                    "appTitle": {{ options.app_titles_and_order_tags__keyval_required.first.first | json }}
                  }
                }
              ]
            }
          }
        }
      }
    {% endcapture %}

    {% assign result = result_json | parse_json %}
  {% endif %}

  {% assign app_title = result.data.order.events.edges.first.node.appTitle %}
  {% assign tag_to_add = options.app_titles_and_order_tags__keyval_required[app_title] %}

  {% if app_title == blank %}
    {% log message: "This order was not created by an app. Skipping." %}
  {% elsif tag_to_add == blank %}
    {% log message: "No tag found for this app. Skipping.", app_title: app_title %}
  {% elsif result.data.order.tags contains tag_to_add %}
    {% log message: "The order already has the tag for this app. Skipping.", app_title: app_title, tag_to_add: tag_to_add %}
  {% elsif options.test_mode__boolean %}
    {% action "echo" order_id: result.data.order.id, order_name: result.data.order.name, order_app_title: app_title, order_tag_to_add: tag_to_add %}
  {% else %}
    {% action "shopify" %}
      mutation {
        tagsAdd(
          id: {{ result.data.order.id | json }}
          tags: {{ tag_to_add | json }}
        ) {
          userErrors {
            field
            message
          }
        }
      }
    {% endaction %}
  {% endif %}
{% elsif event.topic == "mechanic/user/trigger" %}
  {% capture bulk_operation_query %}
    query {
      orders {
        edges {
          node {
            __typename
            id
            name
            tags
            events(
              first: 1
              sortKey: CREATED_AT
              query: "verb:placed"
            ) {
              edges {
                node {
                  __typename
                  id
                  ... on BasicEvent {
                    appTitle
                  }
                }
              }
            }
          }
        }
      }
    }
  {% endcapture %}

  {% action "shopify" %}
    mutation {
      bulkOperationRunQuery(
        query: {{ bulk_operation_query | json }}
      ) {
        bulkOperation {
          id
          status
        }
        userErrors {
          field
          message
        }
      }
    }
  {% endaction %}
{% elsif event.topic == "mechanic/shopify/bulk_operation" %}
  {% if event.preview %}
    {% capture bulkOperation_json %}
      {
        "objects": [
          {
            "__typename": "Order",
            "name": "#1234",
            "tags": [],
            "id": "gid://shopify/Order/1234567890"
          },
          {
            "__typename": "BasicEvent",
            "id":" gid://shopify/BasicEvent/1234567890",
            "appTitle": {{ options.app_titles_and_order_tags__keyval_required.first.first | json }},
            "__parentId": "gid://shopify/Order/1234567890"
          }
        ]
      }
    {% endcapture %}

    {% assign bulkOperation = bulkOperation_json | parse_json %}
  {% endif %}

  {% assign orders = bulkOperation.objects | where: "__typename", "Order" %}
  {% assign events = bulkOperation.objects | where: "__typename", "BasicEvent" %}
  {% assign app_title_counts = hash %}

  {% for event in events %}
    {% assign app_title = event.appTitle %}

    {% if app_title == blank %}
      {% assign app_title = "(not placed via app)" %}
    {% endif %}

    {% assign app_title_counts[app_title] = app_title_counts[app_title] | plus: 1 %}
  {% endfor %}

  {% log app_title_counts: app_title_counts %}

  {% if options.test_mode__boolean %}
    {% assign summaries = array %}
  {% endif %}
          
  {% for order in orders %}
    {% assign order_app_title = nil %}
    {% assign order_tag_to_add = nil %}

    {% assign order_event = events | where: "__parentId", order.id | first %}
    {% assign order_app_title = order_event.appTitle %}

    {% if order_app_title != blank %}
      {% unless order.tags contains options.app_titles_and_order_tags__keyval_required[order_app_title] %}
        {% assign order_tag_to_add = options.app_titles_and_order_tags__keyval_required[order_app_title] %}
      {% endunless %}
    {% endif %}

    {% if order_app_title != blank %}
      {% if options.test_mode__boolean %}
        {% assign summary = hash %}
        {% assign summary["order_id"] = order.id %}
        {% assign summary["order_name"] = order.name %}
        {% assign summary["order_tags"] = order.tags %}
        {% assign summary["order_app_title"] = order_app_title %}
        {% assign summary["order_tag_to_add"] = order_tag_to_add %}
        {% assign summaries[summaries.size] = summary %}
      {% elsif order_tag_to_add != blank %}
        {% action "shopify" %}
          mutation {
            tagsAdd(
              id: {{ order.id | json }}
              tags: {{ order_tag_to_add | uniq | json }}
            ) {
              userErrors {
                field
                message
              }
            }
          }
        {% endaction %}
      {% endif %}
    {% endif %}
  {% endfor %}

  {% if options.test_mode__boolean %}
    {% action "echo" summaries %}
  {% endif %}
{% endif %}
Mechanic tasks are written in Liquid, which makes them easy to write and easy to modify. Learn more about our platform.