MEmentium
v2
tms
v2
tms
availabilities

List Availabilities

Changed on

List carrier defined availabilities with optional filters

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

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'
recurrence_frequency'ONCE' | 'DAILY' | 'WEEKLY_BY_DAY_OF_WEEK' | 'MONTHLY_BY_DAY_OF_MONTH' | 'MONTHLY_BY_DAY_OF_WEEK_MONTHLY_OCCURRENCE'
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

{
  "availabilities": [
    {
      "carrier_id": "carrier-789",
      "days_of_month": [],
      "days_of_week": [],
      "days_of_week_monthly_occurrences": [],
      "destination": {
        "city": "Atlanta",
        "country": "USA",
        "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",
      "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": "USA",
        "latitude": 32.7767,
        "longitude": -96.797,
        "postal_code": "75201",
        "postal_code_prefix": "752",
        "radius_miles": 100,
        "state": "TX"
      }
    },
    {
      "carrier_id": "carrier-789",
      "days_of_month": [],
      "days_of_week": [
        "MONDAY",
        "WEDNESDAY",
        "FRIDAY"
      ],
      "days_of_week_monthly_occurrences": [],
      "destination": {
        "country": "USA",
        "state": "OR"
      },
      "equipment_type": "REEFER",
      "id": "223e4567-e89b-12d3-a456-426614174001",
      "integration_connection_id": "int-456",
      "notes": "Weekly produce route",
      "organization_id": "org-123",
      "recurrence_end_at": "2026-12-31T23:59:59Z",
      "recurrence_frequency": "WEEKLY_BY_DAY_OF_WEEK",
      "recurrence_interval": 2,
      "recurrence_start_at": "2026-01-05T00:00:00Z",
      "shipping_method": "FTL",
      "source": {
        "country": "USA",
        "state": "CA"
      }
    }
  ],
  "has_more": true,
  "total_count": 27
}

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