Skip to main content

External Reservation Retrieval

GET 
/v1/api/externalReservation/:reservationId

This API endpoint allows the retrieval of existing hotel reservations. It enables clients to access reservation details based on specific criteria provided in the request parameters.

Clients can send a GET request to this endpoint with appropriate parameters, such as reservation ID, guest name, booking reference, or date range, to retrieve the desired reservation information.

The endpoint ensures flexibility by allowing various filtering options, enabling clients to narrow down the search results based on their specific requirements.

Upon successful retrieval, the client application will receive a response containing detailed information about the requested reservation, including guest details, room information, booking status, payment details, and any additional preferences or special requests.

In case of errors or if the requested reservation is not found, the response structure is designed to provide appropriate error messages, facilitating efficient error handling and resolution.

Request​

Path Parameters

    reservationId stringrequired

Responses​

GetExternalReservationResponse()

Schema
    externalId stringrequired

    ID único da reserva do sistema interno.

    locator stringrequired

    ID que o hóspede conhece.

    hotelId stringrequired

    ID do Hotel.

    startDate stringrequired

    Dia do checkin. (ISO 8601)

    endDate stringrequired

    Dia do checkout. (ISO 8601)

    numberOfNights integerrequired

    Número de noites.

    status stringrequired

    Status da reserva [CONFIRMED ou CANCELLED].

    source stringrequired

    Origem da reserva.

    primaryGuestName stringrequired

    Nome do hóspede principal.

    primaryGuestCpf stringrequired

    CPF do hóspede principal.

    primaryGuestEmail stringrequired

    Email do hóspede principal.

    currency stringrequired

    Moeda. (código ISO 4217)

    netPrice numberrequired

    Valor sem impostos.

    taxesPrice numberrequired

    Valor dos impostos.

    adultCount integerrequired

    Número de adultos.

    childrenCount integerrequired

    Número de crianças.

    childrenAges integer[]required

    Lista com a idade das crianças.

    roomDescription stringrequired

    Nome do quarto.

    ratePlanName stringrequired

    Nome da tarifa.

    isNonRefundable booleanrequired

    Indica se a tarifa é não reembolsável.

    penaltyDate stringrequired

    Dia em que começa a penalidada caso reserva seja reembolsável. (ISO 8601)

    meal stringrequired

    Regime de alimentação.

    comissionPrice numbernullable

    Valor da comissão.

    comment stringnullable

    Comentários da reserva.

    guestJourneyStatus stringnullable

    Status da jornada do Hóspede [CHECKED_IN, CHECKED_OUT, NO_SHOW].

    primaryGuestExternalId stringnullable

    ID do seu sistema do hóspede principal.

    reservationId stringrequired
Loading...