The input fields for the fulfillment hold applied on the fulfillment order.
Access Scopes
Fields
externalId:
String -
A configurable ID used to track the automation system releasing these holds.
fulfillmentOrderLineItems:
FulfillmentOrderLineItemInput -
The fulfillment order line items to be placed on hold.
If left blank, all line items of the fulfillment order are placed on hold.
handle:
String -
An identifier that an app can use to reference one of the holds that it applies to a
fulfillment order.
This field must be unique among the holds that a single app applies to a single fulfillment order and
cannot exceed 64 characters.
For example, an app can place multiple holds on a single fulfillment order each with a different handle.
If an app tries to place two holds with the same handle on a single fulfillment order then an error will
be returned. The same handle can however be re-used on different
fulfillment orders and by different apps.
By default this handle will be an empty string. If an app wishes to place multiple holds on a single
fulfillment order then a different handle must be provided for each.
notifyMerchant:
Boolean -
Whether the merchant receives a notification about the fulfillment hold. The default value is `false`.
reason:
FulfillmentHoldReason! -
The reason for the fulfillment hold.
reasonNotes:
String -
Additional information about the fulfillment hold reason.