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.

Fields

The Update order metafield action contains the following fields.

Fields used in actions that update metafields.

Field	Description
Metafield	Required. This dropdown selects a metafield by name or by namespace and key.
Namespace	Required when selecting an unstructured metafield. A namespace is a container for a group of metafield definitions. Grouping metafields within a namespace prevents your metafields from conflicting with other metafields.
Key	Required when selecting an unstructured metafield. A key is an identifier for the metafield definition.
Type	Required when selecting an unstructured metafield. The data type of the metafield's value.
Value	The value is the information to be stored in the metafield. Format the value according to its data type to avoid errors when the workflow runs.

Triggers

The Update order metafield action requires a field, Order ID, that 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:

• Order canceled
• Order created
• Order fulfilled
• Order paid
• Order risk analyzed
• Order transaction created
• Fulfillment created
• Fulfillment event created
• Refund created
• Tender transaction created

API details

To learn more, review the MetafieldInput input object.