booking_creation

Retrieves proposal's applied transportation in addition to alternative ones

post/v1/proposals/{proposal_id}/available_transports

Request

  • Base URL: https://api.clubmed.com
  • URL: https://api.clubmed.com/v1/proposals/{proposal_id}/available_transports
  • Auth: HTTP bearer

Path parameters

proposal_idstring required

Proposal identifier

Example:123456

Headers

accept-language'fr-FR' | 'fr-BE' | 'nl-BE' | 'de-CH' | 'fr-CH' | 'en-CH' | 'nl-NL' | 'de-DE' | 'en-IL' | 'he-IL' | 'it-IT' | 'en-SE' | 'pt-PT' | 'en-ZA' | 'es-ES' | 'en-GB' | 'en-CY' | 'tr-TR' | 'ru-RU' | 'uk-UA' | 'en-DK' | 'en-FI' | 'en-NO' | 'en-IE' | 'en-US' | 'es-MX' | 'fr-CA' | 'en-CA' | 'es-PA' | 'es-AR' | 'es-CL' | 'pt-BR' | 'es-CO' | 'es-PE' | 'es-VE' | 'es-UY' | 'en-CN' | 'zh-CN' | 'zh-TW' | 'en-TW' | 'en-HK' | 'zh-HK' | 'en-AU' | 'en-ID' | 'id-ID' | 'en-IN' | 'ja-JP' | 'ko-KR' | 'en-MY' | 'en-NZ' | 'en-SG' | 'en-TH' | 'vn-VN' | 'de-AT' | 'ro-RO' | 'pl-PL' | 'et-EE' | 'lv-LV' | 'en-LB' | 'fr-MA' | 'se-SE' | 'th-TH' | 'en-JP' | 'en-AF' | 'en-AL' | 'fr-DZ' | 'fr-AD' | 'en-AO' | 'en-AG' | 'en-SA' | 'en-AM' | 'en-BS' | 'en-BH' | 'en-BD' | 'en-BB' | 'en-BZ' | 'en-BJ' | 'en-BM' | 'en-BT' | 'en-MM' | 'es-BO' | 'es-BW' | 'en-BN' | 'en-BG' | 'en-BI' | 'en-BF' | 'en-CM' | 'fr-CV' | 'en-KY' | 'fr-CF' | 'en-SH' | 'en-CO' | 'en-KM' | 'fr-CG' | 'en-KR' | 'en-KP' | 'en-CR' | 'fr-CI' | 'en-CU' | 'en-DJ' | 'en-DO' | 'en-DM' | 'en-EG' | 'en-SV' | 'en-AE' | 'en-EC' | 'fr-ET' | 'en-FJ' | 'en-GA' | 'en-GM' | 'en-GH' | 'en-GI' | 'gr-GR' | 'en-GD' | 'en-GT' | 'en-GN' | 'fr-GW' | 'en-GQ' | 'en-GY' | 'fr-GP' | 'fr-GF' | 'en-HT' | 'en-HN' | 'en-HU' | 'fr-IQ' | 'en-IR' | 'en-IS' | 'fr-TL' | 'en-JM' | 'en-JO' | 'en-KZ' | 'en-KH' | 'en-KE' | 'fr-KI' | 'en-KW' | 'en-LA' | 'fr-LS' | 'en-LR' | 'en-LY' | 'en-LI' | 'fr-LU' | 'en-MO' | 'en-MG' | 'en-MW' | 'en-MV' | 'en-ML' | 'en-MT' | 'ma-MA' | 'en-MU' | 'en-MR' | 'en-YT' | 'fr-MC' | 'en-MN' | 'fr-MQ' | 'en-MZ' | 'en-MD' | 'fr-PS' | 'en-NA' | 'fr-NR' | 'en-NP' | 'en-NI' | 'en-NE' | 'en-NG' | 'en-NC' | 'fr-CK' | 'en-OM' | 'en-UG' | 'en-PK' | 'en-PA' | 'en-PG' | 'es-PY' | 'en-PH' | 'fr-PN' | 'fr-PF' | 'en-PR' | 'en-QA' | 'en-RW' | 'fr-RE' | 'fr-BL' | 'en-KN' | 'en-MF' | 'en-LC' | 'en-SM' | 'fr-PM' | 'fr-VC' | 'fr-SB' | 'en-WS' | 'fr-ST' | 'en-SN' | 'en-SC' | 'fr-SL' | 'fr-SO' | 'fr-SD' | 'en-LK' | 'en-SR' | 'en-SZ' | 'en-SY' | 'en-TZ' | 'en-TD' | 'en-CZ' | 'fr-IO' | 'fr-TF' | 'en-TG' | 'fr-TO' | 'en-TT' | 'tu-TN' | 'en-TC' | 'fr-TV' | 'fr-LB' | 'en-VU' | 'fr-VA' | 'en-VG' | 'en-VN' | 'en-WF' | 'en-YE' | 'fr-YE' | 'en-RS' | 'fr-CD' | 'fr-ZM' | 'en-ZW' | 'fr-ME' | 'fr-FM' | 'fr-MH' | 'fr-PW' | 'en-HR' | 'en-SI' | 'en-SK' | 'en-EE' | 'en-LT' | 'en-LV' | 'en-MK' | 'en-BA' | 'en-UZ' | 'en-BY' | 'fr-TJ' | 'en-GE' | 'en-AZ' | 'es-DO' | 'fr-TM' | 'fr-TN' | 'sk-SK' required

