Skip to main content

OrderSignalFilterInput

Filtering options for order signals.

input OrderSignalFilterInput {
createdAtFrom: ISO8601DateTime
createdAtTo: ISO8601DateTime
keyword: String
oneSignalPerOrder: Boolean
orderCreatedAtFrom: ISO8601DateTime
orderCreatedAtTo: ISO8601DateTime
orderIds: [ID!]
orderStatus: [OrderStatusEnum!]
resolved: Boolean
salesChannelIds: [ID!]
signalNames: [OrderSignalNameEnum!]
signalTypes: [OrderSignalTypeEnum!]
sourceIntegrationIds: [ID!]
}

Fields​

OrderSignalFilterInput.createdAtFrom ● ISO8601DateTime scalar common​

Limit to signals that began on or after this time.

OrderSignalFilterInput.createdAtTo ● ISO8601DateTime scalar common​

Limit to signals that began before this time.

OrderSignalFilterInput.keyword ● String scalar common​

Case-insensitive partial match on the order number of the order the signal is about. Ignored below three characters.

OrderSignalFilterInput.oneSignalPerOrder ● Boolean scalar common​

When true, returns at most one signal per order: the most urgent one among the signals that pass the other filters.

OrderSignalFilterInput.orderCreatedAtFrom ● ISO8601DateTime scalar common​

Limit to signals whose order was created on or after this time.

OrderSignalFilterInput.orderCreatedAtTo ● ISO8601DateTime scalar common​

Limit to signals whose order was created before this time.

OrderSignalFilterInput.orderIds ● [ID!] list scalar common​

Limit to signals on these orders.

OrderSignalFilterInput.orderStatus ● [OrderStatusEnum!] list enum orders​

Limit to signals whose order is in these statuses.

OrderSignalFilterInput.resolved ● Boolean scalar common​

True returns the resolved signals kept as history. Defaults to false, the signals still active.

OrderSignalFilterInput.salesChannelIds ● [ID!] list scalar common​

Limit to signals whose order belongs to these sales channels.

OrderSignalFilterInput.signalNames ● [OrderSignalNameEnum!] list enum orders​

Limit to these signals.

OrderSignalFilterInput.signalTypes ● [OrderSignalTypeEnum!] list enum orders​

Limit to these categories.

OrderSignalFilterInput.sourceIntegrationIds ● [ID!] list scalar common​

Limit to signals whose order came from these source integrations.

Member Of​

orderSignals query