AutomationTaskConfigField

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.

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 duration, encoded as a JSON object with amount and unit in a string. Unit values are lowercase, such as seconds or hours.

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 decimal number, encoded as a string.

A field path used to read task input from the automation's data. The default path is provided in defaultValue.

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 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 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 text value. Liquid expressions are accepted only when supportsLiquid is true, and secret references only when supportsSecrets is true.

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.