Remove order metafield
The Remove order metafield action removes metafields from the order that triggers the workflow.
Fields
The Remove order metafield action contains the following fields.
| 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 other metafields. |
| Key | Required. A key is an identifier for the metafield value. |
Triggers
The Remove order metafield action has a hidden field added to it by the trigger. This field, Order ID, identifies the order to have metafields removed. The order ID is set by default and can't be changed.
The Remove order metafield action can be used in workflows that start with the following triggers:
- Fulfillment created
- Fulfillment event created
- Order canceled
- Order created
- Order fulfilled
- Order paid
- Order risk analyzed
- Order transaction created
- Refund created
- Tender transaction created
Example
In this example workflow, an order metafield is removed from all canceled orders.
API details
To learn more, review the MetafieldInput input object.