Vérification de la disponibilité immédiate de réservation

Ce service web a pour objectif de vous permettre de vérifier la faisabilité en temps réel d'une réservation sur une zone locative.

POST @api/partners/bookings/action/check

Aucun paramètre n'est disponible pour ce service web

Body au format JSON

{
  "data": {
    "reservations" : [{
      /** @var string Identifiant de l'hôtel concerné */
      "hotel_id" : "H88G000821",
      /** @var string Identifiant de la zone locative concernée */
      "room_id" : "H88G000821",
      /** @var string Nature du séjour (Particulier/Professionnel) */
      "nature" : "pa",
      /** @var array Liste des nuitées de location facturées (de checkin à checkout -1 jour) */
      "periods" : [{
        /** @var date Date de début de facturation */
        "from" : "2019-08-13",
        /** @var date Date de fin de facturation */
        "to" : "2019-08-14",
        /** @var float Montant du loyer communiqué par Cloudspire */
        "amount" : 1000.00
      }],
      /** @var date Date d'arrivée en location (avec heure minimale d'arrivée) */
      "checkin" : "2019-08-13",
      /** @var date Date de départ de location (avec heure maximale de départ) */
      "checkout" : "2019-08-15",
      /** @var int Nombre d'adultes sur la réservation */
      "adults" : 1,
      /** @var int Nombre d'enfants sur la réservation */
      "children" : 5,
      /** @var int Nombre de bébés sur la réservation */
      "babies" : 1,
      /** @var int Nombre d'animaux sur la réservation */
      "pets" : 1,
      /** @var array Liste des services additionnels souscris sur la réservation */
      "additionnal_services" : [{
        /** @var string Identifiant du service additionnel */
        "id" : "15050",
        /** @var float Quantité du service */ 
        "qte" : 10,
        /** @var float Montant totl du service additionnel (PU * QTE) */
        "amount" : 150.00
      }],
      /** @var float Montant total TTC du séjour (sur la base des prestations Cloudspire, avec commission partenaire incluse)  */
      "trip_amount" : 1325.80,
      /** @var float Montant total TTC des commissions retenues par le partenaire */
      "partner_commission_amount" : 150.00,
      /** @var float Taux de TVA applicable sur les commissions retenues par le partenaire */
      "partner_tva_rate" : 20.00
    }],
  },
  "meta": {}
}

Valeurs maximales possibles pour l'attribut periods

L'attribut periods représente les nuitées facturées par la réservation. La valeur minimale supportée est donc checkin et la valeur maximale checkout - 1 jour (La nuitée de checkout n'est pas consommée lors du séjour).

Informations détaillées sur les paramètres

nature (string)

Valeur	Description
pr	Séjour professionnel
pa	Séjour particulier

Réponse du service

Le service répond avec un code HTTP 200 OK en cas de réussite du traitement. Vous trouverez ci-dessous un exemple de réponse au format JSON.

Exemple de réponse JSON

{
  "data": {
    /** @var bool Le séjour est disponible ? */
    "available" : false,
    /** @var object Montants minimum attendus pour ce séjour */
    "amounts" : {
      /** @var float Montant minimum des loyers attendus */
      "periods" : 1000,
      /** @var float Montant minimum des services additionnels attendus */
      "additionnal_services" : 125
    },
    /** @var array Liste des motifs de refus de la tarification */
    "reasons" : [
      "pricing"
    ],
    /** @var array Liste des erreurs/warnings rencontrés durant l'estimation (pour info) */
    "warnings" : [
      "La capacité maximale du bien est dépassée",
      "Option 'Ménage de fin de séjour' requise"
    ]
  },
  "meta": {},
}

Informations détaillées de la requête

trip_amount (float)

Ce champ doit représenter le montant total du séjour dû à la centrale de réservation Cloudspire pour le dossier. Ce montant doit inclure vos commissions, le montant cumulés des loyers tels que communiqués par Cloudspire, le montant des éventuels services complémentaires souscrits.

partner_commission_amount (float)

Ce champ doit représenter le montant total des commissions TTC retenues par le partenaire sur le prix de vente communiqué par la solution Cloudspire.

Informations détaillées de la réponse

reasons (array)

Ce champ représente la liste des raisons pour laquelle le séjour n'est plus disponible. Cet attribut ne possède une valeur que si la tarification a échouée (available = false), et peut contenir les valeurs suivantes :

Valeur	Explication
availability	Séjour plus disponible
pricing	Tarification incorrecte
commission	Commission partenaire trop élevée

Gestion des erreurs

Code HTTP	Raison
400	Erreur(s) de validation des données
401	Aucun jeton d'autorisation spécifié
403	Le jeton d'autorisation spécifié n'est pas habilité à réaliser cette action
500	Erreur interne de traitement des données