Récupérer les bookings d'un vendeur

  • Bookings
  • Réservation
  • 1 route
Comment un vendeur peut-il récupérer la liste des bookings qu'il gère ?

Ce scénario explique comment récupérer la liste des bookings visibles pour un vendeur via un point d'entrée de recherche unique. Il est utile pour alimenter une liste back-office, appliquer des filtres métier et identifier le dossier à ouvrir ensuite en détail.

La route renvoie des indicateurs commerciaux et opérationnels comme le statut du booking, le statut de paiement, le produit, le participant principal, l'email du vendeur et la commission quand elle est disponible.

Vue d'ensemble

Utilisez ce scénario lorsqu'un vendeur doit récupérer les bookings qu'il gère et réduire le jeu de résultats avec des filtres métier comme le statut du booking, le statut de paiement, le produit, le nom du participant principal, ou des dates de création et de départ.

L'objectif est d'obtenir une liste paginée de bookings pouvant alimenter un espace vendeur, un tableau de suivi ou une file de traitement.

Prérequis

  • Disposer d'un x-api-key valide.
  • Utiliser une valeur accept-language retournée par GET/v0/locales.
  • Utiliser un token d'accès si votre contexte d'intégration impose une authentification vendeur.
  • Définir les filtres utiles au cas d'usage, par exemple booking_status, payment_status, product_id, customer_id ou sort.

Notes fonctionnelles

  • Ce scénario couvre la liste des bookings, pas le détail complet d'un booking.
  • La pagination est disponible via page et limit.
  • Le tri est disponible sur departure_date, creation_date et expiration_date.
  • La réponse peut inclure des informations utiles côté vendeur comme salesman_id, seller_email, commission et le participant principal dans households.
1

Lister les bookings du vendeur

Obligatoire

Cette route retourne la liste des bookings correspondant à vos filtres de vente.

Prérequis

Ajoutez les filtres utiles comme customer_id, booking_status, start_date, end_date, limit ou page.

Calling CURL

curl -X GET \
  -H "x-api-key: $API_KEY" \
  -H "accept-language: fr-FR" \
  "https://api.clubmed.com/v2/bookings?booking_status=OPTION&limit=20&page=1"

Example answer

[
  {
    "id": "booking-1",
    "status": "OPTION",
    "product_id": "product-1",
    "start_date": "2026-07-05",
    "end_date": "2026-07-12",
    "customer_id": "customer-1"
  }
]

info: La route peut renvoyer 206 Partial Content quand le résultat est paginé. Gérez donc aussi les métadonnées de pagination dans votre intégration.

Codes de réponse

  • 200 OK : la liste des bookings est renvoyée.
  • 206 Partial Content : la liste est paginée.
  • 400 Bad Request : paramètres invalides.
  • 401 Unauthorized : jeton manquant ou invalide.
  • 416 Range Not Satisfiable : pagination invalide.
GET/v2/bookings
Voir plus