Language/Country, as returned by <code>GET /v0/locales</code> ; e.g. "en-US", "fr-FR", "ja-JP"

Example:fr-FR
x-api-keystring required

Api_key provided by ClubMed API team

Request body

transport_class'PLANE_ECONOMY' | 'PLANE_ECONOMY_PLUS' | 'PLANE_BUSINESS' | 'PLANE_PREMIUM' | 'PLANE_FIRST' | 'TRAIN_FIRST' | 'TRAIN_SECOND'

Transport information indicating its class

is_direct_flight_onlyboolean

Indicates if the proposal"s default transportation is a direct flight only

max_connectionsnumber nullable

Indicates the proposal"s max connections

is_cabin_mixing_allowedboolean

Indicates if cabin mixing is allowed or not

is_companies_mixing_allowedboolean

Indicates if flight companies mixing is allowed or not

imposed_companiesstring[]

Indicates the list of imposed companies

imposed_connection_citiesstring[]

Indicates the list of imposed connection cities

excluded_companiesstring[]

Indicates the list of excluded companies

excluded_connection_citiesstring[]

Indicates the list of excluded connection cities

Example request

{
  "journeys": [
    {
      "travel_sections": [
        {
          "departure": {
            "city": {
              "id": "PAR",
              "label": "PARIS"
            },
            "location": {
              "id": "CDG",
              "label": "PARIS-ROISSY CDG",
              "terminal_code": "2A"
            },
            "date": "2022-04-15",
            "time": "17:00:00"
          },
          "arrival": {
            "city": {
              "id": "PAR",
              "label": "PARIS"
            },
            "location": {
              "id": "CDG",
              "label": "PARIS-ROISSY CDG",
              "terminal_code": "2A"
            },
            "date": "2022-04-15",
            "time": "17:00:00"
          }
        }
      ]
    }
  ],
  "transport_class": "PLANE_ECONOMY",
  "is_direct_flight_only": true,
  "max_connections": 2,
  "transport_connection_duration": {
    "min": 60,
    "max": 120
  },
  "is_transport_stations_changes_allowed": {
    "on_connection": true
  },
  "is_companies_mixing_allowed": true,
  "imposed_companies": [
    "AF"
  ],
  "imposed_connection_cities": [
    "PAR"
  ],
  "excluded_companies": [
    "RA"
  ],
  "excluded_connection_cities": [
    "HAM"
  ]
}

Response

ok

idstring required

Alternative transport ID

is_applied_transportationboolean

indicates if the retrieved transport is the one which is already applied to the proposal or not

time_validity_limitstring date nullable

Date and time until which the proposed transport is valid. If null, the transport may or may not expire but the time validity is unknown Supported formats: YYYYMMDDTHH:mm:ss.SSS[Z], YYYYMMDDTHH:mm:ss.SSS, YYYYMMDD HH:mm:ss.SSS, YYYYMMDDTHH:mm:ss, YYYYMMDD HH:mm:ss, YYYY-MM-DDTHH:mm:ss.SSS, YYYY-MM-DD HH:mm:ss.SSS, YYYY-MM-DD HH:mm:ss, YYYY-MM-DDTHH:mm:ss, YYYY-MM-DDTHH:mm:ss.SSSSSSS, YYYY-MM-DD HH:mm:ss.SSSSSSS, YYYY-MM-DDTHH:mm:ssZ, YYYY-MM-DD HH:mm:ssZ, YYYY-MM-DDTHH:mm:ss.SSSZ, YYYY-MM-DDTHH:mm:ss.SSS[Z], YYYY-MM-DD HH:mm:ss.SSS[Z], YYYY-MM-DD HH:mm:ss[Z]

Changes

No recorded changes to this operation across all 1 revision of this API.