FulfillmentOrderHoldPayload
Return type for mutation.
Anchor to FieldsFields
- Anchor to fulfillmentHoldfulfillment•
Hold The fulfillment hold created for the fulfillment order. Null if no hold was created.
- Anchor to fulfillmentOrderfulfillment•
Order The fulfillment order on which a fulfillment hold was applied.
- Anchor to remainingFulfillmentOrderremaining•
Fulfillment Order The remaining fulfillment order containing the line items to which the hold wasn't applied, if specific line items were specified to be placed on hold.
- Anchor to userErrorsuser•
Errors The list of errors that occurred from executing the mutation.
Anchor to Mutations with this payloadMutations with this payload
- •mutation
Applies a fulfillment hold on a fulfillment order.
As of the 2025-01 API version, the mutation can be successfully executed on fulfillment orders that are already on hold. To place multiple holds on a fulfillment order, apps need to supply the handle field. Each app can place up to 10 active holds per fulfillment order. If an app attempts to place more than this, the mutation will return a user error indicating that the limit has been reached. The app would need to release one of its existing holds before being able to apply a new one.