Skip to main content

OrderSignal

An issue, a normal next step, or information about a V2 order. Signals are derived from the order’s current state, so they appear and clear on their own.

type OrderSignal {
  createdAt: ISO8601DateTime!
  id: ID!
  message: String!
  metadata: JSON!
  order: V2Order!
  orderId: ID!
  priority: Int!
  resolvedAt: ISO8601DateTime
  signalName: OrderSignalNameEnum!
  signalType: OrderSignalTypeEnum!
}

Fields​

OrderSignal.createdAt ● ISO8601DateTime! non-null scalar common​

When the signal began. Its age in the list is measured from here, and it does not move while the signal stays active.

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

OrderSignal.message ● String! non-null scalar common​

What the user reads, with the numbers already in it. Worded in absolute terms, so nothing in it goes stale; derive any relative time from createdAt.

OrderSignal.metadata ● JSON! non-null scalar common​

The raw values behind the message. Free-form per signal and not a stable contract: use it for support and debugging, not for rendering.

OrderSignal.order ● V2Order! non-null object orders​

The order this signal is about.

OrderSignal.orderId ● ID! non-null scalar common​

The order ID this signal is about.

OrderSignal.priority ● Int! non-null scalar common​

Stored sorting priority. Older signals keep their previous priority until refreshed or backfilled.

OrderSignal.resolvedAt ● ISO8601DateTime scalar common​

When the signal cleared. Null while it is still active.

OrderSignal.signalName ● OrderSignalNameEnum! non-null enum orders​

Which signal this is.

OrderSignal.signalType ● OrderSignalTypeEnum! non-null enum orders​

The category this signal belongs to.

Member Of​

OrderSignalConnection object ● OrderSignalEdge object