Skip to main content

OrderSearchArguments

Comprehensive search criteria for filtering orders.

Supports filtering by customer information, order status, financial details, date ranges, and more. Extends pagination and sorting capabilities for flexible order retrieval.

input OrderSearchArguments {
  page: Int!
  offset: Int!
  createdAt: DateSearchInput
  lastModifiedAt: DateSearchInput
  sortInputs: [OrderSortInput!]
  userId: [Int!]
  status: [String!]
  type: [OrderType!]
  term: String
  termFields: [OrderSearchFields!]
  price: DecimalSearchInput
  companyIds: [Int!]
  companySources: [SourceInput!]
  originalOrderIds: [Int!]
  exportStatuses: [OrderExportStatus!]
  exportedAt: DateSearchInput
  sources: [SourceSearchInput!]
}

Fields​

OrderSearchArguments.page ● Int! non-null scalar​

Pagination page number

OrderSearchArguments.offset ● Int! non-null scalar​

Pagination offset number

OrderSearchArguments.createdAt ● DateSearchInput input​

Search by date created

OrderSearchArguments.lastModifiedAt ● DateSearchInput input​

Search by date changed

OrderSearchArguments.sortInputs ● [OrderSortInput!] list input​

Inputs to sort by

OrderSearchArguments.userId ● [Int!] list scalar​

Filter by user identifiers who placed orders.

Returns orders placed by any of the specified user IDs. Useful for customer-specific order retrieval and account management.

OrderSearchArguments.status ● [String!] list scalar​

Filter by order processing statuses.

Returns orders matching any of the specified status values. Common statuses include 'pending', 'processing', 'shipped', 'delivered', 'cancelled'.

OrderSearchArguments.type ● [OrderType!] list enum​

Filter by order type classifications.

Returns orders matching any of the specified types: 'dropshipment' for supplier-direct shipping, 'purchase' for standard orders, or 'quotation' for price requests.

OrderSearchArguments.term ● String scalar​

General search term for text-based filtering.

Performs text search across multiple order fields including customer names, company names, email addresses, and reference numbers. Use with searchFields to specify which fields to search.

OrderSearchArguments.termFields ● [OrderSearchFields!] list enum​

List of specific fields to search in

OrderSearchArguments.price ● DecimalSearchInput input​

Search by price range

OrderSearchArguments.companyIds ● [Int!] list scalar​

Search by company ids

OrderSearchArguments.companySources ● [SourceInput!] list input​

List of company sources

OrderSearchArguments.originalOrderIds ● [Int!] list scalar​

Search by original order ids

OrderSearchArguments.exportStatuses ● [OrderExportStatus!] list enum​

Only search for orders with export status

OrderSearchArguments.exportedAt ● DateSearchInput input​

Search by export date

OrderSearchArguments.sources ● [SourceSearchInput!] list input​

List of order sources

Identifies how the order was created in the system.

Member Of​

orders query