Skip to main content

External Reservation Retrieval

GET 
/v1/api/externalReservation/:reservationId

Endpoint to retrieve external hotel reservations from the Niara system using an external reservation ID.

Returns detailed information about the reservation, including guest details, booking status, and room information.

Request​

Path Parameters

    reservationId stringrequired

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

Responses​

GetExternalReservationResponse()

Schema
    reservationId stringrequired

    Niara's external reservation ID.

    externalId stringrequired

    Unique reservation ID from your external system.

    locator stringrequired

    Unique reservation ID from the Niara system.

    hotelId stringrequired

    Hotel ID.

    startDate stringrequired

    Check-in date (ISO 8601 format).

    endDate stringrequired

    Check-out date (ISO 8601 format).

    numberOfNights integerrequired

    Number of nights.

    status stringrequired

    Reservation status [CONFIRMED or CANCELLED].

    source stringrequired

    Reservation source.

    primaryGuestName stringrequired

    Primary guest name.

    primaryGuestCpf stringrequired

    Primary guest CPF.

    primaryGuestEmail stringrequired

    Primary guest email.

    currency stringrequired

    Currency. (ISO 4217 code)

    netPrice numberrequired

    Net price of the reservation.

    taxesPrice numberrequired

    Reservation taxes price.

    adultCount integerrequired

    Number of adults in the reservation.

    childrenCount integerrequired

    Number of children in the reservation.

    childrenAges integer[]required

    List of children's ages in the reservation.

    roomDescription stringrequired

    Reservation room name.

    ratePlanName stringrequired

    Reservation rate plan name.

    isNonRefundable booleanrequired

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

    penaltyDate stringrequired

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

    meal stringrequired

    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).

Loading...