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
    externalId stringrequired

    Unique reservation ID from the internal system.

    hotelId stringrequired

    Hotel ID

    startDate stringrequired

    Check-in day. (ISO 8601)

    endDate stringrequired

    Check-out day. (ISO 8601)

    numberOfNights integerrequired

    Number of nights.

    status stringrequired

    Reservation status [CONFIRMED or CANCELLED].

    primaryGuestName stringrequired

    Primary guest's name.

    primaryGuestCpf stringrequired

    Primary guest's CPF.

    primaryGuestEmail stringrequired

    Primary guest's email.

    currency stringrequired

    Currency. (ISO 4217 code)

    netPrice numberrequired

    Value without taxes.

    taxesPrice numberrequired

    Tax amount.

    adultCount integerrequired

    Number of adults.

    childrenCount integerrequired

    Number of children.

    childrenAges integer[]required

    List with the children's ages.

    roomDescription stringrequired

    Room name.

    ratePlanName stringrequired

    Rate plan name.

    meal stringrequired

    Meal plan.

    hotelName stringnullable

    Hotel Name

    source stringnullable

    Reservation source.

    locator stringnullable

    ID known by the guest.

    isNonRefundable booleannullable

    Indicates if the rate is non-refundable.

    penaltyDate stringnullable

    Day the penalty starts if the reservation is refundable. (ISO 8601)

    comissionPrice numbernullable

    Commission value.

    comment stringnullable

    Reservation comments.

    guestJourneyStatus stringnullable

    Guest journey status [CHECKED_IN, CHECKED_OUT, NO_SHOW, CONFIRMED or CANCELLED].

    primartGuestExternalId stringnullable

    Primary guest's ID from your system.

    primaryGuestPassport stringnullable

    Primary guest's passport number.

    primaryGuestNationality stringnullable

    Primary guest's nationality (two-letter ISO code).

    reservationId stringrequired
Loading...