product_information

Retrieve all the accommodations of a specific product

get/v2/products/{product_id}/accommodations

Request

  • Base URL: https://api.clubmed.com
  • URL: https://api.clubmed.com/v2/products/{product_id}/accommodations
  • Auth: HTTP bearer

Path parameters

product_idstring required

ClubMed Product identifier

Example:MPAC

Query parameters

stay_datestring nullable

Date of the stay

Example:20100430
filterFilterParamModel[]

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

sortstring

field or path to sort on, optionally followed by :order (asc or desc, default is asc). Ex: best_price.per_trip:desc

Example:best_price.per_trip:asc
date_format'ISO' | 'LEGACY'

Switch the date format returned by our API on the current route. (LEGACY: YYYYMMDDTHH:mm:ss.SSS, ISO: YYYY-MM-DDTHH:mm:ss.SSS[Z])

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

code from products resource

labelstring required

short description

exclusive_collectionboolean

define if the room is related to an Exclusive Collection space

descriptionstring required

details

seller_descriptionstring

sellers oriented description of the accommodation

ranking'VERY_LOW' | 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY_HIGH' required

importance of this accommodation between all accommodations of this product

connecting_roomboolean nullable required

true if the accommodation is composed of communicating rooms

family_roomboolean nullable required

true if the room is suitable for families

reduced_mobility_accessboolean nullable required

reduced mobility access

total_stocknumber nullable required

total stock

imagesstring[] required
plansstring[]

Example response

[
  {
    "id": "A2",
    "label": "Club room",
    "exclusive_collection": true,
    "description": "Open onto the gardens and common walkways, the CLub room is comfortable and elegant. <br> Ideal for a couple or family with one child",
    "seller_description": "Cette Villa d'une surface construite de 340 m², dont 180 m² climatisés, est située sur un terrain privatif de 1590 à 2300 m² pouvant accueillir jusqu'à 6 personnes* dont 4 adultes*, offre un hébergement intime et spacieux : une chambre Prestige de 48 m² avec dressing, une salle de bain avec baignoire et douche, et une chambre Confort de 32 m² avec salle d'eau privative. Vous trouverez également une cuisine entièrement équipée de 10 m², un salon et une salle à manger de 69 m². A l'extérieur un jardin arboré qui comprend une véranda mauricienne, véritable pièce à vivre extérieure de 40 m² ainsi qu'une piscine privative à débordement de 35 m² pour des moments calmes et privilégiés. * Lit bébé offert dans la chambre Prestige et possibilité de lit gigogne dans la chambre Confort pour un enfant jusqu'à 11 ans. Occupation1 entre 31 m2 et 31 m2 / 333 sq feet et 333 sq feet 1 Banquette(s) 0.80 x 1.90m, 2 Lit(s) 1 x 2m zippable(s)",
    "area": {
      "min": 39,
      "max": 39,
      "unit": "m²"
    },
    "ranking": "HIGH",
    "comfort_type": {
      "id": "comfort_type_club",
      "label": "Club"
    },
    "connecting_room": true,
    "family_room": true,
    "reduced_mobility_access": true,
    "total_stock": 25,
    "business_social_responsibilities": [
      {
        "id": "MAT_000002",
        "label": "Hair-dryer",
        "ranking": "HIGH"
      }
    ],
    "view": {
      "id": "garden_view",
      "label": "Garden View"
    },
    "accommodation_categories": [
      {
        "id": "000021",
        "label": "5-Trident Luxury Space Deluxe"
      }
    ],
    "opening_dates": [
      {
        "opening": "20100430",
        "closing": "20100430"
      }
    ],
    "capacity": {
      "min": 1,
      "max": 4
    },
    "strengths": [
      {
        "id": "furnished_balcony",
        "label": "Furnished balcony"
      }
    ],
    "equipments": [
      {
        "id": "MAT_000002",
        "label": "Hair-dryer",
        "ranking": "HIGH"
      }
    ],
    "services": [
      {
        "id": "MST_ACT_SERLGT_000311",
        "label": "Bottle of water",
        "ranking": "HIGH"
      }
    ],
    "images": [
      "https://ns.clubmed.com/ipmm/1-MEDIA/01.VILLAGES/1.1MER/CANCUN-YUCATAN/32-31-30-29-28-27-26-25-24-23-22-21-20-19-18-17-16-15-14-13-12-11-10-9-8-7-6-5-4-3-2-1-PHOTOS/CANCH117008.jpg"
    ],
    "bathroom_equipments": [
      {
        "id": "rain_shower",
        "label": "Rain Shower"
      }
    ],
    "outside_facilities": [
      {
        "id": "furnished_balcony",
        "label": "Furnished balcony",
        "area": {
          "min": 39,
          "max": 39,
          "unit": "m²"
        }
      }
    ],
    "associated_accommodations": [
      {
        "id": "A2"
      }
    ],
    "restriction_information": [
      {
        "id": "restriction01",
        "description": "Certain Room types may be temporarily unavailable due to reduced Resort capacity."
      }
    ],
    "plans": [
      "https://path/to/room/plan.jpg"
    ],
    "floors": [
      {
        "id": "floor_1",
        "label": "1st floor"
      }
    ],
    "_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.