FulfillmentHold
object

Choose a version:

Requires read_assigned_fulfillment_orders access scope, read_merchant_managed_fulfillment_orders access scope or read_third_party_fulfillment_orders access scope.

A fulfillment hold currently applied on a fulfillment order.

Anchor to section titled 'Fields'

Fields

Anchor to FulfillmentHold.displayReason displayReason String! non-null: The localized reason for the fulfillment hold for display purposes.
Anchor to FulfillmentHold.handle handle String: 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 FulfillmentHold.heldBy heldBy String: The name of the app or service that applied the fulfillment hold.
Anchor to FulfillmentHold.heldByApp heldByApp App: The app that created the fulfillment hold.
Anchor to FulfillmentHold.heldByRequestingApp heldByRequestingApp Boolean! non-null: A boolean value that indicates whether the requesting app created the fulfillment hold.
Anchor to FulfillmentHold.id id ID! non-null: A globally-unique ID.
Anchor to FulfillmentHold.reason reason FulfillmentHoldReason! non-null: The reason for the fulfillment hold.
Anchor to FulfillmentHold.reasonNotes reasonNotes String: Additional information about the fulfillment hold reason.
Anchor to FulfillmentHold.releaseWarning releaseWarning String: An optional warning message displayed when attempting to release the fulfillment hold.