Récupérer les contrats d'une zone (LOS)

Ce service web a pour objectif de vous permettre de récupérer la liste des contrats disponibles sur une zone locative. Par défaut, les contrats en vente classique et en vente de dernière minute sont intégrés dans les résultats.

Vente de dernière minute

Un tarif possède un créneau de vente possible (définie par l'intervalle [available_since, available_until]). Une vente de dernière minute possède par définition un créneau de vente assez restreint (typiquement à compter de 7 jours avant la date d'entrée en location par exemple). Un contrat ne peut être commercialisé par vos soins que si la date de réservation est comprise dans le créneau [available_since, available_until]

GET @api/partners/hotels/@hotel_id/rooms/@room_id/pricings

hotel_id (string) requis : Identifiant unique de l'hôtel à interroger

room_id (string) requis : Identifiant unique de la zone de location à interroger

from (date) requis : Date minimale à partir de laquelle récupérer les contrats (basée sur `checkin`)

to (date) requis : Date maximale de récupération des contrats

updated_since (datetime) : Ne retourner que les contrats modifiés depuis cette date

available_since (datetime) : Ne retourner que les contrats qui sont disponibles à la vente à partir de cette date

duration (int|null) : Durée des séjours à récupérer (optionnel)

capacity (int|null) : Capacité des séjours à récupérer (optionnel)

scroll_id (string|null) : identifiant de scrolling (pagination des résultats)

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 du contrat */

"id" : "9755e64b6c674b8c5062c0a24bb1aef579164408",

/** @var datetime Date d'arrivée en location (avec heure minimale d'arrivée) */

"checkin" : "2020-07-26T16:00:00.000000Z",

/** @var datetime Date de départ de location (avec heure maximale de départ) */

"checkout" : "2020-07-27T10:00:00.000000Z",

/** @var int Durée (en nuitée) du séjour */

"duration" : 1,

/** @var int Capacité (adultes+enfants) du séjour */

"capacity" : 1,

/** @var float Montant des loyers du séjour */

"periods_amount" : 90.0,

/** @var bool Le contrat est une vente de dernière minute ? */

"is_last_minute" : false,

/** @var datetime Date de mise en marché du contrat (à partir de cette date, le contrat peut être vendu) */

"available_since" : "2020-07-16T16:00:00.000000Z",

/** @var datetime Date de fin de mise en marché du contrat (après cette date, le contrat ne peut plus être vendu) */

"available_until" : "2020-07-22T16:00:00.000000Z",

/** @var datetime Date de dernière mise à jour du tarif */

"updated_at" : "2020-07-24T16:20:37.197719Z"

}

],

"meta": {

/** @var string|null Identifiant de pagination (si null, plus de résultats) */

"next_scroll_id" : "9755e64b6c674b8c5062c0a24bb1aef579164408",

}

}

Pagination des résultats

La récupération des contrats d'une zone locative implique de gros volumes de données. Sur Cloudspire, chaque requête sur cet endpoint retournera un maximum de 2500 contrats. La pagination des résultats suivants est orchestrée via l'attribut next_scroll_id et le paramètre GET scroll_id.

Gestion des erreurs

Code HTTP	Raison
400	Erreur(s) de validation des données
401	Aucun jeton de sécurité communiqué
403	Vous n'avez pas/plus accès à la structure spécifiée
404	La structure demandée n'est pas/plus disponible
500	Erreur interne de traitement des données