Aller au contenu

Disponibilité par établissement / plage de dates / type d'unité

GET
/v1/availability
curl --request GET \
--url 'https://example.com/v1/availability?checkOutDate=2026-07-03&checkInDate=2026-07-01&establishmentId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
--header 'X-API-Key: <X-API-Key>'

Lecture sans lock — snapshot à l’instant T. Nuits non matérialisées = indisponible (fail-closed). Pour chaque type d’unité, retourne la dispo minimale sur la plage (goulot).

unitTypeId
string format: uuid
checkOutDate
required
string format: date
Example
2026-07-03
checkInDate
required
string format: date
Example
2026-07-01
establishmentId
required
string format: uuid

Disponibilité par type d’unité

Media type application/json
object
data
required
Array<object>
object
unitTypeId
required
string format: uuid
checkInDate
required
string format: date
checkOutDate
required
string format: date
nights
required
integer
>= 1
availableMin
required

Dispo minimale sur toutes les nuits (0 = au moins une nuit indisponible)

integer
Example generated
{
"data": [
{
"unitTypeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"checkInDate": "2026-04-15",
"checkOutDate": "2026-04-15",
"nights": 1,
"availableMin": 1
}
]
}

Paramètres invalides

Media type application/json
object
code
required

Code machine de l’erreur

string
message
required

Message lisible

string
origin

Origine domaine de l’erreur (optionnel)

object
boundedContext
string
module
string
status
required
integer
traceId
required

Identifiant de corrélation pour le support

string
Example
{
"code": "RESERVATION_NOT_FOUND",
"message": "Réservation introuvable",
"status": 404
}

Non authentifié

Media type application/json
object
code
required

Code machine de l’erreur

string
message
required

Message lisible

string
origin

Origine domaine de l’erreur (optionnel)

object
boundedContext
string
module
string
status
required
integer
traceId
required

Identifiant de corrélation pour le support

string
Example
{
"code": "RESERVATION_NOT_FOUND",
"message": "Réservation introuvable",
"status": 404
}

Permission refusée

Media type application/json
object
code
required

Code machine de l’erreur

string
message
required

Message lisible

string
origin

Origine domaine de l’erreur (optionnel)

object
boundedContext
string
module
string
status
required
integer
traceId
required

Identifiant de corrélation pour le support

string
Example
{
"code": "RESERVATION_NOT_FOUND",
"message": "Réservation introuvable",
"status": 404
}