Lister les réservations d'un établissement (liste front-desk / calendrier)

GET

/v1/reservations

curl --request GET \
  --url 'https://example.com/v1/reservations?pageSize=20&page=1&establishmentId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Query Parameters

pageSize

integer

>= 1 <= 100

Example

20

page

integer

>= 1

Example

1

search

string

<= 200 characters

Recherche sur nom booker ou n° de confirmation

segment

string

<= 100 characters

Filtre segment commercial (valeur exacte, ex : leisure, corporate, group)

channelType

string

<= 100 characters

Filtre canal de distribution (valeur exacte, ex : direct, ota, gds)

status

Array<string>

Allowed values: tentative confirmed checked_in checked_out closed cancelled no_show walked

checkOutTo

string format: date

Filtre départs : date check-out <= (YYYY-MM-DD). checkOutFrom=checkOutTo=J pour les départs du jour ; checkInTo<=J ET checkOutFrom>J pour l’in-house

checkOutFrom

string format: date

Filtre départs : date check-out >= (YYYY-MM-DD)

checkInTo

string format: date

checkInFrom

string format: date

establishmentId

required

string format: uuid

Responses

200

Page de réservations

Media type application/json

object

data

required

Array<object>

object

id

required

string format: uuid

confirmationNumber

string

nullable

status

required

string

Allowed values: tentative confirmed checked_in checked_out closed cancelled no_show walked

guestProfileId

required

string format: uuid

bookerContactName

string

checkInDate

required

string format: date

checkOutDate

required

string format: date

unitTypeId

string format: uuid

unitTypeName

Nom du type d’unité (BC inventory, résolu en composition) — null si introuvable

string

nullable

nights

Nombre de nuits (LOS)

integer

>= 1

roomCode

Code de l’unité physique pré-assignée (ADR-00D81) — null si « à placer »

string

nullable

headcountAdults

Adultes annoncés

integer

>= 1

headcountChildren

Enfants annoncés

integer

pax

Total de personnes annoncées (adultes + enfants)

integer

>= 1

folioId

Folio rattaché — null si aucun folio ouvert

string format: uuid

nullable

establishmentId

required

string format: uuid

ratePlanId

string format: uuid

balanceCents

Solde dû de la réservation en centimes (bigint string ; Σ dueBalance des folios) — null si aucun folio

string

nullable

balanceCurrency

Devise du solde — null si aucun folio

string

nullable

Allowed values: EUR GBP

totalAmountCents

Total en centimes (bigint string) — null si non figé

string

nullable

currency

string

nullable

Allowed values: EUR GBP

channelType

Canal de distribution (valeur libre : direct, ota, gds, …)

string

segment

Segment commercial (valeur libre : leisure, corporate, group, …)

string

createdAt

string format: date-time

meta

required

object

page

required

integer

>= 1

pageSize

required

integer

>= 1

total

required

integer

Example

{
  "data": [
    {
      "status": "tentative",
      "balanceCurrency": "EUR",
      "currency": "EUR"
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 20,
    "total": 42
  }
}

400

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
}

401

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
}

403

Permission refusée ou scope IDOR

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
}