Skip to main content

orderSignals

Get a paginated, filtered list of order signals for the current company.

A signal identifies an issue, a normal next step, or contextual information about an order. Signals are derived from the order’s current state, so they appear and clear on their own. Resolved signals are kept as history and returned only when asked for.

Sorted by stored priority descending, then oldest first. Refreshed signals rank issues before normal next steps and information. Older signals retain their previous priority until refreshed or backfilled. Categories are read from the current signal definitions.

Filters​

  • signalNames: Limit to these signal names. Query signalDefinitions for the set.
  • signalTypes: Limit to these categories.
  • orderIds: Limit to signals on these orders.
  • resolved: True returns the resolved signals kept as history, instead of the active ones returned by default.
  • createdAtFrom / createdAtTo: Limit by when the signal began.
  • keyword: Case-insensitive partial match on the order number. Ignored below three characters.
  • oneSignalPerOrder: When true, returns at most one signal per order: the highest priority among the signals that pass the other filters.
  • salesChannelIds: Limit to signals whose order belongs to these sales channels.
  • sourceIntegrationIds: Limit to signals whose order came from these source integrations.
  • orderStatus: Limit to signals whose order is in these statuses.
  • orderCreatedAtFrom / orderCreatedAtTo: Limit by when the order was created (distinct from createdAtFrom / createdAtTo, which use the signal’s date).

Permissions Required​

  • orders:read_signals permission
orderSignals(
  after: String
  before: String
  filters: OrderSignalFilterInput
  first: Int
  last: Int
): OrderSignalConnection

Arguments​

orderSignals.after ● String scalar common​

Returns the elements in the list that come after the specified cursor.

orderSignals.before ● String scalar common​

Returns the elements in the list that come before the specified cursor.

orderSignals.filters ● OrderSignalFilterInput input common​

Filtering options for order signals.

orderSignals.first ● Int scalar common​

Returns the first _n_ elements from the list.

orderSignals.last ● Int scalar common​

Returns the last _n_ elements from the list.

Type​

OrderSignalConnection object common​

The connection type for OrderSignal.