bookings

Get a list of bookings

get/v2/bookings

Request

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

Query parameters

booking_status'VALIDATED' | 'OPTION' | 'CANCELED' | 'EXPIRED'

booking's status

Example:VALIDATED
payment_status'PAID' | 'UNPAID'

Booking payment's status

Example:PAID
product_idstring

ClubMed Product identifier

Example:MPAC
last_namestring

Last name of the main attendee

Example:Doe
start_datestring date

start date of the booking Supported formats: YYYY-MM-DD, YYYYMMDD, YYYYMM

Example:2022-04-15
end_datestring date

end date of the booking Supported formats: YYYY-MM-DD, YYYYMMDD, YYYYMM

Example:2022-04-15
customer_idstring

Customer ID (neolid clic)

Example:123456789
household_idnumber

Household id

Example:1
view'SELLER' | 'AGENCY' | 'NETWORK'

Requested view for Partners only. SELLER means you want your seller bookings. AGENCY means you want your agency bookings. NETWORK means you want your network bookings. Possible values: SELLER, AGENCY, NETWORK. This parameter is optional.

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])

min_creation_datestring date

minimum creation date of the booking Supported formats: YYYY-MM-DD, YYYYMMDD Supported formats: YYYY-MM-DD, YYYYMMDD, YYYYMM

Example:2022-04-15
max_creation_datestring date

maximum creation date of the booking Supported formats: YYYY-MM-DD, YYYYMMDD Supported formats: YYYY-MM-DD, YYYYMMDD, YYYYMM

Example:2022-04-15
discount_idstring

Discount that must be present in the booking

filterFilterParamModel[]

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

string composed of a field name (can be a path), a comparison operator (>, >=, <=, <, ==, !=) and a value. Logical operator AND applies between filters. Valid filters are : booking_status, payment_status, customer_id, attendees.household_id, departure_date.

sort'departure_date:ASC' | 'departure_date:DESC' | 'creation_date:ASC' | 'creation_date:DESC' | 'expiration_date:ASC' | 'expiration_date:DESC'

string composed of a field name (can be a path), a direction operator (ASC, DESC). Valid sort fields are departure_date, creation_date, expiration_date. DESC retrieves newer bookings first.

Example:expiration_date:ASC
limitinteger

Maximum rows count per page

pageinteger

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

Headers

authorizationstring

Optional Access Token (bearer)

Example:Bearer aaaa.vbbbB.bbbb

Access Token (bearer)

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

booking id

booking_status'OPTION' | 'CANCELED' | 'VALIDATED' | 'PARTIALLY_VALIDATED' | 'EXPIRED'

booking's status

payment_status'PAID' | 'UNPAID' | 'IN_CREDIT' | 'PENDING' | 'UNKNOWN'

booking payment's status

salesman_idstring nullable required

id of the seller. Will be populated only if the booking has been sold by a Club Med Partners.

country_codestring

ISO 3166-1 alpha-2 country code

seller_emailstring nullable

Email of the seller recorded in the booking

multiple_sale_contractsboolean required

true if the booking is composed of mulitple sale contracts, owned by different customers. Online sale processes are not possible in this case.

is_transport_includedboolean required

indicates whether the booking is with transport or without transport

creation_datestring date

Creation date Supported formats: YYYY-MM-DD, YYYYMMDD, YYYYMM

departure_datestring date

Departure date Supported formats: YYYY-MM-DD, YYYYMMDD, YYYYMM

return_datestring date

Return date Supported formats: YYYY-MM-DD, YYYYMMDD, YYYYMM

validation_datestring date

Validation date Supported formats: YYYY-MM-DD, YYYYMMDD, YYYYMM

Example response

[
  {
    "id": "12345",
    "booking_status": "VALIDATED",
    "payment_status": "PAID",
    "products": [
      {
        "id": "ALHC_WINTER",
        "label": "ALPES HUEZ",
        "type": "VILLAGE",
        "_links": [
          {
            "rel": "self",
            "deprecated_rel": true,
            "method": "GET",
            "href": "https://api.clubmed.com/products",
            "label": "A label"
          }
        ]
      }
    ],
    "salesman_id": "987654",
    "country_code": "FR",
    "price": {
      "total": 80,
      "currency": "EUR"
    },
    "discounts": [
      {
        "id": "LMO"
      }
    ],
    "commission": {
      "total": 80,
      "currency": "EUR"
    },
    "seller_email": "pierre.dupont@partner.com",
    "is_transport_included": true,
    "households": [
      {
        "household_id": "23434",
        "number_attendees": 2,
        "main_attendee": {
          "civility": "MR",
          "first_name": "Marc",
          "customer_id": 987654
        },
        "_links": [
          {
            "rel": "self",
            "deprecated_rel": true,
            "method": "GET",
            "href": "https://api.clubmed.com/products",
            "label": "A label"
          }
        ]
      }
    ],
    "creation_date": "2022-04-15",
    "departure_date": "2022-04-15",
    "return_date": "2022-04-15",
    "validation_date": "2022-04-15",
    "option_durability": {
      "expiration_date_time": "2022-04-15T10:23:00.234Z",
      "is_reliable": true
    }
  }
]

Changes

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