FulfillmentOrderHold
Applies a hold on a fulfillment order to pause fulfillment.
Procedure-Specific Information
The following input can accept either a temporary table name or a JSON aggregate that matches the structure of the referenced table as a value.
- FulfillmentOrderLineItems references the FulfillmentOrderLineItemInputs temporary table.
FulfillmentOrderLineItemInputs Temporary Table Columns
| Column Name | Type | Description |
| Id | String | The ID of the fulfillment order line item. |
| Quantity | Int | The quantity of the line item. |
Input
| Name | Type | Required | Description |
| FulfillmentOrderId | String | True | The ID of the fulfillment order. |
| Reason | String | True | The reason for applying the fulfillment hold.
The allowed values are AWAITING_PAYMENT, HIGH_RISK_OF_FRAUD, INCORRECT_ADDRESS, INVENTORY_OUT_OF_STOCK, UNKNOWN, OTHER. |
| ReasonNotes | String | False | Additional notes about the fulfillment hold. |
| NotifyMerchant | Bool | False | Whether to notify the merchant of the hold. |
| ExternalId | String | False | An identifier for the hold that you can reference later. |
| FulfillmentOrderLineItems | String | False | Line items to place on hold. |
Result Set Columns
| Name | Type | Description |
| Success | Boolean | Indicates whether or not the operation executed successfully. |
| Details | String | Any extra details on the operation's execution. |
| FulfillmentHoldId | String | The fulfillment hold created for the fulfillment order. Null if no hold was created. |
| FulfillmentOrderId | String | The fulfillment order on which a fulfillment hold was applied. |
| RemainingFulfillmentOrderId | String | The remaining fulfillment order containing the line items to which the hold wasn't applied. |