Skip to main content

carriers

Search and retrieve shipping carriers with comprehensive filtering and pagination.

Provides flexible search capabilities across carrier data including names, service types, warehouse coverage, and operational status. Results are paginated and can be filtered based on various carrier criteria including creation dates, modification dates, and service types.

Possible errors:

  • CARRIERS_LIST_ERROR: Failed to retrieve carriers from data source due to query execution failure or connection issues
carriers(
  input: CarriersSearchInput
): CarriersResponse!

Arguments​

carriers.input ● CarriersSearchInput input​

Search criteria for filtering and paginating carriers.

If not provided, returns all accessible carriers with default pagination settings (page 1, 12 items per page). Supports filtering by carrier names, service types, warehouse coverage, creation dates, and modification dates. Results can be sorted by multiple fields with custom ordering.

Type​

CarriersResponse object​

Paginated response containing carrier search results.

Provides a structured response for carrier search operations including the matching carriers, pagination metadata, and result statistics. Used to deliver carrier data with comprehensive pagination support.