Applies a fulfillment hold to an open fulfillment order, halting all fulfillment work. Use when you need to pause fulfillment due to payment issues, fraud concerns, address problems, or inventory shortages. The fulfillment order status will change to on_hold, preventing any fulf…
reasonRequiredstringReason for applying the hold. Must be one of: awaiting_payment, high_risk_of_fraud, incorrect_address, inventory_out_of_stock, or other.
reason_notesstringAdditional context or explanation for the hold reason. Provides more details beyond the standard reason.
notify_merchantbooleanWhether to send a notification to the merchant about this hold via the Shopify mobile app. Defaults to false if not specified.
fulfillment_order_idRequiredstringThe unique identifier of the fulfillment order to place on hold.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
OAuth connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.