Formulaire d'arrivée

  • Services
  • Prébooking
  • 3 routes
Comment un client peut-il consulter et compléter les formalités d'arrivée d'un booking ?

Ce scénario explique comment identifier les formalités disponibles avant l'arrivée, déterminer quels services Easy Arrival peuvent encore être complétés, puis soumettre les réponses liées au formulaire de pré-séjour pour un booking.

Il est utile pour piloter une expérience de formulaire d'arrivée qui guide le voyageur étape par étape au lieu d'exposer des endpoints isolés.

Vue d'ensemble

Utilisez ce scénario lorsque vous devez exposer le parcours de préparation d'arrivée d'un booking. L'objectif est de découvrir quelles formalités de pré-séjour sont disponibles, d'identifier les services encore éligibles dans Easy Arrival, puis de soumettre les réponses attendues par le formulaire.

Cette séquence est particulièrement utile pour un portail client, un outil support ou un parcours vendeur qui doit savoir si Easy Arrival, la sélection de chambre, les informations de transfert, la fiche de police ou l'express check-out sont disponibles.

Prérequis

  • Disposer d'un x-api-key valide.
  • Utiliser une valeur accept-language retournée par GET/v0/locales pour les routes qui l'exigent.
  • Disposer d'un bearer token valide.
  • Connaître customer_id et booking_id.
  • Vérifier que le booking appartient bien au contexte client authentifié.

Notes fonctionnelles

  • La première route fournit une vue consolidée des formalités disponibles pour le booking.
  • La deuxième route cible les services éligibles au formulaire Easy Arrival.
  • La route de soumission enregistre les réponses, mais le schéma détaillé du payload n'est pas visible dans les sources disponibles et doit donc être manipulé avec prudence à l'implémentation.

Process workflow

Legend:
Obligatoire
Optionnel
1

Consulter les formalités de séjour

Obligatoire

Cette route retourne les formalités de séjour à compléter pour un booking donné.

Prérequis

Utilisez customer_id et booking_id avec un jeton d'autorisation valide, en plus de la clé API.

Calling CURL

curl -X GET \
  -H "x-api-key: $API_KEY" \
  -H "accept-language: fr-FR" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  "https://api.clubmed.com/v1/customers/{customer_id}/bookings/{booking_id}/stay_formalities"

Example answer

[
  {
    "stay_id": "stay-1",
    "credit_card_check_in": true,
    "payment_check_out": true,
    "gm_feedback": false,
    "easy_arrival": true,
    "transfer": true,
    "room_selection": false,
    "police_form": false
  }
]

info: Cette étape sert de point d'entrée pour savoir quelles formalités doivent encore être complétées avant le départ.

Codes de réponse

  • 200 OK : les formalités de séjour sont renvoyées.
  • 400 Bad Request : paramètres invalides.
  • 401 Unauthorized : jeton manquant ou invalide.
  • 403 Forbidden : le booking n'est pas accessible dans ce contexte.
GET/v1/customers/{customer_id}/bookings/{booking_id}/stay_formalities
Voir plus
2

Lister les services éligibles Easy Arrival

Obligatoire

Cette route retourne les services du booking qui sont éligibles au parcours Easy Arrival.

Prérequis

Utilisez customer_id et booking_id avec un jeton d'autorisation valide.

Calling CURL

curl -X GET \
  -H "x-api-key: $API_KEY" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  "https://api.clubmed.com/v0/customers/{customer_id}/bookings/{booking_id}/easy_arrival/eligible_services"

Example answer

[
  {
    "product_id": "product-1",
    "status": "OPEN",
    "arrival_date": "2026-07-05",
    "return_date": "2026-07-12",
    "attendees": [
      {
        "id": "attendee-1",
        "services": [
          {
            "id": "service-1",
            "label": "Airport transfer"
          }
        ]
      }
    ]
  }
]

info: Cette réponse permet de savoir quels services peuvent être pré-renseignés avant l'arrivée.

Codes de réponse

  • 200 OK : les services éligibles sont renvoyés.
  • 400 Bad Request : paramètres invalides.
  • 401 Unauthorized : jeton manquant ou invalide.
  • 403 Forbidden : accès refusé.
  • 404 Not Found : booking introuvable pour ce client.
GET/v0/customers/{customer_id}/bookings/{booking_id}/easy_arrival/eligible_services
Voir plus
3

Soumettre les réponses Easy Arrival

Obligatoire

Cette route enregistre les réponses Easy Arrival pour le booking ciblé.

Prérequis

Préparez les réponses attendues pour chaque participant et utilisez un jeton d'autorisation valide.

Calling CURL

curl -X POST \
  -H "x-api-key: $API_KEY" \
  -H "accept-language: fr-FR" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"surveys": [{"attendee_id": "attendee-1", "questions": [{"id": "question-1", "answer": "YES"}]}]}' \
  "https://api.clubmed.com/v0/customers/{customer_id}/bookings/{booking_id}/easy_arrival/surveys"

Example answer

HTTP/1.1 204 No Content

info: Le succès est retourné sans body. Relisez ensuite les formalités si vous voulez vérifier que l'étape a bien été prise en compte.

Codes de réponse

  • 204 No Content : les réponses sont enregistrées.
  • 400 Bad Request : JSON invalide ou validation échouée.
  • 401 Unauthorized : jeton manquant ou invalide.
  • 403 Forbidden : accès refusé.
  • 404 Not Found : booking introuvable.
POST/v0/customers/{customer_id}/bookings/{booking_id}/easy_arrival/surveys
Voir plus