Retrieve resort highlights and must-try experiences

  • Product Information
  • Resort content
  • 4 routes
How do I retrieve a resort's strengths and must-try experiences?

This scenario explains how to resolve a resort product, read its main product data, retrieve editorial highlights, and isolate must-try experiences from the same highlights feed.

Overview

The route sequence starts by resolving the resort product, then combines generic product information with the editorial highlights feed to expose both the resort's strengths and the must-try experiences.

Prerequisites

  • A valid product_id must be resolved or selected.
  • accept-language and x-api-key are required on the documented calls.
  • Must-try experiences are retrieved from the highlights feed by filtering on type == MUST_TRY_EXPERIENCES.

Process workflow

Legend:
Mandatory
Optional
1

Resolve the resort product_id

Mandatory

Use GET/v2/products to resolve the resort product_id.

Prerequisites

Prepare the parameters required by the call. Keep x-api-key and, when the route is customer-scoped, a valid bearer token.

Calling CURL

curl -X GET \
  -H "x-api-key: YOUR_API_KEY" \
  -H "accept-language: en-US" \
  "https://api.clubmed.com/v2/products?limit=20&page=1"

Example answer

[
  {
    "id": "product-1",
    "label": "Club Med Valmorel",
    "country_code": "FR",
    "type": "RESORT"
  }
]

info: Keep the selected resort product_id to request its highlights and must-try experiences in the next steps.


Response codes

  • 200 OK: the expected data is returned.
  • 400 Bad Request: the request is invalid or incomplete.
  • 404 Not Found: the requested resource cannot be found.
GET/v2/products
See more
2

Read the product strengths

Mandatory

Use GET/v2/products/{product_id} to read the product strengths.

Prerequisites

Prepare product_id. Keep x-api-key and, when the route is customer-scoped, a valid bearer token.

Calling CURL

curl -X GET \
  -H "x-api-key: YOUR_API_KEY" \
  -H "accept-language: en-US" \
  "https://api.clubmed.com/v2/products/{product_id}"

Example answer

{
  "id": "product-1",
  "label": "Club Med Valmorel",
  "country_code": "FR",
  "type": "RESORT",
  "description": "Family resort in the Alps"
}

info: Réutilisez les highlights retournés pour alimenter un bloc éditorial de réassurance ou une page resort.


Response codes

  • 200 OK: the expected data is returned.
  • 400 Bad Request: the request is invalid or incomplete.
  • 404 Not Found: the requested resource cannot be found.
GET/v2/products/{product_id}
See more
3

Retrieve the editorial highlights

Mandatory

Use GET/v0/products/{product_id}/highlights to retrieve the editorial highlights that describe the main strengths of the resort.

Prerequisites

Prepare product_id. Keep x-api-key and, when the route is customer-scoped, a valid bearer token.

Calling CURL

curl -X GET \
  -H "x-api-key: YOUR_API_KEY" \
  -H "accept-language: en-US" \
  "https://api.clubmed.com/v0/products/{product_id}/highlights"

Example answer

[
  {
    "id": "highlight-1",
    "title": "Ski-in / ski-out",
    "type": "RESORT_HIGHLIGHT"
  }
]

info: Reuse highlight titles, types, and tags to build the resort editorial block or prepare the must-try filter.


Response codes

  • 200 OK: the expected data is returned.
  • 400 Bad Request: the request is invalid or incomplete.
  • 404 Not Found: the requested resource cannot be found.
GET/v0/products/{product_id}/highlights
See more
4

Retrieve must-try experiences from highlights

Optional

Use GET/v0/products/{product_id}/highlights to isolate items of type MUST_TRY_EXPERIENCES from the resort highlights feed.

Prerequisites

Prepare product_id. Send accept-language and x-api-key. Use the type==MUST_TRY_EXPERIENCES filter so the response only keeps the must-try experiences.

Calling CURL

curl -X GET \
  -H "x-api-key: YOUR_API_KEY" \
  -H "accept-language: en-US" \
  "https://api.clubmed.com/v0/products/{product_id}/highlights?filter=type==MUST_TRY_EXPERIENCES"

Example answer

[
  {
    "id": "BALC_must_try_01",
    "title": "GET CRAFTY",
    "type": "MUST_TRY_EXPERIENCES",
    "description": "Experience the colours and textures of Balinese art in the newly constructed Arts & Crafts studio.",
    "image": "http://mypicture01.jpg",
    "theme": "family",
    "tags": ["tag1"]
  }
]

info: The returned type lets you distinguish must-try experiences from the rest of the editorial highlights without relying on a deprecated dedicated endpoint.


Response codes

  • 200 OK: the filtered highlights are returned for the requested resort.
  • 400 Bad Request: product_id or the provided filter is invalid.
  • 404 Not Found: the requested product is unknown.
GET/v0/products/{product_id}/highlights
See more