MEmentium
v2
tms
v2
tms
lanes

Get Lane

Changed on

Get a single carrier defined lane by ID

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

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
lane_idstring required

Query parameters

integration_connection_idstring required

Headers

mentium-workspace-idstring nullable

Response

Successful Response

idstring uuid nullable
organization_idstring uuid required
integration_connection_idstring uuid required
carrier_idstring uuid nullable
lane_hashstring 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'
preference_level'PREFERRED' | 'PRIMARY' | 'SECONDARY' | 'BACKUP' | 'EXCLUDED' required
target_line_haul_ratenumber nullable
target_fuel_surcharge_ratenumber nullable
notesstring nullable
automation_enabledboolean
is_contractboolean
contract_status'DRAFT' | 'ACTIVE' | 'PAUSED' | 'EXPIRED'
contract_effective_atstring date-time nullable
contract_expires_atstring date-time nullable
contract_notesstring nullable
data_originsMentiumTmsDataOrigin[]

Example response

{
  "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
  }
}

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