Cancel and close unpaid orders after two days, with Mechanic.

Mechanic is an automation development platform for Shopify. :)

Cancel and close unpaid orders after two days

by Isaac Bowen (team@usemechanic.com)

Clear the clutter in your orders list, automatically! On a scheduled basis or on-demand, this task scans for orders that are more than X days or hours old, and cancels and closes the order if its financial status is still marked "pending".

Runs when a user triggers the task. Configuration includes interval to wait before checking each order, interval is in hours, interval is in days, void payment when possible, cancel fulfillment and restock to default location, send cancellation email to customer, and tag to add to the order.

15-day free trial – unlimited tasks

Documentation

This task scans for orders that are more than X days or hours old that have a financial status of "pending", and ensures that they are all closed and cancelled. Orders that are already closed will be cancelled, and orders that are already cancelled will be closed. Optionally, choose to add a tag to such orders, and Mechanic will ensure that all qualifying orders receive your chosen tag.

If configured with an interval in hours, this task will run hourly. If configured with an interval in days, the task will run every night at midnight, in your store's local timezone. Run this task manually to perform the scan on demand.

Tip: To easily see which orders this task has cancelled, fill in the "Tag to add to the order" option.

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 a user triggers the task (mechanic/user/trigger)
Options
interval to wait before checking each order (number, required), interval is in hours (boolean), interval is in days (boolean), void payment when possible (boolean), cancel fulfillment and restock to default location (boolean), send cancellation email to customer (boolean), tag to add to the order
Script
{% assign orders = shop.orders.any.pending %}

{% if event.preview %}
  {% capture orders_json %}
    [
      {
        "id": 1234567890,
        "admin_graphql_api_id": "gid://shopify/Order/1234567890",
        "processed_at": "1990-01-01",
        "line_items": [
          {
            "id": 1234567890,
            "quantity": 5,
            "variant_inventory_management": "shopify"
          }
        ]
      }
    ]
  {% endcapture %}
  {% assign orders = orders_json | parse_json %}
{% else %}
  {% assign orders = shop.orders.any.pending %}
{% endif %}

{% if options.interval_to_wait_before_checking_each_order__number_required <= 0 %}
  {% error "Interval must be positive! :)" %}
{% elsif options.interval_is_in_hours__boolean == false and options.interval_is_in_days__boolean == false %}
  {% error "Choose either 'Interval is in hours' or 'Interval is in days'." %}
{% elsif options.interval_is_in_hours__boolean and options.interval_is_in_days__boolean %}
  {% error "Choose exactly one of 'Interval is in hours' or 'Interval is in days'. :)" %}
{% elsif options.interval_is_in_hours__boolean %}
  {% assign interval_unit = 60 | times: 60 %}
{% elsif optins.interval_is_in_days__boolean %}
  {% assign interval_unit = 60 | times: 60 | times: 24 %}
{% endif %}

{% assign interval_s = interval_unit | times: options.interval_to_wait_before_checking_each_order__number_required %}
{% assign maximum_date_s = "now" | date: "%s" | minus: interval_s %}

{% for order in orders %}
  {% assign processed_at_s = order.processed_at | default: order.created_at | date: "%s" | times: 1 %}

  {% if processed_at_s > maximum_date_s %}
    {% continue %}
  {% endif %}

  {% if order.cancelled_at == blank %}
    {% action "shopify" %}
      [
        "post",
        "/admin/orders/{{ order.id }}/cancel.json",
        {
          "refund": {
            "note": {{ task.name | json }},
            {% assign transaction = order.transactions.first %}
            {% if options.void_payment_when_possible__boolean and transaction != nil %}
              "transactions": [
                {
                  "parent_id": {{ transaction.id | json }},
                  "amount": "0.0",
                  "kind": "void",
                  "gateway": {{ transaction.gateway | json }}
                }
              ],
            {% endif %}
            "refund_line_items": [
              {% for line_item in order.line_items %}
                {
                  "line_item_id": {{ line_item.id | json }},

                  {% if options.cancel_fulfillment_and_restock_to_default_location__boolean and line_item.variant_inventory_management == "shopify" %}
                    "restock_type": "cancel",
                    "quantity": {{ line_item.quantity | json }},
                    "location_id": {{ shop.primary_location_id | json }}
                  {% else %}
                    "restock_type": "no_restock",
                    "quantity": 0
                  {% endif %}
                }
                {% unless forloop.last %}
                  ,
                {% endunless %}
              {% endfor %}
            ]
          },
          "email": {{ options.send_cancellation_email_to_customer__boolean | json }}
        }
      ]
    {% endaction %}
  {% endif %}

  {% assign do_tagging = false %}
  {% if options.tag_to_add_to_the_order != blank %}
    {% assign order_tags = order.tags | downcase | split: ", " %}
    {% assign order_tag_to_match = options.tag_to_add_to_the_order | downcase | strip %}
    {% unless order_tags contains order_tag_to_match %}
      {% assign do_tagging = true %}
    {% endunless %}
  {% endif %}

  {% if order.closed_at == blank or do_tagging %}
    {% action "shopify" %}
      mutation {
        {% if order.closed_at == blank %}
          orderClose(
            input: {
              id: {{ order.admin_graphql_api_id | json }}
            }
          ) {
            order {
              closed
              closedAt
            }
            userErrors {
              field
              message
            }
          }
        {% endif %}


        {% if do_tagging %}
          tagsAdd(
            id: {{ order.admin_graphql_api_id | json }}
            tags: {{ options.tag_to_add_to_the_order | json }}
          ) {
            userErrors {
              field
              message
            }
          }
        {% endif %}
      }
    {% endaction %}
  {% endif %}
{% endfor %}
Mechanic tasks are written in Liquid, which makes them easy to write and easy to modify. Learn more about our platform.