MEmentium
v2
tms
v2
tms
lanes

List Lanes

Changed on

List carrier defined lanes with optional filters

get/v2/tms/carriers/{carrier_id}/lanes

Request

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

Path parameters

carrier_idstring required

Query parameters

integration_connection_idstring required
shipping_method'FTL' | 'PTL' | 'LTL' | 'MENTIUM_UNKNOWN_VALUE'
equipment_type'DRY_VAN' | 'REEFER' | 'FLATBED' | 'FLATBED_CONESTOGA' | 'STEPDECK' | 'STEPDECK_CONESTOGA' | 'LOWBOY' | 'REMOVABLE_GOOSENECK' | 'BULK_DRY_HOPPER' | 'BULK_DRY_PNEUMATIC' | 'BULK_DRY_DUMP' | 'TANKER' | 'INTERMODAL' | 'STRAIGHT' | 'SPRINTER' | 'HOTSHOT' | 'POWER_ONLY' | 'MENTIUM_UNKNOWN_VALUE'
preference_level'PREFERRED' | 'PRIMARY' | 'SECONDARY' | 'BACKUP' | 'EXCLUDED'
limitinteger
offsetinteger
sort_by'mentium_created_at' | 'mentium_updated_at'
sort_order'asc' | 'desc'

Headers

mentium-workspace-idstring nullable

Response

Successful Response

total_countinteger required
has_moreboolean required

Example response

{
  "has_more": true,
  "lanes": [
    {
      "automation_enabled": true,
      "carrier_id": "carrier-789",
      "contract_effective_at": "2024-01-01T00:00:00Z",
      "contract_expires_at": "2024-12-31T23:59:59Z",
      "contract_notes": "Annual contract with preferred carrier",
      "contract_status": "ACTIVE",
      "destination": {
        "city": "Los Angeles",
        "country": "USA",
        "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": true,
      "notes": "Preferred lane with consistent backhaul opportunities",
      "organization_id": "org-123",
      "preference_level": "PREFERRED",
      "shipping_method": "FTL",
      "source": {
        "city": "Chicago",
        "country": "USA",
        "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
    },
    {
      "automation_enabled": false,
      "carrier_id": "carrier-789",
      "destination": {
        "country": "USA",
        "state": "FL"
      },
      "equipment_type": "FLATBED",
      "id": "223e4567-e89b-12d3-a456-426614174001",
      "integration_connection_id": "int-456",
      "is_contract": false,
      "notes": "Seasonal lane for construction materials",
      "organization_id": "org-123",
      "preference_level": "SECONDARY",
      "shipping_method": "FTL",
      "source": {
        "country": "USA",
        "postal_code_prefix": "600"
      },
      "target_fuel_surcharge_rate": 300,
      "target_line_haul_rate": 2200
    }
  ],
  "total_count": 47
}

Changes

  • b4ed8e59432eRevision changes
    • 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

    • 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_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 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_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 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 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 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 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 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 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 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