Add draft order metafield

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

Fields

The Add draft order metafield action contains the following fields.

Fields used in the Add draft order metafield action.
Field Description
Metafield namespace Required. A metafield namespace is a container for a group of metafields. Grouping metafields within a namespace prevents your metafields from conflicting with others.
Key Required. A key is an identifier for the metafield value.
Value Required. 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.
Type The data type of the metafield's value.

Triggers

The Add 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 Add draft order metafield action can be used in workflows that start with the following triggers:

  • Draft order created

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.

Ready to start selling with Shopify?

Try it free