10/28/2026, 12:00:38 AM
The Shopify Admin API now exposes a rich set of Automation endpoints for managing Flow workflows, including the ability to create, update, activate, deactivate, delete, and test automation versions. New queries such as automationWorkflow, automationWorkflowCreate, automationWorkflowUpdate, automationEnvironmentPaths, and automationFlowFileParse let clients retrieve workflow metadata, draft data, available field paths, and parse exported .flow files into JSON configuration without persisting them. Mutations automationTestEventsCreate, automationWorkflowActivate, automationWorkflowDeactivate and automationWorkflowDelete provide full lifecycle management for drafts, allowing developers to test events, flip state and remove stale automations. The schema now includes a comprehensive suite of AutomationTaskConfigField types—API call, array, boolean, code, collections, commerce object, condition, duration, enum, float, hardcoded path, integer, map, marketing activity, metafield type, multi‑resource, path, platform marketing activity, query preset, recurrence, select, shipping carrier, shipping package, Shopify events trigger, ShopifyQL query, single resource, sort, text, typed metafield, weight, weight input, and unsupported/hardcoded path—providing strong typing for task configuration in Flow. Enum types such as AutomationCodeLanguage, AutomationCodeRole, AutomationDurationUnit, AutomationEnvironmentPathDataType, among others, give context for the new configuration fields and for filtering path results. Pagination support, search and filter syntax are also updated for queries like automationTasks and automationTemplates, leveraging first/after/last/before cursors with limits and reverse ordering.
Returns field paths available from a root type, ordered by relevance to the search query.
Parses an exported .flow file into an automation configuration without saving a workflow.
Returns an automation task by ID.
Returns the automation tasks available to the shop.
Returns a Flow template by ID.
Returns the Flow templates available to the shop.
Returns a saved automation version. Without a version, returns the latest draft or the most recently published version if no draft exists.
Returns automations visible in the Flow editor, most recently updated first. Each result is the latest draft, or the most recently published version if no draft exists.
Creates custom test events for an automation. If any event is invalid, or the events would exceed the automation's custom test event limit, none of them are created.
Activates a specific automation version. Activating the currently active version succeeds without making changes, even when a newer draft exists.
Creates a draft automation from a JSON configuration.
Input errors are returned in userErrors and nothing is saved. A saved draft can still havevalidationErrors, such as a missing action or an incomplete configuration field; fix those before activating.
Deactivates a specific automation version and cancels its runs. An action already executing may still finish.
Deletes an inactive automation. Deactivate an active automation before deleting it.
Updates an automation's name, tags, note, or configuration. Supply at least one editable field.
Omitted fields keep their existing values.
Replacing the configuration edits the latest draft in place, or creates a draft if none exists.
Any active version continues running with its existing configuration. Changes to the name, tags, or note
don't create a draft.
Input errors are returned in userErrors and nothing is saved. A saved version can still havevalidationErrors; fix those before activating it.
A Shopify Admin API mutation and its input values.
A list of string values, encoded as a JSON array in a string.
A boolean value, encoded as the string true or false.
Source code for a task's input query, script, or output schema. Check language and role for the expected content.
The language of an automation code field.
The role of code within an automation task.
A selection of Shopify collections.
A reference to a Shopify resource ID, encoded as a JSON object in a string. Set value to a literal GID or a Liquid expression such as {{ order.customer.id }}. When value is blank, default_value supplies a field path such as order.customer.id. Use possibleObjectTypes for the allowed resource types.
A condition expression that decides which branch an automation takes, written in Flow's condition syntax. Compare a field path with a literal or another path using ==, !=, >, >=, <, <=, string operators such as start_with? and include?, or unary checks such as nil? and empty_or_nil?. Test lists with any?, all?, or none? and an item variable, and combine expressions with && or ||. Example: (order.totalPrice > 100) && (order.tags any? |tags_item| (tags_item == 'vip')).
A selectable value for an automation configuration field.
The app or built-in connector that provides an automation task.
A duration, encoded as a JSON object with amount and unit in a string. Unit values are lowercase, such as seconds or hours.
An allowed unit of duration.
A member of an Admin GraphQL enum. Options and the default value use the Admin API version of the request. If the schema is unavailable, options are empty and only an explicit default is preserved.
A valid field path through the Admin API schema for use in an automation workflow.
An auto-generated type for paginating through multiple AutomationEnvironmentPaths.
The leaf data type used to filter automation environment paths.
An auto-generated type which holds one AutomationEnvironmentPath and a cursor during pagination.
A decimal number, encoded as a string.
The name and JSON configuration parsed from an exported .flow file.
A field path used to read task input from the automation's data. The default path is provided in defaultValue.
A rule requiring a value from an allowed set.
An integer, encoded as a string. Liquid expressions are accepted only when supportsLiquid is true.
Key/value pairs, encoded as a JSON array of two-element arrays in a string.
A marketing activity associated with an email action.
A JavaScript regular expression rule with editor flags.
A metafield value type selected from options.
A selection of multiple Admin API resources of the type named by adminResourceType.
A field path that selects a value from the automation's data. Use listsOnly and allowedTypes to determine which paths can be selected.
A marketing activity associated with an automation action.
A search query for fetching resources, with preset expressions listed in options.
A preset query expression.
A numeric range rule.
A recurring schedule, encoded as a string containing a JSON array of iCalendar schedules. Each schedule is a DTSTART line with a TZID from timeZones, a newline, and an RRULE line, for example DTSTART;TZID=America/Toronto:20261101T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO.
A single value selected from options. Use the option value in the automation configuration.
A shipping carrier and service selection.
A shipping package selection.
The fields monitored by an update trigger. Use options for selectable fields and maxSelections for the selection limit.
A ShopifyQL query to run as part of an automation.
A selection of one Admin API resource of the type named by adminResourceType.
A resource sort key and direction, encoded as a JSON object in a string. Set sortKey to a value from options and order to ASCENDING or DESCENDING.
A version of a task that can be used as a step in an automation.
A configurable value accepted by an automation task.
A validation that can be checked before saving a workflow.
An auto-generated type for paginating through multiple AutomationTasks.
An auto-generated type which holds one AutomationTask and a cursor during pagination.
A value produced by an automation task.
The publication state of an automation task version.
The role a task plays in an automation.
A Shopify Flow template that provides a starting configuration for a new automation.
An auto-generated type for paginating through multiple AutomationTemplates.
An auto-generated type which holds one AutomationTemplate and a cursor during pagination.
Sample trigger data used to test an automation.
The input fields for a custom automation test event.
The origin of an automation test event.
Return type for automationTestEventsCreate mutation.
An error that prevented automation test events from being created.
Possible error codes that can be returned by AutomationTestEventsCreateUserError.
A text value. Liquid expressions are accepted only when supportsLiquid is true, and secret references only when supportsSecrets is true.
A time zone used by an automation recurrence.
A metafield selection with a namespace, key, and value type. Use supportedTypes for the allowed types.
A configuration field with a type this API version doesn't describe. It's returned so that clients can see whether the field is required.
A metafield selection identified by its namespace and key.
A shipping package weight, encoded as a JSON object with amount and unit in a string.
A weight, encoded as a JSON object with optional value and unit in a string.
A version of an automation that runs tasks when a trigger event occurs. An automation can have a saved draft
while another version is active. All versions share the same ID, name, and tags; configuration, note,
and versionState describe the selected version.
Use automationWorkflowCreate to create a draft and automationWorkflowUpdate to edit it.
Compare activeVersion with version to check whether this version is running.
Return type for automationWorkflowActivate mutation.
An auto-generated type for paginating through multiple AutomationWorkflows.
Return type for automationWorkflowCreate mutation.
Return type for automationWorkflowDeactivate mutation.
Return type for automationWorkflowDelete mutation.
An auto-generated type which holds one AutomationWorkflow and a cursor during pagination.
Return type for automationWorkflowUpdate mutation.
An error that prevented an automation operation from succeeding. For create and update, the requested changes weren't saved. Check code for the reason and field for the affected argument when available. Validation errors on a saved version are returned in automationWorkflow.validationErrors.
Possible error codes that can be returned by AutomationWorkflowUserError.
A validation error for a saved automation version. These errors don't prevent saving or reading the automation.
The reason a saved automation version can't be activated. These errors can be returned after a successful create or update.
The definition state of an automation version, independent of activation.
Represents the selling plan applied to a draft order line item, and the prices of the line
item when it's purchased with that selling plan. Editing or deleting the selling plan
afterwards doesn't change what's returned here, and these values don't lock the selling
plan's terms.
Represents the billing frequency of a selling plan applied to a draft order line item (for
example, bill every week, or bill every three months).
The resulting prices for a draft order line item when it's purchased with a specific selling
plan. These are the prices resolved for the line item, not the selling plan's pricing policy.
Represents a recurring billing policy for a selling plan applied to a draft order line item.
sellingPlanApplicationThe selling plan applied to the line item. Null when the line item has no selling plan.
sellingPlanApplicationThe selling plan applied to the line item. Null when the line item has no selling plan.
inventoryBinsDESTINATION_ADDRESS_INVALID