Skip to main content

placeOrderHold

Places a hold on a V2 order.

While any hold is active the order is considered held and guarded fulfillment transitions (allocate, send) are rejected. Holds stack: placing a second hold on an already-held order succeeds and both holds must be released for the order to come off hold.

Requirements​

  • User must have update_order permission
  • Order must exist and be in a holdable state (draft, pending, ordered, in_progress)
  • Order must not be externally managed

Arguments​

  • order_id (required): The ID of the order to place on hold
  • reason (optional): Free-text reason for the hold; defaults to empty string

Behavior​

  • Publishes an OrderHoldPlaced event to the order stream
  • Returns the resulting order hold
placeOrderHold(
  input: PlaceOrderHoldInput!
): V2OrderHold!

Arguments​

placeOrderHold.input ● PlaceOrderHoldInput! non-null input common​

Parameters for PlaceOrderHold

Type​

V2OrderHold object orders​

A hold placed on a V2 order. While any hold is active the order is considered held and guarded fulfillment transitions are rejected.