Skip to main content

releaseOrderHold

Releases an active hold on a V2 order.

Holds stack: releasing one of many holds leaves the order held. Only once every active hold is released does the order come off hold and guarded fulfillment transitions (allocate, send) become permitted.

Requirements​

  • User must have update_order permission
  • Hold must exist and be currently active

Arguments​

  • hold_id (required): The ID of the hold to release
  • release_note (optional): Free-text note recorded on release

Behavior​

  • Publishes an OrderHoldReleased event to the order stream
  • Returns the released order hold
releaseOrderHold(
  input: ReleaseOrderHoldInput!
): V2OrderHold!

Arguments​

releaseOrderHold.input ● ReleaseOrderHoldInput! non-null input common​

Parameters for ReleaseOrderHold

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.