shopify: appmixer.shopify.returns.ReturnTracking

Basic Information

Name

appmixer.shopify.returns.ReturnTracking

Version

1.0.0

Visibility

Public

Description

Triggers on the selected return events: a return is requested, approved, declined, cancelled, closed, reopened or updated.

Properties

Field	Type	Description
Return Events	multiselect	Select which return events fire this trigger. All events are tracked by default.

Output Ports

out

Field	Type	Description
Return ID	string	-
Name	string	-
Status	string	-
Total Quantity	integer	-
Created At	string	-
Request Approved At	string	-
Closed At	string	-
Order	object	-
Decline	object	-
Return Line Items	array	-
Reverse Fulfillment Orders	array	-
Webhook Topic	string	-

Full Metadata

#metadata-viewer { display: none; }{ "name": "appmixer.shopify.returns.ReturnTracking", "description": "Triggers on the selected return events: a return is requested, approved, declined, cancelled, closed, reopened or updated.", "author": "Appmixer <info@appmixer.com>", "private": false, "webhook": true, "auth": { "service": "appmixer:shopify", "scope": [ "read_returns", "read_orders" ] }, "properties": { "schema": { "type": "object", "properties": { "topics": { "type": [ "array", "string" ] } } }, "inspector": { "inputs": { "topics": { "type": "multiselect", "label": "Return Events", "index": 1, "defaultValue": [ "returns/request", "returns/approve", "returns/decline", "returns/cancel", "returns/close", "returns/reopen", "returns/update" ], "tooltip": "Select which return events fire this trigger. All events are tracked by default.", "options": [ { "content": "Return requested", "value": "returns/request" }, { "content": "Return approved", "value": "returns/approve" }, { "content": "Return declined", "value": "returns/decline" }, { "content": "Return cancelled", "value": "returns/cancel" }, { "content": "Return closed", "value": "returns/close" }, { "content": "Return reopened", "value": "returns/reopen" }, { "content": "Return updated", "value": "returns/update" } ] } } } }, "outPorts": [ { "name": "out", "schema": { "type": "object", "required": [ "id", "name", "status", "totalQuantity", "createdAt", "order", "returnLineItems", "reverseFulfillmentOrders", "webhookTopic" ], "properties": { "id": { "type": "string", "title": "Return ID", "example": "gid://shopify/Return/14381973585" }, "name": { "type": "string", "title": "Name", "example": "#1018-R1" }, "status": { "type": "string", "title": "Status", "example": "OPEN" }, "totalQuantity": { "type": "integer", "title": "Total Quantity", "example": 1 }, "createdAt": { "type": "string", "title": "Created At", "example": "2026-10-03T09:00:00Z", "format": "date-time" }, "requestApprovedAt": { "type": "string", "title": "Request Approved At", "example": "2026-10-03T10:00:00Z", "format": "date-time" }, "closedAt": { "type": "string", "title": "Closed At", "example": "2026-10-06T12:00:00Z", "format": "date-time" }, "order": { "type": "object", "title": "Order", "required": [ "id", "legacyResourceId", "name" ], "properties": { "id": { "type": "string", "title": "Order.ID", "example": "gid://shopify/Order/7801814876320" }, "legacyResourceId": { "type": "string", "title": "Order.Legacy Resource ID", "example": "7801814876320" }, "name": { "type": "string", "title": "Order.Name", "example": "#1018" } } }, "decline": { "type": "object", "title": "Decline", "required": [ "reason" ], "properties": { "reason": { "type": "string", "title": "Decline.Reason", "example": "RETURN_PERIOD_ENDED" }, "note": { "type": "string", "title": "Decline.Note", "example": "The 30-day return window has passed." } } }, "returnLineItems": { "type": "array", "title": "Return Line Items", "items": { "type": "object", "required": [ "id", "quantity", "returnReasonNote" ], "properties": { "id": { "type": "string", "title": "ID", "example": "gid://shopify/ReturnLineItem/22573695185" }, "quantity": { "type": "integer", "title": "Quantity", "example": 1 }, "customerNote": { "type": "string", "title": "Customer Note", "example": "Too small" }, "returnReasonNote": { "type": "string", "title": "Return Reason Note", "example": "" }, "returnReasonDefinition": { "type": "object", "title": "Return Reason", "required": [ "handle", "name" ], "properties": { "handle": { "type": "string", "title": "Return Reason.Handle", "example": "size-too-small" }, "name": { "type": "string", "title": "Return Reason.Name", "example": "Size too small" } } }, "fulfillmentLineItem": { "type": "object", "title": "Fulfillment Line Item", "required": [ "id", "lineItem" ], "properties": { "id": { "type": "string", "title": "Fulfillment Line Item.ID", "example": "gid://shopify/FulfillmentLineItem/16893829329105" }, "lineItem": { "type": "object", "title": "Fulfillment Line Item.Line Item", "required": [ "id", "name" ], "properties": { "id": { "type": "string", "title": "Fulfillment Line Item.Line Item.ID", "example": "gid://shopify/LineItem/17193826779345" }, "name": { "type": "string", "title": "Fulfillment Line Item.Line Item.Name", "example": "The Multi-location Snowboard" } } } } } } }, "example": [ { "id": "gid://shopify/ReturnLineItem/22573695185", "quantity": 1, "customerNote": "Too small", "returnReasonNote": "", "returnReasonDefinition": { "handle": "size-too-small", "name": "Size too small" }, "fulfillmentLineItem": { "id": "gid://shopify/FulfillmentLineItem/16893829329105", "lineItem": { "id": "gid://shopify/LineItem/17193826779345", "name": "The Multi-location Snowboard" } } } ] }, "reverseFulfillmentOrders": { "type": "array", "title": "Reverse Fulfillment Orders", "items": { "type": "object", "required": [ "id", "status" ], "properties": { "id": { "type": "string", "title": "ID", "example": "gid://shopify/ReverseFulfillmentOrder/12960858257" }, "status": { "type": "string", "title": "Status", "example": "OPEN" } } }, "example": [ { "id": "gid://shopify/ReverseFulfillmentOrder/12960858257", "status": "OPEN" } ] }, "webhookTopic": { "type": "string", "title": "Webhook Topic", "example": "returns/request" } } } } ], "icon": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiA/PjwhRE9DVFlQRSBzdmcgIFBVQkxJQyAnLS8vVzNDLy9EVEQgU1ZHIDEuMS8vRU4nICAnaHR0cDovL3d3dy53My5vcmcvR3JhcGhpY3MvU1ZHLzEuMS9EVEQvc3ZnMTEuZHRkJz48c3ZnIGVuYWJsZS1iYWNrZ3JvdW5kPSJuZXcgMCAwIDEyOCAxMjgiIGlkPSJTb2NpYWxfSWNvbnMiIHZlcnNpb249IjEuMSIgdmlld0JveD0iMCAwIDEyOCAxMjgiIHhtbDpzcGFjZT0icHJlc2VydmUiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiPjxnIGlkPSJfeDM3X19zdHJva2UiPjxnIGlkPSJTaG9waWZ5Ij48cmVjdCBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGZpbGw9Im5vbmUiIGZpbGwtcnVsZT0iZXZlbm9kZCIgaGVpZ2h0PSIxMjgiIHdpZHRoPSIxMjgiLz48cGF0aCBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik03MC40NSwxOS41NjhjMC0wLjQzNiwwLjAwNC0wLjg2NCwwLjAwNC0xLjMzMiAgICBjMC00LjA4LTAuNTY1LTcuMzY4LTEuNDY5LTkuOTcyYzMuNjM0LDAuNDU2LDYuMDU0LDQuNjEyLDcuNjEsOS4zOTJDNzQuNzczLDE4LjIyNCw3Mi42OTksMTguODY4LDcwLjQ1LDE5LjU2OHogTTYyLjQyNiw2MC4yNDggICAgYzAsMC00LjI1MS0yLjI4LTkuNDYxLTIuMjhjLTcuNjQyLDAtOC4wMjgsNC44Mi04LjAyOCw2LjAzMmMwLDYuNjI4LDE3LjE4Nyw5LjE2OCwxNy4xODcsMjQuNjg4ICAgIGMwLDEyLjIwOC03LjcwNiwyMC4wNzItMTguMDk4LDIwLjA3MmMtMTIuNDcsMC0xOC44NDYtNy44LTE4Ljg0Ni03LjhsMy4zMzktMTEuMDg0YzAsMCw2LjU1NSw1LjY1NiwxMi4wODgsNS42NTYgICAgYzMuNjEsMCw1LjA4My0yLjg2LDUuMDgzLTQuOTQ4YzAtOC42NDQtMTQuMTAyLTkuMDMyLTE0LjEwMi0yMy4yMzZjMC0xMS45NTIsOC41MzgtMjMuNTIsMjUuNzcyLTIzLjUyICAgIGM2LjYzOSwwLDkuOTIzLDEuOTEyLDkuOTIzLDEuOTEyTDYyLjQyNiw2MC4yNDh6IE01OS41OTYsNC40MjhjMC43MTIsMCwxLjQyNSwwLjI0NCwyLjExLDAuNzE2ICAgIGMtNS4yNjYsMi40ODgtMTAuOTA2LDguNzYtMTMuMjksMjEuMjhjLTMuNDgzLDEuMDg0LTYuODg2LDIuMTQ0LTEwLjAzNCwzLjEyNEM0MS4xNzEsMTkuOTk2LDQ3Ljc5OCw0LjQyOCw1OS41OTYsNC40Mjh6ICAgICBNNjYuMTQ3LDIwLjE5MmMwLDAuMjUyLTAuMDA0LDAuNDg0LTAuMDA0LDAuNzE2Yy00LDEuMjQ0LTguMzQzLDIuNTk2LTEyLjY5NywzLjk1MkM1NS44OSwxNS4zOCw2MC40NzIsMTAuOCw2NC40OCw5LjA3MiAgICBDNjUuNDg3LDExLjYxNiw2Ni4xNDcsMTUuMjY4LDY2LjE0NywyMC4xOTJ6IE04NS4wNTgsMTUuMDk3Yy0wLjI2LDAuMDM0LTAuNDg1LDAuMDg1LTAuNjQyLDAuMTMxICAgIGMtMC4wODQsMC4wMjQtMS40ODUsMC40Ni0zLjgwNSwxLjE4Qzc4LjMzOSw5Ljg0LDc0LjMzMSwzLjgwNCw2Ny4yODIsMy44MDRjLTAuMTk1LDAtMC4zOTgsMC4wMDgtMC41OTcsMC4wMiAgICBDNjQuNjc5LDEuMTYsNjIuMTk1LDAsNjAuMDUsMEM0My42MjMsMCwzNS43NzQsMjAuNjQsMzMuMzE0LDMxLjEyNGMtNi4zODQsMS45ODgtMTAuOTE4LDMuNC0xMS40OTUsMy41ODQgICAgYy0zLjU2NiwxLjEyNC0zLjY3OCwxLjIzNi00LjE0Myw0LjYwOEMxNy4zMjIsNDEuODcyLDgsMTE0LjMyNCw4LDExNC4zMjRMODAuNjM5LDEyOGwwLjA3Ny0wLjAxN0w4NS4wNTgsMTUuMDk3eiBNOTAuMjU5LDE4LjY1MiAgICBjMi4wOTcsMi4wOTMsNC40NzUsNC40NjQsNC40NzUsNC40NjRzOS43ODcsMC43MjgsMTAuMjQ5LDAuNzY4YzAuNDY2LDAuMDQsMS4wMjcsMC4zOTYsMS4xMTQsMS4wNCAgICBjMC4wODgsMC42NDQsMTMuOTAzLDk0LjUyLDEzLjkwMyw5NC41MmwtMzMuOTAxLDcuMzY5TDkwLjI1OSwxOC42NTJ6IiBmaWxsPSIjODFCRjM3IiBmaWxsLXJ1bGU9ImV2ZW5vZGQiIGlkPSJTaG9waWZ5XzFfIi8+PC9nPjwvZz48L3N2Zz4=" }