FulfillmentHold
Requires access scope, 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 handlehandle•
An identifier an app can use to reference one of many holds it applied to a fulfillment order. This field must be unique among the holds that a single app applies to a single fulfillment order.
- Anchor to heldByAppheld•
By App The app that created the fulfillment hold.
- 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 non-nullReason! The reason for the fulfillment hold.
- Anchor to reasonNotesreason•
Notes Additional information about the fulfillment hold reason.
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.