MEmentium
v2
tms
v2
tms
historical_lanes

List Historical Lanes

List carrier historical lanes based on optional filters

get/v2/tms/carriers/{carrier_id}/historical-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
source_citystring nullable
source_statestring nullable
source_countrystring nullable
source_postal_codestring nullable
source_postal_code_prefixstring nullable
source_latitudenumber nullable
source_longitudenumber nullable
source_radius_milesnumber nullable
destination_citystring nullable
destination_statestring nullable
destination_countrystring nullable
destination_postal_codestring nullable
destination_postal_code_prefixstring nullable
destination_latitudenumber nullable
destination_longitudenumber nullable
destination_radius_milesnumber nullable
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'
min_total_loadsinteger nullable
limitinteger
offsetinteger
sort_by'total_loads'
sort_order'asc' | 'desc'

Headers

mentium-workspace-idstring nullable

Response

Successful Response

total_countinteger required
has_moreboolean required

Example response

{
  "has_more": true,
  "historical_lanes": [
    {
      "carrier_id": "carrier-789",
      "destination": {
        "city": "Los Angeles",
        "country": "USA",
        "state": "CA"
      },
      "equipment_type": "DRY_VAN",
      "integration_connection_id": "int-456",
      "organization_id": "org-123",
      "shipping_method": "FTL",
      "source": {
        "city": "Chicago",
        "country": "USA",
        "state": "IL"
      },
      "total_loads": 100
    }
  ],
  "total_count": 100
}

Changes

No recorded changes to this operation across all 2 revisions of this API.