Skip to main content

ShipmentSearchInput

Comprehensive search criteria for filtering shipments with pagination and sorting capabilities.

Supports filtering by shipment identifiers, order references, delivery dates, status, and other shipment attributes. Extends pagination and sorting functionality for efficient shipment retrieval in warehouse and logistics operations.

All filter fields support multiple values and are combined with OR logic within each field, and AND logic between different fields for precise shipment selection.

input ShipmentSearchInput {
  page: Int!
  offset: Int!
  createdAt: DateSearchInput
  lastModifiedAt: DateSearchInput
  sortInputs: [ShipmentSortInput!]
  expectedDeliveryAt: DateSearchInput
  ids: [String!]
  orderIds: [Int!]
  statuses: [ShipmentStatus!]
}

Fields

`ShipmentSearchInput.page` ● `Int!` non-null scalar

Pagination page number

`ShipmentSearchInput.offset` ● `Int!` non-null scalar

Pagination offset number

`ShipmentSearchInput.createdAt` ● `DateSearchInput` input

Search by date created

`ShipmentSearchInput.lastModifiedAt` ● `DateSearchInput` input

Search by date changed

`ShipmentSearchInput.sortInputs` ● `[ShipmentSortInput!]` list input

Inputs to sort by

`ShipmentSearchInput.expectedDeliveryAt` ● `DateSearchInput` input

Filter by expected delivery date range.

Returns shipments with delivery dates within the specified time period. Useful for delivery planning and customer communication.

`ShipmentSearchInput.ids` ● `[String!]` list scalar

Filter by specific shipment identifiers.

Returns only shipments matching the provided UUID list. Useful for retrieving specific shipments by their unique identifiers.

`ShipmentSearchInput.orderIds` ● `[Int!]` list scalar

Filter by parent order identifiers.

Returns shipments associated with the specified orders. Essential for order-based shipment tracking and customer service.

`ShipmentSearchInput.statuses` ● `[ShipmentStatus!]` list enum

Available shipment status values for filtering.

Provides the complete list of valid shipment statuses that can be used in search operations.

Member Of

shipments query