Skip to main content

External Reservation Update

PATCH 
/v1/api/externalReservation/:reservationId

Endpoint to update external hotel reservations in the Niara system using an external reservation ID.

Request​

Path Parameters

    reservationId stringrequired

    Niara's external reservation ID (reservationId returned on CreateExternalReservation).

Body

    hotelId stringnullable

    Hotel ID.

    startDate stringnullable

    Check-in date (ISO 8601 format).

    endDate stringnullable

    Check-out date (ISO 8601 format).

    numberOfNights integernullable

    Number of nights.

    status stringnullable

    Reservation status [CONFIRMED or CANCELLED].

    source stringnullable

    Reservation source.

    primaryGuestName stringnullable

    Primary guest name.

    primaryGuestCpf stringnullable

    Primary guest CPF.

    primaryGuestEmail stringnullable

    Primary guest email.

    currency stringnullable

    Currency. (ISO 4217 code)

    netPrice numbernullable

    Net price of the reservation.

    taxesPrice numbernullable

    Reservation taxes price.

    adultCount integernullable

    Number of adults in the reservation.

    childrenCount integernullable

    Number of children in the reservation.

    childrenAges integer[]nullable

    List of children's ages in the reservation.

    roomDescription stringnullable

    Reservation room name.

    ratePlanName stringnullable

    Reservation rate plan name.

    isNonRefundable booleannullable

    Indicates if the reservation is non-refundable, true if the reservation is non-refundable.

    penaltyDate stringnullable

    Date on which the cancellation penalty applies, if the reservation is refundable. (ISO 8601)

    meal stringnullable

    Meal plan.

    comissionPrice numbernullable

    Comission price.

    comment stringnullable

    Reservation comments.

    guestJourneyStatus stringnullable

    Guest Journey Status [CHECKED_IN, CHECKED_OUT, NO_SHOW].

    primaryGuestExternalId stringnullable

    Your system's external ID for the primary guest.

    primaryGuestPassport stringnullable

    Primary guest passport number.

    primaryGuestNationality stringnullable

    Nationality of the primary guest (ISO 3166-1 alpha-2 country code).

Responses​

UpdateExternalReservationResponse()

Schema

    object

Loading...