The Hold fulfillment order action changes the status of the order that triggers the workflow to On hold. Orders with the On hold status aren't fulfilled until the status is removed.
On this page
Fields
The Hold fulfillment order action contains the following fields.
| Field | Description |
|---|---|
| Reason | The reason to hold the fulfillment. |
| Reason notes | Additional notes on the reason that the fulfillment is put on hold. |
| Notify merchant | When selected, sends the merchant a notification that a fulfillment has been placed on hold. |
Triggers
The Hold fulfillment order action has hidden fields added to it by the trigger. These fields, Order ID and Fulfillment Order ID, identify the order to send a hold fulfillment for. The order ID and fulfillment order ID are set by default and can't be changed.
The Hold fulfillment order action can be used in workflows that start with the following triggers:
Example
In this example workflow, a hold fulfillment order request is sent when the order's risk is high.
API details
To learn more, review the fulfillmentOrderHold mutation.
