Ajouter des participants à votre proposition

  • Customers
  • Réservation
  • 2 routes
Comment ajouter des participants à votre proposition ?

Ce scénario explique comment créer ou retrouver une proposition puis rattacher les participants attendus avant les étapes ultérieures de booking ou de recalcul tarifaire.

Vue d'ensemble

Cette séquence commence par la création ou la récupération d'une proposition via POST/v1/proposals/search/best, puis met à jour la liste des voyageurs avec PUT/v3/proposals/{proposal_id}/attendees. Il s'agit d'un prérequis fréquent avant un recalcul tarifaire, la sauvegarde d'une proposition ou la création d'un booking.

Prérequis

  • Les critères de recherche de proposition utilisés par votre intégration doivent être disponibles.
  • Le proposal_id retourné par la première étape est requis pour la mise à jour des participants.
  • Les appels documentés requièrent accept-language et x-api-key.

Process workflow

Legend:
Obligatoire
Optionnel
1

Créer ou récupérer une proposition

Obligatoire

Cette route permet de créer ou de récupérer la meilleure proposition correspondant aux critères de séjour transmis par votre intégration. La réponse retourne l'identifiant de proposition à réutiliser pour rattacher ensuite les participants.

Prerequis

  • accept-language et x-api-key sont requis.
  • Le corps de requête doit porter les critères de recherche de proposition attendus par votre parcours.
  • Conservez l'id retourné : il sera réutilisé comme proposal_id à l'étape suivante.

Calling CURL

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

Example answer

{
  "id": "123456",
  "product_id": "MPAC",
  "booking_id": 123456,
  "package_id": "AI",
  "label": "Proposal with one club room",
  "price": {
    "total": 9815.4,
    "currency": "EUR"
  },
  "option_durability": {
    "expiration_date_time": "20160415T10:23:00.234Z",
    "is_reliable": true
  },
  "households": [
    {
      "attendees": [
        {
          "id": "A",
          "birthdate": "20100430",
          "customer_id": "string",
          "customer_type": "NEW_CUSTOMER"
        }
      ]
    }
  ],
  "is_bookable": false
}

info: la réponse peut aussi exposer alternative_price, included_services et package_options lorsque le calcul de proposition contient des promotions ou des services optionnels.

Codes de reponse

  • OK Response (200): la proposition a été créée ou récupérée avec succès et le payload retourne un contexte de proposition réutilisable.
  • Error (400): les critères ou le payload sont invalides, incomplets ou incohérents avec les règles de participants et d'hébergements documentées dans le Swagger.
  • Error (401): la requête est non autorisée car les éléments d'authentification ou la clé API sont absents, invalides ou expirés.
  • Error (403): au moins un client porté par les critères n'est pas autorisé à poursuivre le parcours de booking.
  • Error (404): le produit demandé est inconnu pour le product_id fourni.
POST/v1/proposals/search/best
Voir plus
2

Rattacher les participants à la proposition

Obligatoire

Cette route permet de mettre à jour la liste des participants rattachés à une proposition existante. Utilisez-la après la création de la proposition pour identifier les voyageurs et persister les statuts client nécessaires aux étapes avales de sauvegarde ou de booking.

Prerequis

  • Le paramètre de path proposal_id est requis.
  • x-api-key est requis et accept-language est documenté pour l'appel.
  • Le corps de requête doit contenir la liste des participants à rattacher ou à mettre à jour sur la proposition.
  • partner_type et call_id peuvent être ajoutés si votre parcours partenaire en a besoin.

Calling CURL

curl -X 'PUT' \
  'https://api.clubmed.com/v3/proposals/123456/attendees' \
  -H 'accept: application/json' \
  -H 'accept-language: fr-FR' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json'

Example answer

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

info: la proposition peut devenir économiquement invalide entre la recherche initiale et la mise à jour des participants ; dans ce cas la route peut retourner 409.

Codes de reponse

  • OK Response (200): la liste des participants a été mise à jour avec succès pour la proposition ciblée.
  • Error (400): le payload est invalide ou incomplet, par exemple lorsque des données voyageurs obligatoires sont absentes, dupliquées ou incohérentes.
  • Error (401): la requête est non autorisée car les éléments d'authentification ou la clé API sont absents, invalides ou expirés.
  • Error (403): au moins un client ajouté n'est pas autorisé à poursuivre le parcours de booking.
  • Error (409): le contrôle économique de la proposition n'est plus valide au moment de la mise à jour.
PUT/v3/proposals/{proposal_id}/attendees
Voir plus