product_information

Products

Seasons

Club Med have some mountain resort which are open during summer and winter. Those resort provide totally different services, therefore there is a WINTER product and SUMMER product.

Example

  • Punta Cana is a permanent resort, it has one product_id: PCAC.
  • Chamonix is open during the winter and the summer, it has two product_id: CHAC_WINTER and CHAC_SUMMER.

Prices

The prices are the best prices available.

Products Pagination

The pagination is not activated by default.

Use of the Pagination

Request

You can require a paginated result with two optional parameters, to be passed in the query string:

  • limit: items per page. For example, if limit=10, any call result will contain an array of at most 10 items.
  • page: the page you want to reach. By default, page=1 and you get the first items. If there are more than limit items, you may have to repeat the call for pages 2, 3, etc...

Depending on the endpoint, pagination may be activated by default or not, with a default limit parameter.

Response

If the response is paginated, a specific HTTP status code will be sent:

206 Partial Content

The response headers will contain metadata describing the result pagination.

HeaderDescription
Accept-RangesThe type of the paginated items (example: products).
Content-RangeThe range of paginated items for the current response, on format first-last/total. Example: 0-9/256 means items 0 to 9 over a total of 256.
Link Contains the links allowing to navigate to other pages of the same request, typed by the rel. Possible types: self, prev, next, first, last.

Link examples

Link: <http://...?limit=10&page=2>; rel="self"
Link: <http://...?limit=10&page=1>; rel="prev"
Link: <http://...?limit=10&page=3>; rel="next"
Link: <http://...?limit=10&page=1>; rel="first"
Link: <http://...?limit=10&page=25>; rel="last"

The client will have to iterate over the pages, sending the same request with an increased page parameter (or following the next Link), in order to fetch the complete result.

The Content-Range header, or the lack of the next Link, indicates that the last page is reached.

get/v2/products

Request

  • Base URL: https://api.clubmed.com
  • URL: https://api.clubmed.com/v2/products
  • Auth: HTTP bearer

Query parameters

filterFilterParamModel[]

string composed of a field name (can be a path), a comparison operator (>, >=, <=, <, ==, !=) and a value. Logical operator AND applies between filters

limitinteger

Maximum rows count per page

pageinteger

Requested page number, starting from 1 (default: 1)

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

Response

ok

idstring required

Club Med product unique id

associated_product_idstring

id of product where these lodgings are near for this product

available_servicesProductLightProductAvailableServicesModel[]

Indicate availabilities of global resort services

description_titlestring

description headline"

full_titlestring required

product full title to be used outside Club Med apps

opening_status'OPEN' | 'CLOSED' | 'NOT_YET_OPEN' required

commercial status indicating if the product is OPEN, CLOSED or NOT_YET_OPEN

resort_idstring required

resort id, deprecated

seasonsProductLightSeasonsModel[]

opening seasons (SUMMER and/or WINTER)

seo_descriptionstring

description to be used for seo

sibling_idstring

id of the sibling product open another season, if relevant

titlestring required

product title

capacity_maxnumber nullable

maximum capacity of people for this product

product_lineProductLineModel[]

Define the different product lines of a Club Med product

Example response

[
  {
    "id": "CHAC_WINTER",
    "access_conditions": {
      "min_authorized_age_in_months": 24
    },
    "areas": [
      {
        "id": "area_comfort_level_5_tridents",
        "label": "5 tridents area",
        "comfort": {
          "level": 5,
          "label": "5 tridents"
        }
      }
    ],
    "associated_product_id": "VMOV_WINTER",
    "available_services": [
      "WINTER_SPORTS"
    ],
    "category": {
      "id": "product_type_sun",
      "label": "Village soleil"
    },
    "clubmed_mobile_app": {
      "is_available": true,
      "description": "description"
    },
    "easy_arrival": {
      "is_available": true,
      "description": "description"
    },
    "comfort": {
      "level": 4,
      "label": "4 tridents"
    },
    "trip_details": {
      "departure_details": {
        "country": "Guadeloupe",
        "city": "Guadeloupe",
        "date": "20100430"
      },
      "arrival_details": {
        "country": "Guadeloupe",
        "city": "Guadeloupe",
        "date": "20180102"
      },
      "duration": {
        "in_nights": 8,
        "in_days": 9
      }
    },
    "description_title": "A stay at Chamonix, to enjoy the elegance of a legendary ski resort",
    "destination": {
      "geographical_area": {
        "id": "product_geographical_area_alps",
        "label": "Alps"
      },
      "countries": [
        {
          "id": "FR",
          "label": "France",
          "description": "France in brief\n\n\n- Surface area: 632,834 sq km\n\n- Capital: Paris\n\n- Official language: French\n \n- Currency: the Euro."
        }
      ],
      "region": {
        "id": "REG_000393"
      }
    },
    "full_title": "Clubmed Chamonix Mont-Blanc",
    "media": {
      "immersive_image": "http://mypicture",
      "surroundings_images": [
        "http:myresortsurroundingpicture"
      ],
      "map": "http://mymapsurl",
      "fact_sheet_url": "https://ns.clubmed.com/icp/factsheet/Factsheet.pdf"
    },
    "opening_status": "OPEN",
    "type": {
      "id": "VILLAGE"
    },
    "price": {
      "initial_price": {
        "per_trip": 975,
        "per_trip_with_fees": 1002.5,
        "per_night": 140,
        "per_night_with_fees": 144
      },
      "best_price": {
        "per_trip": 824,
        "per_trip_with_fees": 851.5,
        "per_night": 118,
        "per_night_with_fees": 122
      },
      "fee": {
        "per_trip": 27.5,
        "per_night": 4
      },
      "currency": "EUR",
      "terms_and_conditions": {
        "price_per": "ADULT",
        "package": "ALL_INCLUSIVE",
        "departure_date": "20171115",
        "arrival_date": "20171115",
        "stay_duration": 7,
        "total_duration": 7,
        "number_of_rooms_available_for_this_comfort": 2,
        "number_of_adults": 2,
        "accomodation": {
          "id": "C",
          "label": "Club Room"
        },
        "departure_city": {
          "id": "PAR",
          "label": "Paris"
        },
        "departure_location": {
          "id": "CDG",
          "label": "Charles de Gaulle airport"
        },
        "default_price_display": "per_trip",
        "fees_included": true,
        "instalment_count": 8,
        "offers": [
          {
            "id": "EBB",
            "label": "Early Booking Bonus"
          }
        ]
      }
    },
    "resort_id": "CHAC",
    "range": {
      "id": "range_escapade",
      "label": "Escapade"
    },
    "seasons": [
      "WINTER"
    ],
    "seo_description": "Enjoy a luxury all-inclusive ski holiday in our France resort. For ski holidays, activity holidays and spa holidays, our Chamonix resort has it all.",
    "sibling_id": "CHAC_SUMMER",
    "title": "Chamonix Mont-Blanc",
    "capacity_max": 1234,
    "accommodations_introduction": {
      "short_description": "Discover the richness of North African life",
      "description": "The Resort has 249 rooms in a hotel with several wings, less than 5 minutes walking distance from the centre of Chamonix...",
      "images": [
        "http://image.jpg"
      ],
      "rooms_count": 249
    },
    "tags": [
      {
        "title": "Tag Title",
        "text_color_id": "#FFFFFF",
        "background_color_id": "#000000"
      }
    ],
    "product_line": [
      "CORE"
    ],
    "_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.