MEmentium
v2
tms
v2
tms
availabilities

Get Availability

Changed on

Get a single carrier defined availability by ID

get/v2/tms/carriers/{carrier_id}/availabilities/{availability_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
availability_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
availability_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'
recurrence_frequency'ONCE' | 'DAILY' | 'WEEKLY_BY_DAY_OF_WEEK' | 'MONTHLY_BY_DAY_OF_MONTH' | 'MONTHLY_BY_DAY_OF_WEEK_MONTHLY_OCCURRENCE' required
recurrence_intervalinteger nullable
recurrence_start_atstring date-time required
recurrence_end_atstring date-time nullable
days_of_weekMentiumTmsAvailabilityDayOfWeek[]
days_of_monthinteger[]
days_of_week_monthly_occurrencesMentiumTmsAvailabilityDayOfWeekMonthlyOccurrence[]
notesstring nullable
data_originsMentiumTmsDataOrigin[]
created_by_kind'USER' | 'SYSTEM'
created_by_user_idstring uuid nullable
created_by_first_namestring nullable
created_by_last_namestring nullable
created_by_emailstring nullable

Example response

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

  • 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