Create Availability

Changed on Nov 4, 2026

Create a new carrier defined availability. Duplicate configuration returns 200 with created=false.

post/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

Headers

mentium-workspace-idstring nullable

Request body

shipping_method'FTL' | 'PTL' | 'LTL' | '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_week_monthly_occurrencesMentiumTmsAvailabilityDayOfWeekMonthlyOccurrence[]

days_of_monthinteger[]

notesstring nullable

Example request

{
  "days_of_month": [],
  "days_of_week": [
    "TUESDAY",
    "THURSDAY"
  ],
  "days_of_week_monthly_occurrences": [],
  "destination": {
    "country": "USA",
    "postal_code_prefix": "300"
  },
  "equipment_type": "REEFER",
  "notes": "Weekly reefer capacity from Florida to Georgia",
  "recurrence_end_at": "2026-12-31T23:59:59Z",
  "recurrence_frequency": "WEEKLY_BY_DAY_OF_WEEK",
  "recurrence_interval": 1,
  "recurrence_start_at": "2026-02-01T00:00:00Z",
  "shipping_method": "FTL",
  "source": {
    "country": "USA",
    "state": "FL"
  }
}

Response

Identical availability already exists; existing record returned (deduplicated).

createdboolean required

False when an identical availability already existed (same dedupe hash); no new row was inserted.

Example response

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

Nov 4, 2026b4ed8e59432e Revision changes
- breaking
  removed the enum value BULK_DRY_DUMP of the request property
- breaking
  removed the enum value BULK_DRY_HOPPER of the request property
- breaking
  removed the enum value BULK_DRY_PNEUMATIC of the request property
- breaking
  removed the enum value DRY_VAN of the request property
- breaking
  removed the enum value FLATBED of the request property
- breaking
  removed the enum value FLATBED_CONESTOGA of the request property
- breaking
  removed the enum value FTL of the request property
- breaking
  removed the enum value HOTSHOT of the request property
- breaking
  removed the enum value INTERMODAL of the request property
- breaking
  removed the enum value LOWBOY of the request property
- breaking
  removed the enum value LTL of the request property
- breaking
  removed the enum value MENTIUM_UNKNOWN_VALUE of the request property
- breaking
  removed the enum value MENTIUM_UNKNOWN_VALUE of the request property
- breaking
  removed the enum value POWER_ONLY of the request property
- breaking
  removed the enum value PTL of the request property
- breaking
  removed the enum value REEFER of the request property
- breaking
  removed the enum value REMOVABLE_GOOSENECK of the request property
- breaking
  removed the enum value SPRINTER of the request property
- breaking
  removed the enum value STEPDECK of the request property
- breaking
  removed the enum value STEPDECK_CONESTOGA of the request property
- breaking
  removed the enum value STRAIGHT of the request property
- breaking
  removed the enum value TANKER of the request property
- breaking
  the request property type changed from string to no type
- breaking
  the request property type changed from string to no type
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- 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
- 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 request property anyOf list
- info
  added subschema #2 to the request property anyOf list
- info
  the request property became optional
- info
  the request property became optional
- 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
  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_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_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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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
- info
  removed the TANKER enum value from the / response property for the response status

Operation history