tms

Get Recommended Carriers For Load From Carrier Pool

Changed on Nov 4, 2026

Get recommended carriers for load from the Carrier Pool, scored in its own pass; a non-participant gets an empty list.

post/v2/tms/carrier-recommendation/get-recommended-carriers-for-load-from-carrier-pool

Request

Base URL
https://api.mentium.io (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer

Headers

mentium-workspace-idstring nullable

Request body

integration_connection_idstring uuid required

load_idstring uuid nullable

load_external_reference_idstring nullable

limitinteger

Response

Successful Response

warningsstring[]

Example response

{
  "recommended_carriers": [
    {
      "carrier_defined_lanes": [
        {
          "description": "Preferred lane from Chicago to Los Angeles",
          "value": {
            "automation_enabled": false,
            "carrier_id": "carrier-789",
            "data_origins": [
              "MENTIUM"
            ],
            "destination": {
              "city": "Los Angeles",
              "country": "US",
              "latitude": 34.0522,
              "longitude": -118.2437,
              "postal_code": "90001",
              "postal_code_prefix": "900",
              "radius_miles": 75,
              "state": "CA"
            },
            "equipment_type": "DRY_VAN",
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "integration_connection_id": "int-456",
            "is_contract": false,
            "notes": "Preferred lane with consistent backhaul opportunities",
            "organization_id": "org-123",
            "preference_level": "PREFERRED",
            "shipping_method": "FTL",
            "source": {
              "city": "Chicago",
              "country": "US",
              "latitude": 41.8781,
              "longitude": -87.6298,
              "postal_code": "60601",
              "postal_code_prefix": "606",
              "radius_miles": 50,
              "state": "IL"
            },
            "target_fuel_surcharge_rate": 350,
            "target_line_haul_rate": 2500
          }
        }
      ],
      "carrier_defined_availabilities": [
        {
          "description": "ONCE - Single specific date availability",
          "value": {
            "carrier_id": "carrier-789",
            "data_origins": [
              "MENTIUM"
            ],
            "days_of_month": [],
            "days_of_week": [],
            "days_of_week_monthly_occurrences": [],
            "destination": {
              "city": "Atlanta",
              "country": "US",
              "latitude": 33.749,
              "longitude": -84.388,
              "postal_code": "30303",
              "postal_code_prefix": "303",
              "radius_miles": 75,
              "state": "GA"
            },
            "equipment_type": "DRY_VAN",
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "integration_connection_id": "int-456",
            "notes": "One-time backhaul opportunity after conference",
            "organization_id": "org-123",
            "recurrence_end_at": "2026-01-15T00:00:00Z",
            "recurrence_frequency": "ONCE",
            "recurrence_start_at": "2026-01-15T00:00:00Z",
            "shipping_method": "FTL",
            "source": {
              "city": "Dallas",
              "country": "US",
              "latitude": 32.7767,
              "longitude": -96.797,
              "postal_code": "75201",
              "postal_code_prefix": "752",
              "radius_miles": 100,
              "state": "TX"
            }
          }
        }
      ]
    }
  ]
}

Changes

Nov 4, 2026b4ed8e59432e Revision changes
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the response property //// became optional for the status
- breaking
  the //// response's property type changed from string to no type for status
- breaking
  the //// response's property type changed from string to no type for status
- breaking
  the //// response's property type changed from string to no type for status
- breaking
  the //// response's property type changed from string to no type for status
- info
  added subschema #2 to the //// response property anyOf list for the response status
- info
  added subschema #2 to the //// response property anyOf list for the response status
- info
  added subschema #2 to the //// response property anyOf list for the response status
- info
  added subschema #2 to the //// response property anyOf list for the response status
- info
  removed the BULK_DRY_DUMP enum value from the //// response property for the response status
- info
  removed the BULK_DRY_DUMP enum value from the //// response property for the response status
- info
  removed the BULK_DRY_HOPPER enum value from the //// response property for the response status
- info
  removed the BULK_DRY_HOPPER enum value from the //// response property for the response status
- info
  removed the BULK_DRY_PNEUMATIC enum value from the //// response property for the response status
- info
  removed the BULK_DRY_PNEUMATIC enum value from the //// response property for the response status
- info
  removed the DRY_VAN enum value from the //// response property for the response status
- info
  removed the DRY_VAN enum value from the //// response property for the response status
- info
  removed the FLATBED enum value from the //// response property for the response status
- info
  removed the FLATBED enum value from the //// response property for the response status
- info
  removed the FLATBED_CONESTOGA enum value from the //// response property for the response status
- info
  removed the FLATBED_CONESTOGA enum value from the //// response property for the response status
- info
  removed the FTL enum value from the //// response property for the response status
- info
  removed the FTL enum value from the //// response property for the response status
- info
  removed the HOTSHOT enum value from the //// response property for the response status
- info
  removed the HOTSHOT enum value from the //// response property for the response status
- info
  removed the INTERMODAL enum value from the //// response property for the response status
- info
  removed the INTERMODAL enum value from the //// response property for the response status
- info
  removed the LOWBOY enum value from the //// response property for the response status
- info
  removed the LOWBOY enum value from the //// response property for the response status
- info
  removed the LTL enum value from the //// response property for the response status
- info
  removed the LTL enum value from the //// response property for the response status
- info
  removed the MENTIUM_UNKNOWN_VALUE enum value from the //// response property for the response status
- info
  removed the MENTIUM_UNKNOWN_VALUE enum value from the //// response property for the response status
- info
  removed the MENTIUM_UNKNOWN_VALUE enum value from the //// response property for the response status
- info
  removed the MENTIUM_UNKNOWN_VALUE enum value from the //// response property for the response status
- info
  removed the POWER_ONLY enum value from the //// response property for the response status
- info
  removed the POWER_ONLY enum value from the //// response property for the response status
- info
  removed the PTL enum value from the //// response property for the response status
- info
  removed the PTL enum value from the //// response property for the response status
- info
  removed the REEFER enum value from the //// response property for the response status
- info
  removed the REEFER enum value from the //// response property for the response status
- info
  removed the REMOVABLE_GOOSENECK enum value from the //// response property for the response status
- info
  removed the REMOVABLE_GOOSENECK enum value from the //// response property for the response status
- info
  removed the SPRINTER enum value from the //// response property for the response status
- info
  removed the SPRINTER enum value from the //// response property for the response status
- info
  removed the STEPDECK enum value from the //// response property for the response status
- info
  removed the STEPDECK enum value from the //// response property for the response status
- info
  removed the STEPDECK_CONESTOGA enum value from the //// response property for the response status
- info
  removed the STEPDECK_CONESTOGA enum value from the //// response property for the response status
- info
  removed the STRAIGHT enum value from the //// response property for the response status
- info
  removed the STRAIGHT enum value from the //// response property for the response status
- info
  removed the TANKER enum value from the //// response property for the response status
- info
  removed the TANKER enum value from the //// response property for the response status

Operation history