Update draft order metafield

The Update draft order metafield action adds a metafield to the draft order that triggers the workflow, or updates an existing metafield on that draft order.

On this page

Fields

The Update draft order metafield action contains the following fields.

Fields used in the Update draft order metafield action.
FieldDescription
Metafield namespaceRequired. A metafield namespace is a container for a group of metafields. Grouping metafields within a namespace prevents your metafields from conflicting with other metafields.
KeyRequired. A key is an identifier for the metafield value.
ValueRequired. The value is the information to be stored in the metafield. The value is always stored as a string, regardless of the metafield's type.
TypeThe data type of the metafield's value.

Triggers

The Update draft order metafield action has a hidden field added to it by the trigger. This field, Draft order ID, identifies the draft order to add a metafield to. The draft order ID is set by default and can't be changed.

The Update draft order metafield action can be used in workflows that start with the following triggers:

Example

Example of a workflow that adds a draft order metafield when a draft order is created

In this example workflow, a draft order metafield is added to all newly created draft orders.

API details

To learn more, review the MetafieldInput input object.

Can’t find the answers you’re looking for? We’re here to help.