Skip to main content

CarriersSearchInput

Search criteria for filtering and paginating carriers.

Provides comprehensive filtering options for carrier searches including pagination, date ranges, service types, warehouse coverage, and sorting capabilities. All filters are optional and can be combined for precise results.

input CarriersSearchInput {
  page: Int
  offset: Int
  createdAt: DateSearchInput
  names: [String!]
  types: [CarrierType!]
  ids: [Int!]
  warehouseIds: [Int!]
  lastModifiedAt: DateSearchInput
  sortInputs: [CarrierSortInput!]
}

Fields​

CarriersSearchInput.page ● Int scalar​

Page number for pagination results.

Specifies which page of results to retrieve. Used in combination with offset to control result pagination.

Validation requirements:

  • Must be a positive integer starting from 1

CarriersSearchInput.offset ● Int scalar​

Number of items per page.

Specifies how many carriers to return per page. Used in combination with page to control result pagination.

Validation requirements:

  • Must be a positive integer between 1 and 100

CarriersSearchInput.createdAt ● DateSearchInput input​

Filter carriers by creation date range.

Allows filtering carriers based on when they were created in the system.

Validation requirements:

  • Supports both greater than and less than date comparisons
  • Dates must be in ISO 8601 format (e.g., 2024-01-15T10:30:00.000Z)

CarriersSearchInput.names ● [String!] list scalar​

Filter by specific carrier names.

Allows filtering carriers by their exact names. Supports multiple names for batch filtering.

Validation requirements:

  • Names are case-sensitive and must match exactly
  • Each name cannot exceed 64 characters

CarriersSearchInput.types ● [CarrierType!] list enum​

Filter by carrier service types.

Allows filtering carriers by their service delivery methods. Supports multiple types for comprehensive filtering.

Validation requirements:

  • Each type must be unique in the array
  • Only valid CarrierType enum values are accepted

CarriersSearchInput.ids ● [Int!] list scalar​

Filter by specific carrier identifiers.

Allows filtering carriers by their unique IDs. Supports multiple IDs for batch retrieval.

Validation requirements:

  • Each ID must be a positive integer
  • Array must contain unique values only

CarriersSearchInput.warehouseIds ● [Int!] list scalar​

Filter carriers by warehouse service coverage.

Allows filtering carriers that provide services to specific warehouses. Supports multiple warehouse IDs for comprehensive coverage filtering.

Validation requirements:

  • Each ID must be a positive integer
  • Array must contain unique values only

CarriersSearchInput.lastModifiedAt ● DateSearchInput input​

Filter carriers by last modification date range.

Allows filtering carriers based on when they were last updated in the system.

Validation requirements:

  • Supports both greater than and less than date comparisons
  • Dates must be in ISO 8601 format (e.g., 2024-01-15T10:30:00.000Z)

CarriersSearchInput.sortInputs ● [CarrierSortInput!] list input​

Sorting criteria for result ordering.

Allows specifying multiple sorting fields with custom ordering directions. Results are sorted in the order specified, with each sort input containing a field and direction.

Validation requirements:

  • Each sort input must be unique
  • Field must be a valid CarrierSortField enum value
  • Order must be either ASC or DESC

Member Of​

carriers query