Ajouter une assurance à une réservation

  • Services
  • 3 routes
Comment lister les assurances disponibles puis ajouter une assurance à une réservation existante ?

Ce scénario explique comment retrouver une réservation, consulter les assurances disponibles puis ajouter le service d'assurance au panier de la réservation. Il convient aux parcours de vente assistée, de service client ou de finalisation de dossier avec couverture complémentaire.

Le flux s'appuie sur un customer_id et un booking_id connus, puis enchaîne la consultation des assurances et l'ajout du service dans le panier.

Vue d'ensemble

Ce scénario aide une application à proposer une assurance sur un dossier déjà créé, sans repartir d'une recherche de proposition.

Prérequis

  • Un customer_id et un booking_id valides.
  • Un contexte d'authentification et les headers attendus par les routes utilisées.
  • Une assurance compatible avec le dossier et le marché ciblés.

Résultat attendu

L'application peut afficher les assurances disponibles et ajouter l'assurance choisie au panier du booking pour poursuivre la confirmation.

Process workflow

Legend:
Obligatoire
Optionnel
1

Lister les bookings éligibles à l'ajout d'assurance

Obligatoire

Cette route retourne les bookings accessibles dans le contexte courant. Utilisez-la pour identifier le booking_id cible avant de lister les assurances puis d'ajouter celle qui convient au panier du booking.

Prerequis

  • Envoyer accept-language et x-api-key.
  • Ajouter authorization lorsque le contexte nécessite un client ou un vendeur authentifié.
  • Utiliser si besoin des filtres comme customer_id, booking_status ou payment_status pour réduire la liste.

Calling CURL

curl -X 'GET' \
  'https://api.clubmed.com/v2/bookings?customer_id=123456789&limit=10' \
  -H 'accept: application/json' \
  -H 'accept-language: fr-FR' \
  -H 'authorization: Bearer YOUR_TOKEN' \
  -H 'x-api-key: YOUR_API_KEY'

Example answer

[
  {
    "id": "12345",
    "booking_status": "VALIDATED",
    "payment_status": "PAID",
    "products": [
      {
        "id": "ALHC_WINTER",
        "label": "ALPES HUEZ",
        "type": "VILLAGE"
      }
    ],
    "option_durability": {
      "expiration_date_time": "20160415T10:23:00.234Z",
      "is_reliable": true
    }
  }
]

info: Réutilisez le booking_id retourné ici pour cibler le bon dossier dans l'étape d'ajout de l'assurance au panier.

Codes de reponse

  • OK Response (200): retourne les bookings correspondant aux filtres soumis.
  • Error (206): la réponse est partielle et d'autres pages peuvent encore être disponibles.
  • Error (400): les filtres, le tri ou la pagination sont invalides.
  • Error (401): l'authentification est absente, invalide ou expirée.
  • Error (404): non documente dans le Swagger.
GET/v2/bookings
Voir plus
2

Lister les assurances disponibles

Obligatoire

Cette route retourne le catalogue des assurances disponibles dans le contexte commercial courant. Utilisez-la pour comparer les garanties, les assureurs et les identifiants avant de choisir l'assurance a ajouter au booking.

Prerequis

  • Envoyer accept-language et x-api-key.
  • Reutiliser le contexte produit ou booking deja identifie dans l'etape precedente.
  • Ajouter si besoin des filtres de contexte compatibles avec votre parcours.

Calling CURL

curl -X 'GET' \
  'https://api.clubmed.com/v0/insurances' \
  -H 'accept: application/json' \
  -H 'accept-language: fr-FR' \
  -H 'x-api-key: YOUR_API_KEY'

Example answer

[
  {
    "id": "TRAVEL_INSURANCE",
    "label": "Travel Insurance",
    "description": "Coverage for cancellation and assistance",
    "company": {
      "label": "Club Med Insurance Partner"
    },
    "coverage_descriptions": [
      "Cancellation",
      "Medical assistance"
    ]
  }
]

info: Conservez l'identifiant de l'assurance et ses principaux benefices pour alimenter l'etape d'ajout au panier et l'interface de choix.

Codes de reponse

  • OK Response (200): retourne la liste des assurances disponibles dans le contexte courant.
  • Error (400): la requete ou les filtres soumis sont invalides.
  • Error (401): non documente dans le Swagger.
  • Error (403): l'acces au catalogue d'assurance est interdit dans le contexte courant.
  • Error (404): aucune assurance n'est disponible pour le contexte demande.
GET/v0/insurances
Voir plus
3

Ajouter l'assurance au panier du booking

Obligatoire

Cette route ajoute l'assurance ou le service selectionne au panier d'un booking existant. Utilisez-la une fois le booking_id et l'identifiant de l'assurance connus.

Prerequis

  • Fournir customer_id et booking_id.
  • Envoyer accept-language, authorization et x-api-key.
  • Preparer un body aligne avec le service selectionne ; le detail exact du payload n'est pas entierement visible dans les exemples disponibles.

Calling CURL

curl -X 'POST' \
  'https://api.clubmed.com/v1/customers/123456789/bookings/12345/cart/services' \
  -H 'accept: application/json' \
  -H 'accept-language: fr-FR' \
  -H 'authorization: Bearer YOUR_TOKEN' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

Example answer

HTTP/1.1 204 No Content

info: Pour retirer ensuite un service deja ajoute, la documentation renvoie vers la route de suppression du panier.

Codes de reponse

  • OK Response (204): le service a ete ajoute au panier sans corps de reponse.
  • Error (400): le payload ou le contexte de booking est invalide.
  • Error (401): l'authentification est absente, invalide ou expiree.
  • Error (403): l'ajout du service est interdit dans le contexte courant.
  • Error (404): non documente dans le Swagger.
  • Error (501): l'upsell sur un dossier multi-stay n'est pas encore disponible.
POST/v1/customers/{customer_id}/bookings/{booking_id}/cart/services
Voir plus