Subchapter 22.6

Flow

references/flow.mdMarkdown20 KBView on GitHub

Flow workflows

Shopify Flow

Flow · Shopify · Shopify/Shopify-AI-Toolkit · Skills Docs

Read	Purpose
`automationWorkflows`	Search by name, `status:ACTIVE`/`status:INACTIVE`, or `trigger:"<task ID>"`, combined with `AND`.
`automationWorkflow(id:, version:)`	Read a workflow; omit version for latest draft, or main if no draft exists.
`automationTasks`	Search by text and optional `taskType`.
`automationTask(id:)`	Look up a returned versioned task GID.
`automationTemplates`	Search template titles and descriptions by text.
`automationTemplate(id:)`	Read the chosen template’s configuration.
`automationEnvironmentPaths`	Find data paths with required `rootType` and natural-language `query`.
`automationFlowFileParse(flowFileContent:)`	Parse complete `.flow` contents into `name` and `configuration` without saving.

query FindTasks($query: String!) {
  automationTasks(first: 10, query: $query) {
    nodes { id taskId version label taskType state connector { name installed installUrl } }
    pageInfo { hasNextPage endCursor }
  }
}

query ConfigureTask($id: ID!) {
  automationTask(id: $id) {
    taskId version outputPortIds
    configFields { ...FlowTaskConfigField }
    returnFields { name description type typeDefinitions }
  }
}

query ReadWorkflow($id: ID!, $version: String) {
  automationWorkflow(id: $id, version: $version) {
    id name version versionState activeVersion adminApiVersion tags note configuration
    validationErrors { code message stepId configFieldId }
  }
}

Mutation	Arguments
`automationWorkflowCreate`	Required `name`, `configuration`; optional `tags`, `note`.
`automationWorkflowUpdate`	Required `id`, `version`; optional `name`, `configuration`, `tags`, `note`.
`automationWorkflowActivate` / `automationWorkflowDeactivate`	Required `id`, `version`.
`automationWorkflowDelete`	Required `id`; deletes the whole workflow.

mutation CreateWorkflow($name: String!, $configuration: JSON!) {
  automationWorkflowCreate(name: $name, configuration: $configuration) {
    automationWorkflow {
      id
      version
      activeVersion
      validationErrors { code message stepId configFieldId }
    }
    userErrors { field message code }
  }
}

shopify store execute \
  --store example.myshopify.com \
  --version unstable \
  --query-file /tmp/flow-operation.graphql \
  --variable-file /tmp/flow-variables.json \
  --allow-mutations \
  --json

query FindFields($workflowId: ID, $version: String) {
  automationEnvironmentPaths(
    rootType: "Order"
    query: "customer email"
    workflowId: $workflowId
    version: $version
    first: 10
  ) {
    nodes { path description leafType pathElementsTypes searchCategories }
    pageInfo { hasNextPage endCursor }
  }
}

(order.totalPrice > 100)
(order.note include? 'urgent')
(order.name in? '#1001,#1002')
(order.customer.firstName not_empty_and_not_nil?)
(order.tags any? |tags_item| (tags_item == 'vip'))
(order.lineItems any? |lineItems_item| (lineItems_item.product.tags any? |tags_item| (tags_item == 'presale')))

Scheduled time: recurrence is a JSON-encoded array of RRULE strings with a future DTSTART and IANA timezone. Decoded form: DTSTART;TZID=America/Toronto:YYYYMMDDTHHMMSS\nRRULE:FREQ=DAILY;INTERVAL=1;WKST=MO. Replace placeholders with a future start and preserve the newline through both JSON layers. Intervals range from 10 minutes to one year; follow field constraints.
Get Data: returns a list of at most 100 records, even for one expected match. More can match than it returns, so do not treat the list as every matching record. Iterate it with ForEach or list operators; do not assume one object or select [0]. Use discovered queryFilters, presets, sort/limit rules; unsupported filters can be ignored and broaden results. Check resource-specific search/ID formats, quote values with spaces, and use ISO dates.
ForEach: standard input is listpath, a verified list path without Liquid braces. loop_body enters iteration; after runs after completion. Verify item names/scope.
Send Admin API Request: verify the mutation at the workflow’s adminApiVersion, which can differ from the unstable endpoint used to manage it. Its config value is a JSON-encoded object with mutation name and JSON argument text in blob, e.g. {"name":"customerUpdate","blob":"{\"input\":{\"id\":\"{{ order.customer.id }}\",\"note\":\"Reviewed\"}}"}. Serialize that object as the config string; it is not a full GraphQL operation. Begin/edit/commit calls need separate ordered actions with verified returned IDs; use ForEach after when commit must follow all iterations.
HTTP: follow metadata for URL, method, body, and retry/fail/ignore behavior. Headers are a JSON-encoded array of pairs, e.g. [["Content-Type","application/json"]]. Identify missing endpoints/credentials in the draft and keep the workflow inactive until they are filled in.
Email: internal email is for staff; customer email needs a suitable connector. Do not substitute a staff email for a customer email or install an app without authorization. Report required installation or manual marketing-template setup instead of repeatedly editing the draft. Use task-supplied defaults for hardcoded fields.
Run Code: input is a GraphQL query against Flow’s environment; script is synchronous JavaScript exporting default function main(input); output_schema is SDL defining Output. For example, select order { lineItems { quantity } }, return {total: input.order.lineItems.reduce((n, item) => n + item.quantity, 0)}, and define type Output { total: Int! }. Verify paths/output names, e.g. runCode.total. Admin/Functions validators do not check it. No async, promises, timers, fetch, or imports. The clock is fixed; Date.now()/new Date() are not current time. Supply a timestamp matching the requirement through the input query.
Analytics: use ShopifyQL guidance. Results are a rows list; loop before reading row fields. Verify columns for the exact query through metadata, a template, or results. Generic task return fields and the Admin schema do not establish columns.

Flow

Flow workflows

Shopify Flow

Flow

Flow workflows

Shopify Flow

Access and operations

Discover tasks and fields

Environment search and scope

Configuration

Conditions, Liquid, and patches

Task patterns

Editing and activation