Parcours de réservation avec options de durées

  • Réservation
  • 4 routes
Comment construire un parcours de réservation tout en contrôlant la durée d'option d'une proposition ?

Ce scénario documente un parcours de réservation centré sur la création d'une proposition, sa consultation, son rafraîchissement et la qualification des participants, avec une attention particulière portée à la durée d'option. Il convient aux parcours qui doivent sécuriser un dossier avant sa transformation en booking.

Le flux crée une proposition, relit son détail, la rafraîchit pour confirmer sa fraîcheur puis met à jour les attendees.

Vue d'ensemble

Ce scénario aide une application à préparer un dossier de réservation en surveillant la validité temporelle de l'option portée par la proposition.

Prérequis

  • Les critères de recherche nécessaires pour créer la proposition.
  • Un proposal_id retourné par la première étape.
  • Les informations participants nécessaires pour compléter la proposition.
  • Un x-api-key valide et, selon le canal, un contexte d'autorisation adapté.

Résultat attendu

L'application peut construire une proposition, suivre sa durée d'option, rafraîchir ses informations et compléter les attendees avant la suite du parcours.

Process workflow

Legend:
Obligatoire
Optionnel
1

Rechercher les propositions correspondantes

Obligatoire

Utilisez POST/v3/proposals/search pour creer la proposition qui portera le reste du parcours de reservation. Cette route calcule le premier contexte de prix et de stock, puis retourne le proposal_id reutilise par les etapes suivantes.

Prerequis

  • Envoyer accept-language et x-api-key.
  • Ajouter authorization si le contexte partenaire ou vendeur le demande.
  • Preparer les criteres de reservation attendus dans le payload JSON.

Calling CURL

curl -X 'POST' \
  'https://api.clubmed.com/v3/proposals/search' \
  -H 'accept: application/json' \
  -H 'accept-language: fr-FR' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

Example answer

{
  "id": "123456",
  "product_id": "MPAC",
  "price": {
    "total": 9815.4,
    "currency": "EUR"
  },
  "remaining_stock": 2,
  "option_durability": {
    "is_reliable": true,
    "expiration_date_time": "20160415T10:23:00.234Z"
  }
}

info: Reutilisez proposal_id et option_durability pour suivre la fenetre de validite de l'option dans la suite du parcours.

Codes de reponse

  • 200 OK : retourne la proposition correspondant aux criteres soumis.
  • 400 Bad Request : le payload est invalide, incomplet ou incoherent.
  • 401 Unauthorized : l'authentification est absente, invalide ou expiree.
  • 403 Forbidden : le contexte courant ne peut pas creer la proposition.
  • 404 Not Found : le produit est introuvable.
  • 409 Conflict : les criteres de proposition ne sont plus valides.
POST/v3/proposals/search
Voir plus
2

Relire la proposition creee

Obligatoire

Utilisez GET/v2/proposals/{proposal_id} pour relire la proposition fraichement creee. Cette lecture confirme le prix, la duree d'option, le stock et les principaux elements commerciaux avant de decider un rafraichissement ou une qualification attendees.

Prerequis

  • Fournir proposal_id.
  • Envoyer x-api-key.
  • Conserver le meme contexte metier que lors de la creation de la proposition.

Calling CURL

curl -X 'GET' \
  'https://api.clubmed.com/v2/proposals/123456' \
  -H 'accept: application/json' \
  -H 'x-api-key: YOUR_API_KEY'

Example answer

{
  "id": "123456",
  "product_id": "MPAC",
  "price": {
    "total": 9815.4,
    "currency": "EUR"
  },
  "remaining_stock": 2,
  "option_durability": {
    "is_reliable": true,
    "expiration_date_time": "20160415T10:23:00.234Z"
  }
}

info: Cette etape est la meilleure verification du contexte commercial reel de la proposition avant toute mise a jour.

Codes de reponse

  • 200 OK : retourne le detail de la proposition.
  • 400 Bad Request : la requete est invalide.
  • 409 Conflict : les conditions economiques de la proposition ne sont plus valides ou le produit est ferme.
GET/v2/proposals/{proposal_id}
Voir plus
3

Rafraichir la proposition avant de qualifier les participants

Obligatoire

Utilisez POST/v1/proposals/{proposal_id}/refresh pour rafraichir une proposition existante avant de completer les informations participants. Cette etape est utile quand la duree d'option est courte ou quand vous souhaitez confirmer que le prix et le stock sont encore a jour.

Prerequis

  • Fournir proposal_id.
  • Envoyer accept-language, authorization si necessaire, et x-api-key.
  • Conserver la meme locale que celle utilisee lors de la creation initiale de la proposition.

Calling CURL

curl -X 'POST' \
  'https://api.clubmed.com/v1/proposals/123456/refresh' \
  -H 'accept: application/json' \
  -H 'accept-language: fr-FR' \
  -H 'x-api-key: YOUR_API_KEY'

Example answer

{
  "id": "123456",
  "price": {
    "total": 9815.4,
    "currency": "EUR"
  },
  "remaining_stock": 2,
  "option_durability": {
    "is_reliable": true
  }
}

info: Rafraichir juste avant la qualification attendees limite le risque de travailler sur un prix ou un stock obsoletes.

Codes de reponse

  • 200 OK : retourne la proposition rafraichie.
  • 400 Bad Request : la requete est invalide.
  • 401 Unauthorized : l'authentification est absente, invalide ou expiree.
  • 403 Forbidden : le contexte courant ne peut pas rafraichir cette proposition.
  • 409 Conflict : la proposition n'est plus economiquement valide.
POST/v1/proposals/{proposal_id}/refresh
Voir plus
4

Qualifier les participants de la proposition

Optionnel

Utilisez PUT/v3/proposals/{proposal_id}/attendees pour attacher ou mettre a jour les participants sur la proposition avant de passer a la creation du booking. C'est l'etape ou l'on securise l'identite, la composition des foyers et les liens clients du dossier.

Prerequis

  • Fournir proposal_id.
  • Envoyer accept-language, authorization si necessaire, et x-api-key.
  • Preparer un payload attendees conforme aux regles documentees sur les dates de naissance, documents et coherence des foyers.

Calling CURL

curl -X 'PUT' \
  'https://api.clubmed.com/v3/proposals/123456/attendees' \
  -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

[
  {
    "attendees": [
      {
        "id": "A",
        "customer_id": "123456789",
        "customer_status": "NEW_CUSTOMER",
        "loyalty_status": "GOLD"
      }
    ]
  }
]

info: La plupart des contraintes de validation sur l'identite et les documents ressortent a cette etape, il faut donc bien remonter les erreurs cote interface.

Codes de reponse

  • 200 OK : retourne la structure attendees mise a jour.
  • 400 Bad Request : les donnees sont invalides, incompletes, dupliquees ou incoherentes.
  • 401 Unauthorized : l'authentification est absente, invalide ou expiree.
  • 403 Forbidden : au moins un client ne peut pas poursuivre le parcours.
  • 409 Conflict : la proposition n'est plus economiquement valide.
PUT/v3/proposals/{proposal_id}/attendees
Voir plus