Skip to main content
Anchor to AutomationCommerceObjectConfigField

AutomationCommerceObjectConfigField

object

Requires write_automations access scope.

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.

•String

The default value encoded as a string in the format expected by this field type.

•String

The field description.

•String!
non-null

The field ID written into the automation step's configuration as config_field_id.

•String!
non-null

The field display name.

•[String!]!
non-null

The commerce object types allowed for this field.

•Boolean!
non-null

Whether the field must have a value.

•[AutomationTaskConfigFieldValidation!]!
non-null

The validations that can be checked before saving the workflow.

Show fields

Was this section helpful?


Was this section helpful?