Skip to main content

V2OrderHold

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

type V2OrderHold {
  active: Boolean!
  id: ID!
  order: V2Order
  placedAt: ISO8601DateTime!
  placedBy: Party!
  reason: String!
  releaseNote: String
  releasedAt: ISO8601DateTime
  releasedBy: Party
}

Fields​

V2OrderHold.active ● Boolean! non-null scalar common​

True while the hold has not been released.

V2OrderHold.id ● ID! non-null scalar common​

V2OrderHold.order ● V2Order object orders​

The order this hold is placed on. Null if the order has been archived.

V2OrderHold.placedAt ● ISO8601DateTime! non-null scalar common​

The time at which the hold was placed.

V2OrderHold.placedBy ● Party! non-null object common​

The party that placed the hold.

V2OrderHold.reason ● String! non-null scalar common​

Free-text reason the hold was placed. May be empty.

V2OrderHold.releaseNote ● String scalar common​

Free-text note recorded on release, if any.

V2OrderHold.releasedAt ● ISO8601DateTime scalar common​

The time at which the hold was released, if released.

V2OrderHold.releasedBy ● Party object common​

The party that released the hold, if released.

Returned By​

placeOrderHold mutation ● releaseOrderHold mutation

Member Of​

V2Order object