customers

Get customer loyalty details.

About loyalty details' type

TypeDefinition
FREQUENCYThe points are redistributed to the customer according to the duration of their stay by respecting a few rules. If the duration of the stay is : - less than 2 days 1500 points- less or equals 7 days 2500 points- more 3000 points
BOOKINGAttributed depending on booking's price (defined by Business Units)
BIRTHDAYPoints won on birthday
BOOSTERThis is a type of point related to the Great Members platform. The Business Units have a sum of points that they can freely allocate to the targeted GMs.
BONUSPoints are reallocated when households are merged or cut off. It is also possible to give points
ADDEDPoints added manually or automatically allowing a GM to reach a targeted loyalty status
TRANSFERTransfered points from an accouunt to another one
SPONSORSHIPPoints won by sponsorship
FLIGGYAs a loyalty client of Fosun Tourism Group, a GM can become a Club Med Premium client as soon as he books a trip with ClubMed
PURCHASES_IN_RESORTPoints won for each consumption in a resort
YEARLY_BONUSCreated during Covid in order to give points to the most loyal GMs to keep their fidelity status. Only used between 2021 and 2022.
get/v2/customers/{customer_id}/loyalty_details

Request

  • Base URL: https://api.clubmed.com
  • URL: https://api.clubmed.com/v2/customers/{customer_id}/loyalty_details
  • Auth: one of:
    • OpenID Connect (https://auth.clubmed.com/.well-known/openid-configuration, scopes: openid, email, profile, clubmed)
    • OpenID Connect (https://accounts.clubmed.com/.well-known/openid-configuration, scopes: openid, email, profile, clubmed)

Path parameters

customer_idstring required

Customer ID (neolid clic)

Example:123456789

Query parameters

pageinteger

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

limitinteger

Maximum rows count per page (default: 10)

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 required

Optional Access Token (bearer)

Example:Bearer aaaa.vbbbB.bbbb

Access Token (bearer)

x-api-keystring required

Api_key provided by ClubMed API team

Response

ok

type'FREQUENCY' | 'BOOKING' | 'BIRTHDAY' | 'BOOSTER' | 'BONUS' | 'ADDED' | 'TRANSFER' | 'SPONSORHSIP' | 'FLIGGY' | 'PURCHASES_IN_RESORT' | 'YEARLY_BONUS' required

Loyalty type

pointsinteger required

Number of points

expiration_datestring nullable required

Points expiration date

expiredboolean required

true when points are expired

loyalty_program_status'NONE' | 'TURQUOISE' | 'SILVER' | 'GOLD' | 'PLATINUM'

Customer loyalty program status at the time of the earned points

Example response

[
  {
    "type": "FREQUENCY",
    "points": 250,
    "expiration_date": "20100430",
    "expired": true,
    "related_booking": {
      "id": "0123456789",
      "arrival_date": "20100430",
      "product_ids": [
        "PCAC"
      ]
    },
    "loyalty_program_status": "GOLD"
  }
]

Changes

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