Hold fulfillment order

TheHold fulfillment orderaction changes the status of the order that triggers the workflow toOn hold. Orders with theOn holdstatus are not fulfilled until the status is removed.

On this page

Fields

TheHold fulfillment orderaction contains the following fields.

Fields used in the Hold fulfillment order action.
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

TheHold fulfillment orderaction has hidden fields added to it by the trigger. These fields,Order IDandFulfillment 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.

TheHold fulfillment orderaction can be used in workflows that start with the following triggers:

Example

Example of a workflow that sends a hold fulfillment order request when the order's risk is high

In this example workflow, a hold fulfillment order request is sent when the order's risk is high.

API details

To learn more, review thefulfillmentOrderHoldmutation.

Ready to start selling with Shopify?

Try it free