OrderFilterInput

Filtering options for orders

input OrderFilterInput {
  b2bOrder: Boolean
  brandIds: [ID!] @deprecated
  carrierIds: [ID!]
  createdById: ID
  customerRefNumber: String
  endDate: ISO8601DateTime
  endShippingDateFrom: ISO8601DateTime
  endShippingDateTo: ISO8601DateTime
  fulfillable: Boolean
  fulfillmentMethods: [OrderFulfillmentMethodEnum!]
  keyword: String
  orderNumber: String
  poNumber: String
  productIds: [ID!]
  quickSearch: String
  responsibleId: ID
  salesChannelIds: [ID!]
  sortField: OrderSortFieldEnum
  sortType: SortTypeEnum
  startDate: ISO8601DateTime
  startShippingDateFrom: ISO8601DateTime
  startShippingDateTo: ISO8601DateTime
  status: [OrderStatusEnum!]
  statusAlertSeverity: [OrderStatusAlertSeverityEnum!]
  tagNames: [String!]
  templateId: ID
}

Fields

`OrderFilterInput.b2bOrder` ● `Boolean` scalar common

Filter by special orders. If true, only special orders will be returned.

`OrderFilterInput.brandIds` ● `[ID!]` deprecated list scalar common

DEPRECATED

This argument will be removed in the future. Brand is becoming a product-only attribute. Use company context instead.

`OrderFilterInput.carrierIds` ● `[ID!]` list scalar common

Carrier IDs to filter orders by.

`OrderFilterInput.createdById` ● `ID` scalar common

`OrderFilterInput.customerRefNumber` ● `String` scalar common

Filter special orders by customer reference number.

`OrderFilterInput.endDate` ● `ISO8601DateTime` scalar common

End date to filter orders by.

`OrderFilterInput.endShippingDateFrom` ● `ISO8601DateTime` scalar common

Filter special orders by end shipping date (from).

`OrderFilterInput.endShippingDateTo` ● `ISO8601DateTime` scalar common

Filter special orders by end shipping date (to).

`OrderFilterInput.fulfillable` ● `Boolean` scalar common

Fulfillability status to filter orders by. If not provided, all fulfillable statuses will be included.

`OrderFilterInput.fulfillmentMethods` ● `[OrderFulfillmentMethodEnum!]` list enum orders

Fulfillment methods to filter orders by.

`OrderFilterInput.keyword` ● `String` scalar common

Keyword to search for in orders. This keyword will be searched in order number, ship to name, ship to email, ship to phone, ship to company, bill to name, bill to email, bill to phone, and bill to company.