Récupérer les saisonnalités d'une zone

Ce service web a pour objectif de vous permettre de récupérer la liste des saisonnalités d'une zone locative.

GET @api/partners/hotels/@hotel_id/rooms/@room_id/seasons
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 à partir de laquelle récupérer les disponibilités
to (date) requis : Date maximale à partir laquelle récupérer les disponibilités

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 int Identifiant unique d'une saison */
"id": 1148583,
/** @var string|null Type de saison */
"type": "low",
/** @var object Désignation de la saison */
"name": {
"fr": "Hors vacances"
},
/** @var array Liste des périodes couvertes par cette saison */
"periods": [
{
/** @var date Date de début de période (incluse) */
"from": "2020-05-13",
/** @var date Date de fin de période (incluse) */
"to": "2020-07-03"
}
],
/** @var object Configuration associée à la saison */
"settings": {
/** @var string Mode de commercialisation (voir ci-dessous) */
"selling_mode": "gi",
/** @var float Tarif de vente pour une nuit OU une personne */
"amount_one": 120,
/** @var float Tarif de vente pour deux nuits OU deux personnes */
"amount_two": 240,
/** @var float Tarif de vente pour trois nuits OU trois personnes */
"amount_three": 360.99,
/** @var float Tarif de vente pour quatre nuits OU quatre personnes */
"amount_four": 460,
/** @var float Tarif de vente pour cinq nuits OU cinq personnes */
"amount_five": 560,
/** @var float Tarif de vente pour six nuits OU six personnes */
"amount_six": 660,
/** @var float Tarif de vente pour sept nuits OU sept personnes */
"amount_seven": 750.50,
/** @var float Tarif de vente pour 14 nuits */
"amount_fourteen": 1900.50,
/** @var float Tarif de vente pour 21 nuits */
"amount_twenty_one": 2800.50,
/** @var float Tarif de vente pour 28 nuits */
"amount_twenty_eight": 4200.50,
/** @var float Tarif de majoration d'une nuitée en weekend */
"amount_weekend_increase": 0,
/** @var float Tarif de majoration d'une nuitée au delà de 7 nuitées */
"amount_extra_increase": 120,
/** @var int Délai (en heures) minimum entre la contractualisation d'une réservation, et l'entrée en location */
"min_offset": 24,
/** @var int Durée (en nuitées) minimale d'un séjour sur cette saisonnalités */
"min_stay": 2,
/** @var string Jours autorisés pour une entrée en location */
"checkin_days": "1111111",
/** @var string Jours autorisés pour une sortie en location */
"checkout_days": "1111111",
/** @var string Heure minimale d'entrée en location */
"checkin_min_time": "17:00:00",
/** @var string Heure maximale de départ de location */
"checkout_max_time": "11:00:00"
},
/** @var datetime Date de création de la saisonnalité */
"created_at": "2019-08-13T08:18:54+0200",
/** @var datetime Date de dernière mise à jour de la saisonnalité */
"updated_at": "2019-08-13T08:18:54+0200"
}
],
"meta": []
}
Dates & durée maximum de récupération des saisonnalités

Cet endpoint autorise une recherche d'une durée maximale de 540 jours de saisonnalités dans le futur, et un maximum de 1095 jours dans le passé. Les dates spécifiées sur ce service web sont représentées via des intervalles fermés (mathématiquement : [from, to])

Dates non couvertes par une saisonnalités

Toute période incluse dans une recherche (from,to), mais non couverte par une saisonnalité doit impérativement être considérée comme fermée à la vente (car non configurée).

Informations détaillées de la réponse

checkin_days & checkout_days (string)

Ces attributs représentent respectivement les jours d'entrées et les jours de départs possibles de location. Cette chaîne de caractères est composée de 7 chiffres, variants de 0 (pas disponible) à 1 (disponible).

Position du chiffreDescription
0Dimanche
1Lundi
2Mardi
3Mercredi
4Jeudi
5Vendredi
6Samedi

Ex : checkin_days = 0100001 signifie : Arrivée possible le lundi et le samedi uniquement

type (string)

Cet attribut représente le type de la saison. Cet attribut autorise les valeurs suivantes :

ValeurDescription
lowBasse saison
mediumMoyenne saison
highHaute saison

selling_mode (string)

ValeurDescription
giCommercialisation en structure (nuitée)
chCommercialisation en maison d'hôtes (nuitée/pers)
etCommercialisation à gîte d'étape (nuitée/pers)

Commercialisation en structure (gi)

Ce mode de commercialisation permet de louer la totalité de la structure, avec une stratégie de commercialisation proche de LoS (Length Of Stay). Lorsque selling_mode possède cette valeur, les attributs de la saisonnalité doivent être interprétés comme suit :

AttributInterprétation
amount_oneMontant d'un séjour d'une nuitée
amount_twoMontant d'un séjour de deux nuitées
amount_threeMontant d'un séjour de trois nuitées
amount_fourMontant d'un séjour de quatre nuitées
amount_fiveMontant d'un séjour de cinq nuitées
amount_sixMontant d'un séjour de six nuitées
amount_sevenMontant d'un séjour de sept nuitées
amount_weekend_increaseMajoration d'une nuitée en week-end
amount_extra_increaseMontant d'une nuitée facturée en supplément d'un séjour sept nuitée

Comment calculer un séjour en commercialisation [gi] ?

Commercialisation en chambre d'hôtes (ch)

Ce mode de commercialisation permet de louer la totalité d'une zone, avec une stratégie de commercialisation à la capacité. Lorsque selling_mode possède cette valeur, les attributs de la saisonnalité doivent être interprétés comme suit :

AttributInterprétation
amount_oneMontant d'une nuitée, pour une personne
amount_twoMontant d'une nuitée, pour deux personnes
amount_threeMontant d'une nuitée, pour trois personnes
amount_fourMontant d'une nuitée, pour quatre personnes
amount_fiveMontant d'une nuitée, pour cinq personnes
amount_sixMontant d'une nuitée, pour six personnes
amount_sevenMontant d'une nuitée, pour sept personnes
amount_weekend_increaseMajoration d'une nuitée en week-end
amount_extra_increaseMontant d'une personne facturée en supplément

Comment calculer un séjour en commercialisation [ch] ?

Commercialisation en gîtes d'étape (et)

Ce mode de commercialisation permet de louer partiellement une zone, avec une stratégie de commercialisation à la capacité. Lorsque selling_mode possède cette valeur, les attributs de la saisonnalité doivent être interprétés comme suit :

AttributInterprétation
amount_oneMontant d'un séjour d'une nuitée par personne
amount_twoMontant d'un séjour de deux nuitées par personne
amount_threeMontant d'un séjour de trois nuitées par personne
amount_fourMontant d'un séjour de quatre nuitées par personne
amount_fiveMontant d'un séjour de cinq nuitées par personne
amount_sixMontant d'un séjour de six nuitées par personne
amount_sevenMontant d'un séjour de sept nuitées par personne
amount_weekend_increaseMajoration d'une nuitée en week-end par personne
amount_extra_increaseMontant d'une nuitée facturée en supplément d'un séjour sept nuitée par personne

Comment calculer un séjour en commercialisation [et] ?

Gestion des erreurs

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