FulfillmentHold - admin-graphql - OBJECT

Version: unstable

Description:

A fulfillment hold currently applied on a fulfillment order.

Access Scopes

`read_assigned_fulfillment_orders` access scope, `read_merchant_managed_fulfillment_orders` access scope, `read_third_party_fulfillment_orders` access scope or `read_marketplace_fulfillment_orders` access scope.

Fields

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

Connections

Related queries

Related mutations

  • fulfillmentOrderHold Applies a fulfillment hold on a fulfillment order.

Related Unions

Examples