FulfillmentHold - admin-graphql - OBJECT

Version: 2024-10

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 or `read_third_party_fulfillment_orders` access scope.

Fields

  • displayReason: String! - The localized reason for the fulfillment hold for display purposes.
  • heldBy: String - The name of the app or service that applied 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.

Connections

Related queries

Related mutations

  • fulfillmentOrderHold Applies a fulfillment hold on a fulfillment order.

Related Unions

Examples