Création d'une réservation

Ce service web a pour objectif de vous permettre de créer une réservation sur une zone locative.

POST @api/partners/bookings
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-15",
/** @var float Montant du loyer communiqué par Cloudspire */
"amount" : 1000.00,
/** @var string|null Identifiant unique du contrat utilisé pour la vente */
"pricing_id" : "9755e64b6c674b8c5062c0a24bb1aef579164408",
}],
/** @var datetime Date d'arrivée en location (avec heure minimale d'arrivée) */
"checkin" : "2019-08-13",
/** @var datetime 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 total du service additionnel (PU * QTE) */
"amount" : 150.00
}],
/** @var object Commentaire visible par le propriétaire */
"owner_comment" : {
"fr" : "Préparer un lit bébé pour l'entrée des locataires"
},
/** @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,
/** @var string Identifiant unique de la réservation côté partenaire */
"partner_reservation_id" : "100-10881-10",
}],
/** @var array Liste des voyageurs associés à la réservation */
"guests" : [{
/** @var bool Le voyageur est le compte principal de la réservation */
"is_main" : true,
/** @var string<male|female> Sexe du voyageur */
"gender" : "male",
/** @var string|null Nom de l'organisation du voyageur */
"company_name" : "SAS John DOE Inc.",
/** @var string Prénom du voyageur */
"first_name" : "John",
/** @var string Nom de famille du voyageur */
"last_name" : "DOE",
/** @var string Numéro de téléphone du voyageur */
"phone_number" : "+33652517594",
/** @var string Adresse e-mail du voyageur */
"email_address" : "contact@cloudspire.io",
/** @var string Adresse de résidence */
"address1" : "15 Rue des chanterelles",
/** @var string Complément d'adresse */
"address2" : null,
/** @var string Code postal */
"zipcode" : "88000",
/** @var string Ville de résidence */
"city" : "EPINAL",
/** @var string Pays de résidence */
"country" : "FRANCE"
}],
/** @var datetime Date de création de la réservation */
"created_at" : "2019-08-13T08:18:54+0200"
},
"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).

Réservation multiple

L'API actuelle ne supporte pas la réservation de multiples structures au sein d'un même contrat. L'évolution est prévue sur l'outil, c'est pour cette raison que l'enveloppe reservations est implémentée au sein du message.

Informations détaillées sur les paramètres

nature (string)

ValeurDescription
prSéjour professionnel
paSéjour particulier

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.

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 string Identifiant unique de la réservation sur Cloudspire */
"reservations" : [{
/** @var string Identifiant de la réservation sur Cloudspire */
"reservation_id" : "R200011909",
/** @var string Identifiant de la réservation sur la plate-forme partenaire */
"partner_reservation_id" : "100-10881-10"
}]
},
"meta": {},
}

Gestion des erreurs

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