booking_creation

A proposal given a set of criteria

Retrieves a list of proposals matching the booking criteria set as input. One best price proposal is returned per accommodation category and package id if relevant. If applicable, the field "alternative_price" is populated with another type of promotion

post/v1/proposals/search/best

Request

  • Base URL: https://api.clubmed.com
  • URL: https://api.clubmed.com/v1/proposals/search/best
  • Auth: one of:
    • OpenID Connect (https://accounts.clubmed.com/.well-known/openid-configuration, scopes: openid, email, profile, clubmed)
    • OpenID Connect (https://auth.clubmed.com/.well-known/openid-configuration, scopes: openid, email, profile, clubmed)

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
authorizationstring

Optional Access Token (bearer)

Example:Bearer aaaa.vbbbB.bbbb

Access Token (bearer)

x-api-keystring required

Api_key provided by ClubMed API team

Request body

resort_arrival_datestring date required

Arrival date in the resort (it is not the journey departure date. Supported formats: YYYY-MM-DD, YYYYMMDD, YYYYMM

durationinteger required

Number of nights into the resort.

number_attendeesinteger required

Total number of journey attendees.

product_idstring required

ClubMed Product identifier

package_idstring nullable

Package id from /products/{id}/packages

voucher_codestring nullable

Code allowing to add a voucher to the requested proposal

sales_network_idstring nullable required

Sales network id returned by the /partners/{partner_id}/sales_networks resources. Ex: OPERA_00_P2T

salesman_idstring nullable

Salesman id number

transfer_codestring

Transfer code from products/{id}/transfers resource. Ex: SAYVSY

accommodation_idsstring[]

Accommodation ids

accommodation_quantityinteger

Indicates the number of accommodations where the attendees would like to be allocated

Example request

{
  "resort_arrival_date": "2027-01-06",
  "duration": 7,
  "number_attendees": 2,
  "known_attendees_information": [
    {
      "customer_id": "",
      "birthdate": ""
    },
    {
      "customer_id": "55858",
      "birthdate": "2010-04-30"
    }
  ],
  "product_id": "MPAC",
  "flexibility": {
    "is_flexible_resort_arrival_date": true,
    "is_flexible_duration": true,
    "is_flexible_product_extension": true,
    "is_flexible_availability": true
  },
  "package_id": "PAI",
  "voucher_code": "CDDEZS",
  "sales_network_id": "OPERA_00_P2T",
  "salesman_id": "00255747",
  "transfer_code": "AGAVSY",
  "transport": {
    "departure_option_id": "PAR",
    "class": "PLANE_ECONOMY",
    "journey_type": "ROUND_TRIP"
  },
  "accommodation_ids": [
    "S5+"
  ],
  "accommodation_quantity": 2
}

Response

ok

idstring required

Proposal identifier

product_idstring required

ClubMed Product identifier

booking_idinteger nullable
package_idstring required

a package_id from /products/{product_id}/packages resource

labelstring required
resort_arrival_datestring date required

Resort arrival date. Ex: 20160117. Date format YYYYMMDD

resort_departure_datestring date required

Resort departure date. Ex: 20160123. Date format YYYYMMDD

durationinteger

Journey duration

remaining_stockinteger required

count of remaining stock. Can be usefull for stress marketing

option_availableboolean required

true if the associated booking can be created with OPTION status

localestring nullable required

Locale with ISO 639-1 language and ISO 3166-1 country

extend_persistenceboolean

if true means that the proposal will exist during 6 months (15 days if false)

auto_optionable_status'NONE' | 'SCHEDULED' | 'CONVERTED' | 'FAILED' required

Automatic Option Status: Set as NONE when the proposal is not tagged as to be converted automatically. Displayed as SCHEDULED when the proposal is tagged as to be converted automatically. CONVERTED indicates that the proposal was tagged as to be converted and has been done successfully. On the contrary, FAILED indicates that the proposal was tagged as to be converted but has failed.

is_bookableboolean required

Indicates wether the proposal can be transformed into a booking or not. Always displayed as false when attendees are not added.

creation_date_timestring date

proposal creation date time

Example response

{
  "id": "123456",
  "product_id": "MPAC",
  "booking_id": 123456,
  "package_id": "AI",
  "label": "Proposal with one club room",
  "resort_arrival_date": "2022-04-15T10:23:00.234Z",
  "resort_departure_date": "2022-04-15T10:23:00.234Z",
  "price": {
    "total": 9815.4,
    "total_without_discount": 10015.4,
    "trip": {
      "initial_price": 10000.15,
      "initial_price_with_fees": 10015.4,
      "fees": [
        {
          "type": "SUBSCRIPTION",
          "amount": 120
        }
      ]
    },
    "included_services": [
      {
        "id": "PVASKH",
        "amount": 200,
        "link": {
          "rel": "self",
          "deprecated_rel": true,
          "method": "GET",
          "href": "https://api.clubmed.com/products",
          "label": "A label"
        },
        "_links": [
          {
            "rel": "self",
            "deprecated_rel": true,
            "method": "GET",
            "href": "https://api.clubmed.com/products",
            "label": "A label"
          }
        ]
      }
    ],
    "package_options": [
      {
        "type": "CHILDCARE",
        "amount": 152.25,
        "amount_without_discount": 200
      }
    ],
    "total_without_fees": 9775.4,
    "currency": "EUR",
    "total_without_transport": 9005.4,
    "yield_pricing_variation": 50.5,
    "discounts": [
      {
        "type": "OFFER",
        "amount": 200,
        "code": "FRFAM",
        "offer_id": "TFO",
        "service_id": "PVASKH",
        "_links": [
          {
            "rel": "self",
            "deprecated_rel": true,
            "method": "GET",
            "href": "https://api.clubmed.com/products",
            "label": "A label"
          }
        ]
      }
    ],
    "is_transfer_included": true
  },
  "duration": 7,
  "alternative_price": {
    "total": 9815.4,
    "total_without_discount": 10015.4,
    "discounts": [
      {
        "type": "OFFER",
        "amount": 200,
        "offer_id": "TFO",
        "service_id": "PVASKH",
        "code": "FRFAM",
        "_links": [
          {
            "rel": "self",
            "deprecated_rel": true,
            "method": "GET",
            "href": "https://api.clubmed.com/products",
            "label": "A label"
          }
        ]
      }
    ],
    "trip": {
      "initial_price": 10000.15,
      "initial_price_with_fees": 10015.4,
      "fees": [
        {
          "type": "SUBSCRIPTION",
          "amount": 120
        }
      ]
    },
    "included_services": [
      {
        "id": "PVASKH",
        "amount": 200,
        "link": {
          "rel": "self",
          "deprecated_rel": true,
          "method": "GET",
          "href": "https://api.clubmed.com/products",
          "label": "A label"
        },
        "_links": [
          {
            "rel": "self",
            "deprecated_rel": true,
            "method": "GET",
            "href": "https://api.clubmed.com/products",
            "label": "A label"
          }
        ]
      }
    ],
    "package_options": [
      {
        "type": "CHILDCARE",
        "amount": 152.25,
        "amount_without_discount": 200
      }
    ],
    "total_without_fees": 9775.4,
    "currency": "EUR",
    "total_without_transport": 9005.4,
    "yield_pricing_variation": 50.5
  },
  "accommodations": [
    {
      "id": "C",
      "link": {
        "rel": "self",
        "deprecated_rel": true,
        "method": "GET",
        "href": "https://api.clubmed.com/products",
        "label": "A label"
      },
      "_links": [
        {
          "rel": "self",
          "deprecated_rel": true,
          "method": "GET",
          "href": "https://api.clubmed.com/products",
          "label": "A label"
        }
      ]
    }
  ],
  "remaining_stock": 2,
  "option_available": true,
  "option_durability": {
    "expiration_date_time": "20160415T10:23:00.234Z",
    "is_reliable": true
  },
  "households": [
    {
      "attendees": [
        {
          "id": "A",
          "birthdate": "20100430",
          "customer_type": "NEW_CUSTOMER"
        }
      ]
    }
  ],
  "locale": "en-US",
  "_links": [
    {
      "rel": "self",
      "deprecated_rel": true,
      "method": "GET",
      "href": "https://api.clubmed.com/products",
      "label": "A label"
    }
  ],
  "transportation_summary": [
    {
      "way": "INBOUND",
      "departure_city": "Paris",
      "arrival_city": "Denpensar",
      "transportation_type": "PLANE",
      "cancellation_policy_type": "THEO",
      "is_transfer_included": true,
      "departure_date": "20100430",
      "arrival_date": "20100430"
    }
  ],
  "auto_optionable_status": "NONE",
  "creation_date_time": "2022-04-15T10:23:00.234Z",
  "vendor": {
    "salesman_id": "00255747"
  }
}

Changes

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