Add order metafield

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

Fields

The Add order metafield action contains the following fields.

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

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

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.

Ready to start selling with Shopify?

Try it free