Update order metafield

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

On this page

Fields

The Update order metafield action contains the following fields.

Fields used in the Update 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 order metafield action has a hidden field added to it by the trigger. This field, Order ID, identifies the order to add metafield to. The order ID is set by default and can't be changed.

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

Example

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

In this example workflow, an order metafield is added to all newly created 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.