Skip to main content

OrderStatusesSearchInput

Search criteria and filters for retrieving order statuses with pagination support

input OrderStatusesSearchInput {
  page: Int = 1
  offset: Int = 12
  ids: [Int!]
  codes: [String!]
  name: String
  priority: Int
  type: String
  orderType: String
  createdAt: DateSearchInput
  lastModifiedAt: DateSearchInput
  isDefault: Boolean
  isPublic: Boolean
  isEditable: Boolean
  isDeletable: Boolean
  sortInputs: [OrderStatusSortInput!]
}

Fields​

OrderStatusesSearchInput.page ● Int scalar​

Page number for pagination, starting from 1.

Used to navigate through multiple pages of results when the total number of order statuses exceeds the offset limit. Defaults to 1.

OrderStatusesSearchInput.offset ● Int scalar​

Number of order statuses to return per page.

Controls the size of each page in the paginated response to manage data volume and performance. Must be between 1 and 100. Defaults to 12.

OrderStatusesSearchInput.ids ● [Int!] list scalar​

List of order status ids

OrderStatusesSearchInput.codes ● [String!] list scalar​

List of order status codes

OrderStatusesSearchInput.name ● String scalar​

Filter by order status name using partial text matching.

Supports case-insensitive search to find order statuses with names containing the specified text, useful for finding specific workflow states.

OrderStatusesSearchInput.priority ● Int scalar​

Filter by priority value for workflow ordering.

Searches for order statuses with the specified priority level. Lower numbers indicate higher priority in workflow displays and processing sequences.

OrderStatusesSearchInput.type ● String scalar​

Filter by order status type classification.

SYSTEM types are built-in platform statuses that cannot be modified, while CUSTOM types are user-defined statuses for specific business workflows.

OrderStatusesSearchInput.orderType ● String scalar​

Filter by the type of orders this status applies to.

Determines which business processes can use this status: quotations for price quotes, orders for confirmed purchases, or requests for special inquiries.

OrderStatusesSearchInput.createdAt ● DateSearchInput input​

Filter by creation date range.

Allows searching for order statuses created within a specific date range using greater than, less than, or between date criteria.

OrderStatusesSearchInput.lastModifiedAt ● DateSearchInput input​

Filter by last modification date range.

Allows searching for order statuses modified within a specific date range using greater than, less than, or between date criteria.

OrderStatusesSearchInput.isDefault ● Boolean scalar​

Filter by default status flag.

When true, returns only statuses marked as default for new orders. When false, returns only non-default statuses.

OrderStatusesSearchInput.isPublic ● Boolean scalar​

Filter by public visibility flag.

OrderStatusesSearchInput.isEditable ● Boolean scalar​

Filter by editable flag.

When true, returns only statuses that can be modified. When false, returns only locked statuses that cannot be changed.

OrderStatusesSearchInput.isDeletable ● Boolean scalar​

Filter by deletable flag.

When true, returns only statuses that can be removed. When false, returns only protected statuses that cannot be deleted.

OrderStatusesSearchInput.sortInputs ● [OrderStatusSortInput!] list input​

Sorting configuration for the search results.

Allows multiple sort criteria to be applied in order of priority. Each sort input specifies a field and direction for ordering the results.

Member Of​

orderStatuses query