Skip to content

Add support for multiple gateways to tagging task #530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tekhaus merged 1 commit into from
Feb 4, 2026
Merged

Add support for multiple gateways to tagging task #530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions docs/auto-tag-new-orders-based-on-payment-method/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Tags: Auto-Tag, Orders, Payment

This task checks the payment method for new orders immediately upon order creation, and tags the order accordingly.
This task checks the payment gateways for new orders immediately upon order creation, and tags the order accordingly.

* View in the task library: [tasks.mechanic.dev/auto-tag-new-orders-based-on-payment-method](https://tasks.mechanic.dev/auto-tag-new-orders-based-on-payment-method)
* Task JSON, for direct import: [task.json](../../tasks/auto-tag-new-orders-based-on-payment-method.json)
Expand All @@ -12,8 +12,8 @@ This task checks the payment method for new orders immediately upon order creati

```json
{
"payment_gateway_name__required": null,
"order_tag_to_add__required": null
"payment_gateway_names_and_tags__keyval_required": null,
"run_when_orders_are_paid_instead_of_created__boolean": null
}
```

Expand All @@ -22,15 +22,21 @@ This task checks the payment method for new orders immediately upon order creati
## Subscriptions

```liquid
shopify/orders/create
{% if options.run_when_orders_are_paid_instead_of_created__boolean %}
shopify/orders/paid
{% else %}
shopify/orders/create
{% endif %}
```

[Learn about event subscriptions in Mechanic](https://learn.mechanic.dev/core/tasks/subscriptions)

## Documentation

This task checks the payment method for new orders immediately upon order creation, and tags the order accordingly.

This task checks the payment gateways for new orders immediately upon order creation, and tags the order accordingly.

Configure the "Payment gateway names and tags" fields with the payment gateway name on the left, and the associated tag on the right.

Tip: to tag orders paid with a gift card, fill in "Payment gateway name" with "gift_card".

## Installing this task
Expand Down
21 changes: 16 additions & 5 deletions docs/auto-tag-new-orders-based-on-payment-method/script.liquid
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,33 @@
{% assign payment_gateway_names_and_tags = options.payment_gateway_names_and_tags__keyval_required %}

{% if event.preview %}
{% capture order_json %}
{
"admin_graphql_api_id": "gid://shopify/Order/12345",
"payment_gateway_names": {{ options.payment_gateway_name__required | json }}
"payment_gateway_names": {{ payment_gateway_names_and_tags.first.first | json }}
}
{% endcapture %}

{% assign order = order_json | parse_json %}
{% endif %}

{% if order.payment_gateway_names contains options.payment_gateway_name__required %}
{% assign tags_to_add = array %}

{% for keyval in payment_gateway_names_and_tags %}
{% assign payment_gateway_name = keyval[0] %}
{% assign tag = keyval[1] %}

{% if order.payment_gateway_names contains payment_gateway_name %}
{% assign tags_to_add = tags_to_add | push: tag %}
{% endif %}
{% endfor %}

{% if tags_to_add != blank %}
{% action "shopify" %}
mutation {
tagsAdd(
id: {{ order.admin_graphql_api_id | json }}
tags: {{ options.order_tag_to_add__required | json }}
tags: {{ tags_to_add | json }}
) {
userErrors {
field
Expand All @@ -23,6 +36,4 @@
}
}
{% endaction %}
{% else %}
{% log order_payment_gateway_names: order.payment_gateway_names %}
{% endif %}
10 changes: 5 additions & 5 deletions tasks/auto-tag-new-orders-based-on-payment-method.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
{
"docs": "This task checks the payment method for new orders immediately upon order creation, and tags the order accordingly.\r\n\r\nTip: to tag orders paid with a gift card, fill in \"Payment gateway name\" with \"gift_card\".",
"docs": "This task checks the payment gateways for new orders immediately upon order creation, and tags the order accordingly.\n\nConfigure the \"Payment gateway names and tags\" fields with the payment gateway name on the left, and the associated tag on the right.\n\nTip: to tag orders paid with a gift card, fill in \"Payment gateway name\" with \"gift_card\".",
"halt_action_run_sequence_on_error": false,
"name": "Auto-tag new orders based on payment method",
"online_store_javascript": null,
"options": {
"payment_gateway_name__required": null,
"order_tag_to_add__required": null
"payment_gateway_names_and_tags__keyval_required": null,
"run_when_orders_are_paid_instead_of_created__boolean": null
},
"order_status_javascript": null,
"perform_action_runs_in_sequence": false,
"script": "{% if event.preview %}\n {% capture order_json %}\n {\n \"admin_graphql_api_id\": \"gid://shopify/Order/12345\",\n \"payment_gateway_names\": {{ options.payment_gateway_name__required | json }}\n }\n {% endcapture %}\n\n {% assign order = order_json | parse_json %}\n{% endif %}\n\n{% if order.payment_gateway_names contains options.payment_gateway_name__required %}\n {% action \"shopify\" %}\n mutation {\n tagsAdd(\n id: {{ order.admin_graphql_api_id | json }}\n tags: {{ options.order_tag_to_add__required | json }}\n ) {\n userErrors {\n field\n message\n }\n }\n }\n {% endaction %}\n{% else %}\n {% log order_payment_gateway_names: order.payment_gateway_names %}\n{% endif %}",
"script": "{% assign payment_gateway_names_and_tags = options.payment_gateway_names_and_tags__keyval_required %}\n\n{% if event.preview %}\n {% capture order_json %}\n {\n \"admin_graphql_api_id\": \"gid://shopify/Order/12345\",\n \"payment_gateway_names\": {{ payment_gateway_names_and_tags.first.first | json }}\n }\n {% endcapture %}\n\n {% assign order = order_json | parse_json %}\n{% endif %}\n\n{% assign tags_to_add = array %}\n\n{% for keyval in payment_gateway_names_and_tags %}\n {% assign payment_gateway_name = keyval[0] %}\n {% assign tag = keyval[1] %}\n\n {% if order.payment_gateway_names contains payment_gateway_name %}\n {% assign tags_to_add = tags_to_add | push: tag %}\n {% endif %}\n{% endfor %}\n\n{% if tags_to_add != blank %}\n {% action \"shopify\" %}\n mutation {\n tagsAdd(\n id: {{ order.admin_graphql_api_id | json }}\n tags: {{ tags_to_add | json }}\n ) {\n userErrors {\n field\n message\n }\n }\n }\n {% endaction %}\n{% endif %}\n",
"subscriptions": [
"shopify/orders/create"
],
"subscriptions_template": "shopify/orders/create",
"subscriptions_template": "{% if options.run_when_orders_are_paid_instead_of_created__boolean %}\n shopify/orders/paid\n{% else %}\n shopify/orders/create\n{% endif %}",
"tags": [
"Auto-Tag",
"Orders",
Expand Down