Fulfillment
Requires access scope, access scope or access scope.
A fulfillment hold currently applied on a fulfillment order.
Anchor to FieldsFields
- Anchor to displayReasondisplay•
Reason String!non-null The localized reason for the fulfillment hold for display purposes.
- Anchor to heldByRequestingAppheld•
By Requesting App Boolean!non-null A boolean value that indicates whether the requesting app created the fulfillment hold.
- •ID!non-null
A globally-unique ID.
- Anchor to reasonreason•Fulfillment
Hold Reason!non-null The reason for the fulfillment hold.
- Anchor to reasonNotesreason•
Notes Additional information about the fulfillment hold reason.
- Anchor to heldByheld•
By The name of the app or service that applied the fulfillment hold.
Anchor to MutationsMutations
- •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.
- Anchor to fulfillmentHoldfulfillment•
Hold FulfillmentOrder Hold Input!required The details of the fulfillment hold applied on the fulfillment order.
- •ID!required
The ID of the fulfillment order on which a fulfillment hold is applied.
Arguments
- 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.
Fields