Skip to main content

External Reservation Update

PATCH 
/v1/api/externalReservation/:reservationId

This API endpoint allows the update of existing hotel reservations. It enables clients to modify reservation details based on specific criteria provided in the request payload.

Clients can send a PATCH request to this endpoint with appropriate parameters, including the reservation ID to be updated and the new details to be applied, such as revised check-in/out dates, room type changes, guest information updates, or additional requests.

The endpoint ensures flexibility by allowing partial updates, enabling clients to modify only the necessary fields without having to resend the entire reservation details.

Upon successful update, the client application will receive a confirmation response containing the updated reservation details, including any changes made and the new booking status.

In case of errors or conflicts during the update process, the response structure is designed to provide detailed information on the issue encountered, facilitating efficient error handling and resolution.

Request​

Path Parameters

    reservationId stringrequired

Body

    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

    ID Niara de reserva externa.

Responses​

UpdateExternalReservationResponse()

Schema

    object

Loading...