commercial_information

Search for an informative price

The search price gives the best price of one or several products with the given conditions. If only some offer_id are provided, then it will return the best price for each product available for this/those offer(s). If only some product_id are provided, then it will return the best price for each product available for this/those product(s). If product_id and offer_id are provided, then it will return the best price for each product between those offers. The prices are for the given dates or the entire season if no dates are inputed. For a given product, date and family composition, it will only be possible to obtain one price.

get/v1/search_price

Request

  • Base URL: https://api.clubmed.com
  • URL: https://api.clubmed.com/v1/search_price
  • Auth: OpenID Connect (https://auth.clubmed.com/.well-known/openid-configuration, scopes: openid, email, profile, clubmed)

Query parameters

product_idProductIdParamModel[] 
[
  "MPAC"
]
offer_idstring

Ex: EBB

durationnumber

length of stay (in days) ex: 3

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

Transport information indicating its class

with_transportboolean

Do you need a price for a stay with transport included or not? ex:true

departure_option_idstring

The departure option id from product/id booking criteria. Ex: PAR

Example:PAR
number_attendeesinteger

Total number of journey attendees.

Example:2
birthdatesstring[]

List of birthdate of kids. Supported formats: YYYY-MM-DD, YYYYMMDD, YYYYMM

[
  "2022-04-15"
]
first_datestring date

First date of departure. Must be after the current date. Supported formats: YYYY-MM-DD, YYYYMMDD, YYYYMM

Example:2022-04-15
last_datestring date

Last date of departure. The date must be after to the first date. Supported formats: YYYY-MM-DD, YYYYMMDD, YYYYMM

Example:2022-04-15
flexible_resort_arrival_dateboolean

Allow to check other arrival dates if we can't find a proposal for the given parameters (false by default)

Example:true
flexible_durationboolean

Allow to check other durations if we can't find a proposal for the given parameters (false by default)

Example:true
sales_network_idstring nullable

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

Example:OPERA_00_P2T
accommodation_classification'EXCLUSIVE_COLLECTION'

list of predefined accommodations for each product_id

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
x-api-keystring required

Api_key provided by ClubMed API team

Response

ok

product_idstring required

ClubMed Product identifier

Example response

[
  {
    "product_id": "MPAC",
    "terms_and_conditions": {
      "departure_city": {
        "id": "PAR",
        "label": "Paris"
      },
      "departure_location": {
        "id": "CDG",
        "label": "Charles de Gaulle airport"
      },
      "departure_date": "2016-01-25",
      "arrival_date": "2016-01-25",
      "duration": 7,
      "transport_duration_in_min": 745,
      "total_duration": 7,
      "adults_count": 2,
      "package": "AI",
      "accommodations": [
        {
          "id": "C2",
          "label": "Chambre Club",
          "_links": [
            {
              "rel": "self",
              "deprecated_rel": true,
              "method": "GET",
              "href": "https://api.clubmed.com/products",
              "label": "A label"
            }
          ]
        }
      ],
      "offers": [
        {
          "id": "EBB",
          "label": "Early Booking Bonus",
          "_links": [
            {
              "rel": "self",
              "deprecated_rel": true,
              "method": "GET",
              "href": "https://api.clubmed.com/products",
              "label": "A label"
            }
          ]
        }
      ],
      "default_price_display": "per_trip",
      "fees_included": true,
      "instalment_count": 8,
      "_links": [
        {
          "rel": "self",
          "deprecated_rel": true,
          "method": "GET",
          "href": "https://api.clubmed.com/products",
          "label": "A label"
        }
      ],
      "flights_connection_count": {
        "inbound": 1
      }
    },
    "price": {
      "currency": "EUR",
      "yield_pricing_variation": 50.5
    },
    "no_price_reason": {
      "code": "NO_FLIGHT",
      "description": "No flight available"
    },
    "_links": [
      {
        "rel": "self",
        "deprecated_rel": true,
        "method": "GET",
        "href": "https://api.clubmed.com/products",
        "label": "A label"
      }
    ]
  }
]

Changes

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